Queries the information of an instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | GetInstance |
The operation that you want to perform. Set the value to GetInstance. |
InstanceId | String | Yes | cri-xkx6vujuhay0tasd |
The ID of the instance. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where the instance resides. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
IsSuccess | Boolean | true |
Indicates whether the operation is successful. |
Code | String | success |
The code returned for the request. |
RequestId | String | 6EF34B18-4228-470C-860C-D28597CF010E |
The ID of the request. |
InstanceName | String | shanghai-instance1 |
The name of the instance. |
InstanceSpecification | String | Enterprise_Basic |
The specification of the instance. |
InstanceStatus | String | RUNNING |
The status of the instance. |
CreateTime | Long | 1571926439000 |
The time when the instance was created. |
ModifiedTime | Long | 1571926560000 |
The time when the instance was modified. |
InstanceId | String | cri-xkx6vujuhay0tasd |
The ID of the instance. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=GetInstance
&InstanceId=cri-xkx6vujuhay0tasd
&RegionId=cn-shanghai
&<Common request parameters>
Sample success responses
JSON
format
{
"InstanceName":"shanghai-instance1",
"IsSuccess":true,
"RequestId":"6EF34B18-4228-470C-860C-D28597CF010E",
"ModifiedTime":1571926560000,
"InstanceSpecification":"Enterprise_Basic",
"InstanceId":"cri-xkx6vujuhay0tasd",
"InstanceStatus":"RUNNING",
"CreateTime":1571926439000,
"Code":"success"
}
XML
format
<InstanceName>shanghai-instance1</InstanceName>
<IsSuccess>true</IsSuccess>
<RequestId>6EF34B18-4228-470C-860C-D28597CF010E</RequestId>
<ModifiedTime>1571926560000</ModifiedTime>
<InstanceSpecification>Enterprise_Basic</InstanceSpecification>
<InstanceId>cri-xkx6vujuhay0tasd</InstanceId>
<InstanceStatus>RUNNING</InstanceStatus>
<CreateTime>1571926439000</CreateTime>
<Code>success</Code>
Error codes
For a list of error codes, visit the API Error Center.