DescribeInstance - - Alibaba Cloud Documentation Center

Queries the details about an instance based on the instance ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /v2/openapi/instances/{instanceId}

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	airec-cn-xxxxx

Response parameters

Parameter	Type	Description	Example
	object
result	object	The returned results.
regionId	string	The ID of the region where the instance resides.	cn-beijing
type	string	The type of the instance. Only the Standard edition is supported.	Standard
lockMode	string	The lock mode of the instance. Valid values: Unlock, ManualLock, and LockByExpiration.	Unlock
expiredTime	string	The time when the instance expires. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2019-01-06T16:00:00.000Z
scene	string	The name of the scene. Valid values: gul, rr, hot, and focus.	gul
status	string	The state of the instance. Valid values: Initializing, Ready, and Running.	Running
gmtCreate	string	The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2018-12-06T06:14:01.000Z
chargeType	string	The billing method. Valid values: PrePaid and PostPaid. Only the PrePaid billing method is supported.	PrePaid
industry	string	The type of the industry. Valid values: content, item, news, video, and sns.	news
commodityCode	string	The commodity code of the recommended item.	airecpre
gmtModified	string	The time when the instance was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2018-12-06T11:17:49.000Z
dataSetVersion	string	The version of the dataset that provides online services.	20181206170353
name	string	The name of the instance.	Test instance
instanceId	string	The instance ID.	airec-cn-o400whm78004
code	string	The error code.	InternalServerError
requestId	string	The request ID.	8F81A922-6C81-46D6-B78C-CC35E16B1691
message	string	The error message.	An internal server error occurred

Examples

Sample success responses

JSONformat

{
  "result": {
    "regionId": "cn-beijing",
    "type": "Standard",
    "lockMode": "Unlock",
    "expiredTime": "2019-01-06T16:00:00.000Z",
    "scene": "gul",
    "status": "Running",
    "gmtCreate": "2018-12-06T06:14:01.000Z",
    "chargeType": "PrePaid",
    "industry": "news",
    "commodityCode": "airecpre",
    "gmtModified": "2018-12-06T11:17:49.000Z",
    "dataSetVersion": "20181206170353",
    "name": "Test instance\n",
    "instanceId": "airec-cn-o400whm78004"
  },
  "code": "InternalServerError",
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "message": "An internal server error occurred"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history