All Products
Search
Document Center

DescribeInstance

Last Updated: Mar 29, 2021

Description

Queries the details of an instance based on a specified instance ID.

Method

GET

URI

/openapi/instances/{instanceId}

Response parameters

Parameter

Type

Description

RequestId

String

The ID of the request.

Result

Instance

Details about the instance.

Examples

Sample requests

GET /openapi/instances/airec-cn-xxxxxx

Sample success responses

JSON format

{
  "Result": {
    "InstanceId": "airec-cn-xxxxxx",
    "Name": "airec-cn-xxxxxx",
    "Type": "Standard",
    "Status": "Running",
    "Industry": "news",
    "Scene": "gul",
    "RegionId": "cn-beijing",
    "ChargeType": "PrePaid",
    "DataSetVersion": "20181206170353",
    "CommodityCode": "airecpre",
    "GmtCreate": "2018-12-06T06:14:01.000Z",
    "GmtModified": "2018-12-06T11:17:49.000Z",
    "ExpiredTime": "2019-01-06T16:00:00.000Z",
    "LockMode": "Unlock"
  },
  "RequestId": "B352FBD9-4643-441E-80ED-699D47D7B6A3"
}

Sample error responses

JSON format

{
   "RequestId":"DF79FBBF-FFD9-42CD-A91E-220C97D13189",
   "Code":"InstanceNotExist",
   "Message":"The specified instance does not exist."
}