All Products
Search
Document Center

Edge Security Acceleration:DescribeRatePlanInstanceStatus

Last Updated:Nov 15, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries the status of an instance that uses a plan.

Operation description

You can query the status of an instance after you purchase a plan for the instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
esa:DescribeRatePlanInstanceStatuscreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringNo

The instance ID, which can be obtained by calling the ListUserRatePlanInstances operation.

xcdn-91fknmb80f0g***

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The request ID.

60423A7F-A83D-1E24-B80E-86DD25790759
InstanceIdstring

The instance ID.

xcdn-91fknmb80f0g***
InstanceStatusstring

The instance status. Valid values:

  • running: The instance is running.
  • renewing: The instance is being renewed.
  • upgrading: The configuration of the instance is being upgraded.
  • releasePrepaidService: The instance is released due to expiration.
  • creating: The instance is being created.
  • downgrading: The configuration of the instance is being downgraded.
  • ceasePrepaidService: The instance has expired.
running

Examples

Sample success responses

JSONformat

{
  "RequestId": "60423A7F-A83D-1E24-B80E-86DD25790759",
  "InstanceId": "xcdn-91fknmb80f0g***\n",
  "InstanceStatus": "running"
}

Error codes

HTTP status codeError codeError messageDescription
400InternalErrorAn internal exception occurred, please try again later.An inner exception was triggered. Please try again later.
400InvalidInstanceThe instance ID is missing or invalid. Make sure that the instance ID is valid and try again.The instance ID is missing or invalid. Make sure that the instance ID is valid and try again.

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