Queries details about an instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

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-xkx6vujuhay0****

The ID of the instance.

RegionId String Yes cn-shanghai

The region ID of the instance.

Response parameters

Parameter Type Example Description
Code String success

The return value.

CreateTime Long 1571926439000

The time when the instance was created.

InstanceId String cri-xkx6vujuhay0****

The ID of the instance.

InstanceName String shanghai-instance1

The name of the instance.

InstanceSpecification String Enterprise_Basic

The edition of the instance.

InstanceStatus String RUNNING

The status of the instance.

IsSuccess Boolean true

Indicates whether the operation is successful.

ModifiedTime Long 1571926560000

The time when the instance was modified.

RequestId String 6EF34B18-4228-470C-860C-D28597CF010E

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetInstance
&InstanceId=cri-xkx6vujuhay0****
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<InstanceName>shanghai-instance1</InstanceName>
<IsSuccess>true</IsSuccess>
<ModifiedTime>1571926560000</ModifiedTime>
<RequestId>6EF34B18-4228-470C-860C-D28597CF010E</RequestId>
<InstanceId>cri-xkx6vujuhay0****</InstanceId>
<InstanceSpecification>Enterprise_Basic</InstanceSpecification>
<InstanceStatus>RUNNING</InstanceStatus>
<CreateTime>1571926439000</CreateTime>
<Code>success</Code>

JSON format

{
    "InstanceName": "shanghai-instance1",
    "IsSuccess": true,
    "ModifiedTime": 1571926560000,
    "RequestId": "6EF34B18-4228-470C-860C-D28597CF010E",
    "InstanceId": "cri-xkx6vujuhay0****",
    "InstanceSpecification": "Enterprise_Basic",
    "InstanceStatus": "RUNNING",
    "CreateTime": 1571926439000,
    "Code": "success"
}

Error codes

For a list of error codes, visit the API Error Center.