NSX-T Data Center REST API
InstanceRuntime (schema)
Runtime of a Service-Instance.
A Service Runtime is the runtime entity associated with ever Service-VM deployed.
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
string | Readonly |
| _revision | Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| compute_collection_id | Compute Collection Id Resource Pool or cluster Id. |
string | Readonly |
| deployment_status | Instance Runtime deployment status Service-Instance Runtime deployment status of the Service-VM. It shows the latest status during the process of deployment, redeploy, upgrade, and un-deployment of VM. |
string | Readonly Enum: DEPLOYMENT_IN_PROGRESS, DEPLOYMENT_FAILED, DEPLOYMENT_SUCCESSFUL, UPGRADE_IN_PROGRESS, UPGRADE_FAILED, UNDEPLOYMENT_IN_PROGRESS, UNDEPLOYMENT_FAILED, UNDEPLOYMENT_SUCCESSFUL, UNKNOWN |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| error_message | Error Message Error message for the Service Instance Runtime if any. |
string | Readonly |
| id | Unique identifier of this resource | string | Sortable |
| maintenance_mode | Instance Runtime maintenance mode The maintenance mode indicates whether the corresponding service VM is in maintenance mode. The service VM will not be used to service new requests if it is in maintenance mode. |
string | Readonly Enum: OFF, ENTERING, ON, EXITING |
| resource_type | Must be set to the value InstanceRuntime | string | |
| runtime_health_status_by_partner | Instance runtime health status set by partner Service-Instance runtime health status set by partner to indicate whether the service is running properly or not. |
string | Readonly Enum: HEALTHY, STOPPED, NOT_RESPONDING |
| runtime_status | Instance Runtime Status Service-Instance Runtime status of the deployed Service-VM. |
string | Readonly Enum: IN_SERVICE, OUT_OF_SERVICE, NEEDS_ATTENTION, NOT_AVAILABLE |
| service_instance_id | Service instance id Id of an instantiation of a registered service. |
string | Readonly |
| service_vm_id | Service VM id Service-VM/SVM id of deployed virtual-machine. |
string | Readonly |
| storage_id | Storage Id Moref of the datastore in VC. |
string | Readonly |
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| unhealthy_reason | Reason for service status when unhealthy Reason provided by partner for the service being unhealthy. This could be due to various reasons such as connectivity lost as an example. |
string | Readonly |
| vm_nic_info | VM NIC info | VmNicInfo | Readonly |