Queries the details of elasticity assurances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeElasticityAssurances

The operation that you want to perform. Set the value to DescribeElasticityAssurances.

RegionId String Yes cn-hangzhou

The region ID of the elasticity assurance. You can call the DescribeRegions operation to query the most recent region list.

Tag.N.Key String No TestKey

The key of tag N of the elasticity assurance. You can specify multiple tag keys to query. Valid values of N: 1 to 20.

If a single tag is specified to query resources, up to 1,000 resources that have this tag added can be displayed in the response. If multiple tags are specified to query resources, up to 1,000 resources that have all these tags added can be displayed in the response. To query more than 1,000 resources that have specified tags added, call the ListTagResources operation.

Tag.N.Value String No TestValue

The value of tag N of the elasticity assurance. You can specify multiple tag keys to query. Valid values of N: 1 to 20.

ResourceGroupId String No rg-bp67acfmxazb4p****

The ID of the resource group to which the elasticity assurance belongs.

MaxResults Integer No 10

The maximum number of entries to return on each page.

Maximum value: 100.

Default value: 10.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query. The NextToken value is obtained from the response to the previous request.

PrivatePoolOptions.Ids String No ["eap-bp67acfmxazb4****", "eap-bp67acfmxazb5****"]

The IDs of the elasticity assurances. The value can be a JSON array that consists of up to 100 IDs. Separate multiple IDs with commas (,).

InstanceType String No ecs.c6.large

The instance type to which the elasticity assurance applies.

ZoneId String No cn-hangzhou-h

The zone ID of the elasticity assurance.

InstanceChargeType String No PostPaid

The billing method of instances to be created by using the elasticity assurance. Set the value to PostPaid. Only pay-as-you-go instances can be created by using elasticity assurances.

Default value: PostPaid.

Status String No Active

The state of the elasticity assurance. Valid values:

  • Preparing
  • Active
  • Released

Default value: Active.

Response parameters

Parameter Type Example Description
ElasticityAssuranceSet Array of ElasticityAssuranceItem

Details about the elasticity assurances.

ElasticityAssuranceItem
AllocatedResources Array of AllocatedResource

Details about the allocated resources.

AllocatedResource
InstanceType String ecs.c6.large

The instance type to which the elasticity assurance applies.

TotalAmount Integer 2

The total number of instances reserved for a single instance type.

UsedAmount Integer 2

The number of instances that have been created by using the elasticity assurance.

zoneId String cn-hangzhou-h

The zone ID of the elasticity assurance.

Description String This is description.

The description of the elasticity assurance.

EndTime String 2021-12-03T16:00Z

The time when the elasticity assurance expires.

LatestStartTime String 0
Note This parameter is unavailable.
PrivatePoolOptionsId String eap-bp67acfmxazb4****

The ID of the elasticity assurance.

PrivatePoolOptionsMatchCriteria String Open

The match mode of the private pool associated with the elasticity assurance. Valid values:

  • Open: open private pool
  • Target: specified private pool
PrivatePoolOptionsName String eapTestName

The name of the elasticity assurance.

RegionId String cn-hangzhou

The region ID of the elasticity assurance.

ResourceGroupId String rg-bp67acfmxazb4p****

The ID of the resource group to which the elasticity assurance belongs.

StartTime String 2020-12-03T05:25Z

The time when the elasticity assurance takes effect.

Status String Active

The state of the elasticity assurance. Valid values:

  • Preparing
  • Active
  • Released
Tags Array of Tag

The tags of the elasticity assurance.

Tag
TagKey String TestKey

The tag key of the elasticity assurance.

TagValue String TestValue

The tag value of the elasticity assurance.

TotalAssuranceTimes String Unlimited

The total number of times that the elasticity assurance has been applied.

UsedAssuranceTimes Integer 0
Note This parameter is unavailable.
MaxResults Integer 10

The number of entries returned per page.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token used to start the next query.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

TotalCount Integer 1

The total number of entries returned.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeElasticityAssurances
&RegionId=cn-hangzhou
&PrivatePoolOptions.Ids=["eap-bp67acfmxazb4****", "eap-bp67acfmxazb5****"]
&InstanceType=ecs.c6.large
&<Common request parameters>

Sample success responses

XML format

<DescribeElasticityAssurancesResponse>
      <ElasticityAssuranceSet>
            <ElasticityAssuranceItem>
                  <Status>Active</Status>
                  <UsedAssuranceTimes>0</UsedAssuranceTimes>
                  <Description>This is description.</Description>
                  <EndTime>2021-12-03T16:00Z</EndTime>
                  <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
                  <PrivatePoolOptionsName>eapTestName</PrivatePoolOptionsName>
                  <LatestStartTime></LatestStartTime>
                  <StartTime>2020-12-03T05:25Z</StartTime>
                  <PrivatePoolOptionsMatchCriteria>Open</PrivatePoolOptionsMatchCriteria>
                  <AllocatedResources>
                        <AllocatedResource>
                              <UsedAmount>2</UsedAmount>
                              <zoneId>cn-hangzhou-h</zoneId>
                              <TotalAmount>2</TotalAmount>
                              <InstanceType>ecs.c6.large</InstanceType>
                        </AllocatedResource>
                  </AllocatedResources>
                  <PrivatePoolOptionsId>eap-bp67acfmxazb4****</PrivatePoolOptionsId>
                  <TotalAssuranceTimes>Unlimited</TotalAssuranceTimes>
                  <RegionId>cn-hangzhou</RegionId>
                  <Tags>
                        <Tag>
                              <TagKey>TestKey</TagKey>
                              <TagValue>TestValue</TagValue>
                        </Tag>
                  </Tags>
            </ElasticityAssuranceItem>
      </ElasticityAssuranceSet>
      <TotalCount>1</TotalCount>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
      <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
      <MaxResults>10</MaxResults>
</DescribeElasticityAssurancesResponse>

JSON format

{
    "ElasticityAssuranceSet": {
        "ElasticityAssuranceItem": [
            {
                "Status": "Active",
                "UsedAssuranceTimes": 0,
                "Description": "This is description.",
                "EndTime": "2021-12-03T16:00Z",
                "ResourceGroupId": "rg-bp67acfmxazb4p****",
                "PrivatePoolOptionsName": "eapTestName",
                "LatestStartTime": "",
                "StartTime": "2020-12-03T05:25Z",
                "PrivatePoolOptionsMatchCriteria": "Open",
                "AllocatedResources": {
                    "AllocatedResource": [
                        {
                            "UsedAmount": 2,
                            "zoneId": "cn-hangzhou-h",
                            "TotalAmount": 2,
                            "InstanceType": "ecs.c6.large"
                        }
                    ]
                },
                "PrivatePoolOptionsId": "eap-bp67acfmxazb4****",
                "TotalAssuranceTimes": "Unlimited",
                "RegionId": "cn-hangzhou",
                "Tags": {
                    "Tag": [
                        {
                            "TagKey": "TestKey",
                            "TagValue": "TestValue"
                        }
                    ]
                }
            }
        ]
    },
    "TotalCount": 1,
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
    "MaxResults": 10
}

Error codes

HTTP status code Error code Error message Description
400 MissingParameter.RegionId The specified RegionId should not be null. The error message returned because the required RegionId parameter is not specified.
500 InternalError The request processing has failed due to some unknown error, exception or failure. The error message returned because an internal error has occurred. Try again later. If the error persists, submit a ticket.

For a list of error codes, visit the API Error Center.