DescribeInstanceTypeStatus

1. API Description

The API is used to query model status after instance specification change.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
instanceId	Yes	String	ID of the instance to be modified. To obtain the instance ID, you can call DescribeInstances and look for instanceId in the response.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
instanceId	String	Instance ID.
instanceName	String	Instance name.
instanceType	String	Current model of the instance.
modifiedInstanceType	String	Target model of the instance. If the value is empty, no scheduling specification change exists.
modifiedInstanceTypeStatus	String	Model status of the instance. Processing: the model is changing. Enable: the model is available. WaitToEnable: the model is available in the next billing cycle.

4. Code Example

Example

Query the model status after instance specification change.

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeInstanceTypeStatus
<Common Request Params>

Request：
{
  "instanceId": "instanceId"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {  
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "instanceId": "xx",
    "instanceName": "xx",
    "instanceType": "c.1c2g",
    "modifiedInstanceType": "c.2c4g",
    "modifiedInstanceTypeStatus": "Enable"
   }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code	Error Code	Description
404	INVALID_INSTANCE_NOT_FOUND	Instance does not exist.