DescribeReservedInstances - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries purchased reserved instances.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ecs:DescribeReservedInstances	get	ReservedInstance `acs:ecs:{#regionId}:{#accountId}:reservedinstance/` *ReservedInstance `acs:ecs:{#regionId}:{#accountId}:reservedinstance/{#reservedinstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instances. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	50
Tag	array<object>	No	The tags to add to the instances.
	object	No	The tags to add to the instances.
Key	string	No	The key of tag N to add to the reserved instance. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun. Up to 1,000 resources with the specified tags can be returned in the response. To query more than 1,000 resources with the specified tags, call the ListTagResources operation.	TestKey
Value	string	No	The value of tag N to add to the reserved instance. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain http:// or https://. The tag value cannot start with acs:.	TestValue
ZoneId	string	No	The zone ID of the reserved instances. This parameter is required when Scope is set to Zone. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-z
ReservedInstanceName	string	No	The name of the reserved instance.	testReservedInstanceName
LockReason	string	No	The reason why the instance is locked. Valid values: financial: You have an overdue payment in your account, or the reserved instance has expired. security: The reserved instance is locked for security reasons.	security
InstanceType	string	No	The instance type. For more information, see Instance families.	ecs.g5.large
InstanceTypeFamily	string	No	The instance family. For more information, see Instance families.	ecs.g5
Scope	string	No	The scope of the reserved instances. Valid values: Region Zone Default value: Region.	Region
OfferingType	string	No	The payment option of the reserved instances. Valid values: No Upfront Partial Upfront All Upfront	All Upfront
AllocationType	string	No	The allocation type. Valid values: Normal: queries all reserved instances that belong to the current account. Shared: queries reserved instances that are shared between the main account and linked accounts. Default value: Normal.	Normal
ReservedInstanceId	array	No	The ID of reserved instance N. Valid values of N: 1 to 100.
	string	No	The ID of reserved instance N. Valid values of N: 1 to 100.	ri-bpzhex2ulpzf53****
Status	array	No	The status of reserved instance N. Valid values of N: 1 to 100. Valid values: Creating Active Expired Updating
	string	No	The status of reserved instance N. Valid values of N: 1 to 100. Valid values: Creating Active Expired Updating	Active

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	1
RequestId	string	The request ID.	E572643C-6A29-49D6-9D4E-6CFA4E063A3E
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of reserved instances.	1
ReservedInstances	array<object>	Details about the reserved instances.
ReservedInstance	object
Status	string	The status.	Active
CreationTime	string	The creation time.	2018-12-10T12:07Z
ReservedInstanceName	string	The name.	riZbpzhex2ulpzf53****
ReservedInstanceId	string	The reserved instance ID.	ri-bpzhex2ulpzf53****
InstanceType	string	The instance type of the pay-as-you-go instances that can be matched to the reserved instance.	ecs.g5.large
InstanceAmount	integer	The number of pay-as-you-go instances that are of the same instance type as the reserved instance and can be matched to the reserved instance.	10
RegionId	string	The region ID.	cn-hangzhou
OfferingType	string	The payment option.	All Upfront
StartTime	string	The effective time.	2018-12-10T12:00Z
Description	string	The description.	testDescription
AllocationStatus	string	Indicates the sharing status of the reserved instance when the AllocationType parameter is set to Shared. Valid values: allocated: The reserved instance is allocated to another account. beAllocated: The reserved instance is allocated by another account.	allocated
ExpiredTime	string	The expiration time.	2019-12-10T12:07Z
ResourceGroupId	string	The resource group ID.	EcsDocTest
ZoneId	string	The zone ID.	cn-hangzhou-z
Platform	string	The operating system of the image used by the instance. Valid values: Windows Linux	Linux
Scope	string	The scope.	region
OperationLocks	array<object>	Details about the lock status of the reserved instance.
OperationLock	object
LockReason	string	The reason why the instance is locked.	security
Tags	array<object>	Details about the tags of the reserved instance.
Tag	object
TagValue	string	The tag value.	TestValue
TagKey	string	The tag key.	TestKey

Examples

Sample success responses

JSONformat

{
  "PageSize": 1,
  "RequestId": "E572643C-6A29-49D6-9D4E-6CFA4E063A3E",
  "PageNumber": 1,
  "TotalCount": 1,
  "ReservedInstances": {
    "ReservedInstance": [
      {
        "Status": "Active",
        "CreationTime": "2018-12-10T12:07Z",
        "ReservedInstanceName": "riZbpzhex2ulpzf53****",
        "ReservedInstanceId": "ri-bpzhex2ulpzf53****",
        "InstanceType": "ecs.g5.large",
        "InstanceAmount": 10,
        "RegionId": "cn-hangzhou",
        "OfferingType": "All Upfront",
        "StartTime": "2018-12-10T12:00Z",
        "Description": "testDescription",
        "AllocationStatus": "allocated",
        "ExpiredTime": "2019-12-10T12:07Z",
        "ResourceGroupId": "EcsDocTest",
        "ZoneId": "cn-hangzhou-z",
        "Platform": "Linux",
        "Scope": "region",
        "OperationLocks": {
          "OperationLock": [
            {
              "LockReason": "security"
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParamter.RegionId	The regionId should not be null.	The RegionId parameter is required.
400	InvalidRegion.NotFound	The specified parameter RegionId is not valid.	The specified RegionId parameter is invalid.
400	InvalidZone.NotFound	The specified parameter ZoneId is not valid.	The specified ZoneId parameter is invalid.
400	InvalidReservedInstanceOfferingType.ValueNotSupported	the OfferingType is not supported	-
400	InvalidReservedInstanceOfferingClass.ValueNotSupported	the OfferingClass is not supported	-
400	OperationDenied	The specified InstanceType or Zone is not authorized for current user.	-
400	InvalidEndTime.ValueNotSupported	The specified endTime is out of the permitted range.	The specified end time is invalid.
400	InvalidReservedInstanceLockReason.ValueNotSupported	The specified LockReason is not supported.	-
400	InvalidReservedInstanceStatus.ValueNotSupported	The specified Status is not supported.	-
400	InvalidAllocationType.ValueNotSupported	The specified AllocationType is not supported.	The specified AllocationType parameter is invalid.
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The specified RegionId parameter does not exist. Check whether the service is available in the specified region.

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

Change history

Change time	Summary of changes	Operation

No change history