All Products
Search
Document Center

ENS:DescribeInstanceAutoRenewAttribute

Last Updated:Jul 26, 2024

You can call this operation to query whether auto-renewal is enabled for an instance.

Debugging

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

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:
    • The required resource types are displayed in bold characters.
    • 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
ens:DescribeInstanceAutoRenewAttributeget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdsstringYes

The ID of an instance. Separate multiple IDs with semicolons (;).

i-5ci7l7k1m9m2zmhp4iw3o****

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The returned service code. A value of 0 indicates that the operation was successful.

0
InstanceRenewAttributesarray<object>

The renewal status of the instance.

object
AutoRenewalboolean

The renewal type of the instance.

  • true: enables auto-renewal.
  • false: disables auto-renewal.
false
Durationstring

The unit of the auto-renewal period.

0
InstanceIdstring

The ID of the instance.

i-5ci7l7k1m9m2zmhp4iw3o****
RequestIdstring

The request ID.

4DD66F05-3116-4BAA-B588-52EB2E7F431D

Examples

Sample success responses

JSONformat

{
  "Code": 0,
  "InstanceRenewAttributes": {
    "InstanceRenewAttribute": [
      {
        "AutoRenewal": false,
        "Duration": "0",
        "InstanceId": "i-5ci7l7k1m9m2zmhp4iw3o****"
      }
    ]
  },
  "RequestId": "4DD66F05-3116-4BAA-B588-52EB2E7F431D"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameters that is mandatory for processing this request is not supplied.-
400InstanceNotExistsThe user have no instances.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

Change history

Change timeSummary of changesOperation
2023-12-21API Description Update. The Error code has changed. The request parameters of the API has changedView Change Details