DescribeReservedInstanceAutoRenewAttribute

更新时间:
复制 MD 格式

Queries the auto-renewal attributes of one or more reserved instances, including the auto-renewal duration and auto-renewal status.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeReservedInstanceAutoRenewAttribute

get

*ReservedInstance

acs:ecs:{#regionId}:{#accountId}:reservedinstance/{#ReservedInstanceId}

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID of the reserved instance.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

ReservedInstanceId

array

No

The IDs of reserved instances.

string

No

The ID of the reserved instance. You can call the DescribeReservedInstances operation to query the IDs of reserved instances that you purchased.

You can specify the IDs of up to 100 reserved instances in a single request.

ecsri-ajdfaj****

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

04F0F334-1335-436C-A1D7-6C044FE7****

ReservedInstanceRenewAttributes

object

ReservedInstanceRenewAttribute

array<object>

Details about the auto-renewal settings of the reserved instances.

object

PeriodUnit

string

The unit of the auto-renewal duration.

Valid values: Year and Month.

Month

Duration

integer

The auto-renewal duration.

1

ReservedInstanceId

string

The ID of the reserved instance.

ecsri-ajdfaj****

RenewalStatus

string

The auto-renewal status of the reserved instance. Valid values:

  • AutoRenewal: automatically renews the reserved instance.

  • Normal: manually renews the reserved instances.

AutoRenewal

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "ReservedInstanceRenewAttributes": {
    "ReservedInstanceRenewAttribute": [
      {
        "PeriodUnit": "Month",
        "Duration": 1,
        "ReservedInstanceId": "ecsri-ajdfaj****",
        "RenewalStatus": "AutoRenewal"
      }
    ]
  }
}

Error codes

HTTP status code

Error code

Error message

Description

403 ChargeTypeViolation Pay-As-You-Go dedicated host do not support this operation.
403 MissingParamter.InstanceId ReservedInstanceId should not be null.
403 InvalidParameter.ToManyInstanceIds ReservedInstanceId should be less than 100.
403 InValidParameter Parameter invalid.%s
403 ResourceStatusViolation The operation is not permitted due to resource status of the instance.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.