AI 助理
备案控制台
文档
输入文档关键字查找
首页 云服务器 ECS 开发参考 API参考（ECS） API目录 资源保障 DescribeElasticityAssurances - 查询弹性保障服务的信息

DescribeElasticityAssurances - 查询弹性保障服务的信息

更新时间：
产品详情
我的收藏

查询弹性保障服务的详细信息。例如弹性保障服务的状态、匹配模式、生效方式、失效时间、已使用的实例的数量等。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeElasticityAssurancesget
*ElasticityAssurance
acs:ecs:{#regionId}:{#accountId}:elasticityassurance/*
    无
无

请求参数

名称类型必填描述示例值
RegionIdstring是

弹性保障服务所属地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ResourceGroupIdstring否

资源组 ID。使用该参数过滤资源时，资源数量不能超过 1000 个。

说明 不支持默认资源组过滤。
rg-bp67acfmxazb4p****
Tagarray<object>否

弹性保障服务绑定的标签键值对列表。

object否

标签对信息。

Keystring否

标签键。N 表示可以设置多个标签键进行过滤，N 的取值范围为 1~20。

使用一个标签过滤资源，查询到该标签下的资源数量不能超过 1000 个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个，请使用 ListTagResources 接口进行查询。

TestKey
Valuestring否

标签值。N 表示可以设置多个标签键进行过滤，N 的取值范围为 1~20。

TestValue
MaxResultsinteger否

分页查询时每页行数。

最大值：100。

默认值：10。

10
NextTokenstring否

弹性保障服务查询起始标志。由上一次的请求结果中获取。

caeba0bbb2be03f84eb48b699f0a4883
PrivatePoolOptions.Idsstring否

弹性保障服务 ID 列表。取值可以由多个 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。

["eap-bp67acfmxazb4****", "eap-bp67acfmxazb5****"]
Platformstring否
说明 该参数已废弃。
null
InstanceTypestring否

实例规格。通过实例规格只可以查询还在生效中的弹性保障服务，已释放的服务只能通过PrivatePoolOptions.Ids查询。

ecs.c6.large
ZoneIdstring否

弹性保障服务所属地域下的可用区 ID。

cn-hangzhou-h
InstanceChargeTypestring否

实例的计费方式。取值：PostPaid，目前仅支持按量付费。

默认值：PostPaid。

PostPaid
Statusstring否

弹性保障服务的状态。取值范围：

  • All：所有状态。
  • Deactived：待激活（该状态白名单邀测中）。
  • Preparing：准备中。
  • Prepared：待生效。
  • Active：生效中。
  • Released：已释放。

若不指定，则查询除 Pending、Released 以外状态的弹性保障。

Active

返回参数

名称类型描述示例值
object
NextTokenstring

弹性保障服务下一个查询起始标志。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

符合查询条件的记录条数。

1
MaxResultsinteger

弹性保障服务每页显示行数。

10
ElasticityAssuranceSetarray<object>

弹性保障服务详细信息组成的集合。

ElasticityAssuranceItemobject

弹性保障服务详细信息组成的集合。

Statusstring

弹性保障服务的状态。可能值：

  • Preparing：准备中。
  • Prepared：待生效。
  • Active：生效中。
  • Released：已释放。
Active
PrivatePoolOptionsMatchCriteriastring

弹性保障服务的匹配模式。可能值：

  • Open：开放模式的弹性保障服务。启动实例时将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量，则使用公共池资源启动。
  • Target：指定模式的弹性保障服务。使用指定的私有池容量启动实例，如果该私有池容量不可用，则实例会启动失败。
Target
PrivatePoolOptionsIdstring

弹性保障服务 ID。

eap-bp1ir35kqtn8ywci****
UsedAssuranceTimesinteger
说明 该参数暂未开放使用。
0
LatestStartTimestring
说明 该参数暂未开放使用。
null
PrivatePoolOptionsNamestring

弹性保障服务名称。

eapTestName
RegionIdstring

弹性保障服务所属地域 ID。

cn-hangzhou
EndTimestring

弹性保障服务失效时间。

2021-12-03T16:00Z
StartTimestring

弹性保障服务生效时间。

2020-12-03T05:25Z
Descriptionstring

弹性保障服务描述。

This is description.
ResourceGroupIdstring

资源组 ID。

rg-bp67acfmxazb4p****
TotalAssuranceTimesstring

弹性保障服务的总次数。目前仅支持在服务生效期内的无限次模式。

Unlimited
AllocatedResourcesarray<object>

资源分配详情。

AllocatedResourceobject

资源分配详情。

UsedAmountinteger

已使用的实例的数量。

2
TotalAmountinteger

在一个实例规格内，需要预留的实例的总数量。

2
AvailableAmountinteger
说明 该参数暂未开放使用。
5
zoneIdstring

弹性保障服务所属地域下的可用区 ID。

cn-hangzhou-h
InstanceTypestring

实例规格。

ecs.c6.large
ElasticityAssuranceUsagesarray<object>
说明 该参数暂未开放使用。
ElasticityAssuranceUsageobject
说明 该参数暂未开放使用。
AccountIdstring
说明 该参数暂未开放使用。
1144775968548340
ServiceNamestring
说明 该参数暂未开放使用。
name
UsedAmountinteger
说明 该参数暂未开放使用。
1
Tagsarray<object>

弹性保障服务绑定的标签键值对列表。

Tagobject

弹性保障服务绑定的标签键值对信息。

TagValuestring

标签值。

TestValue
TagKeystring

标签键。

TestKey
InstanceChargeTypestring

实例的计费方式。目前仅支持按量付费。

可能值：PostPaid。

PostPaid
StartTimeTypestring

弹性保障生效方式。可能值：

  • Now：立即生效。
  • Later：指定时间生效。
Now
ElasticityAssuranceOwnerIdstring
说明 该参数暂未开放使用。
e114477596854834

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400MissingParameter.RegionIdThe specified RegionId should not be null.RegionId是必选参数。
400InvalidParameter.NameThe specified PrivatePoolOptions.Name is invalid.-
400InvalidParameter.PrivatePoolOptions.IdsThe specified PrivatePoolOptions.Ids is invalid.-
400DedicatedHostNotSupportedDedicatedHost is not supported for PrivatePool.私有池不支持专有宿主机。
400SpotNotSupportedSpot is not supported for PrivatePool.私有池不支持抢占式实例。
400ClassicNetworkNotSupportedClassic network is not supported for PrivatePool.私有池不支持经典网络类型实例。
400Invalid.InstanceIdInstance does not exist.实例不存在。
400Invalid.PrivatePoolOptions.MatchCriteriaTarget mode does not support this operation.Target模式不支持本次操作。
400MissingParameter.PrivatePoolOptions.IdThe specified PrivatePoolOptions.Id should not be null.PrivatePoolOptions.Id 参数不能为空。
400Invalid.PrivatePoolOptions.IdThe PrivatePool does not exist.私有池不存在。
400Invalid.InstanceTypeThe InstanceType does not match the PrivatePool.实例类型与私有池不匹配。
400Invalid.InstanceChargeTypeThe InstanceChargeType does not match the PrivatePool.实例计费类型与私有池不匹配。
400Invalid.ZoneIdThe ZoneId does not match the PrivatePool.可用区与私有池不匹配。
400Invalid.PrivatePoolOptions.statusThe PrivatePool has been used up.-
400Invalid.PrivatePoolOptions.MatchCriteriaThe PrivatePoolOptions.MatchCriteria does not match the PrivatePool.指定的PrivatePoolOptions.MatchCriteria参数与私有池不匹配。
400InvalidPlatform.ValueNotSupportedThe Platform does not match the PrivatePool.指定的Platform参数与私有池不匹配。
400Invalid.PrivatePoolOptions.statusThe PrivatePool is expired or inactive.-
400Invalid.PrivatePoolOptions.statusThe PrivatePool status is not valid.-
400Invalid.PrivatePoolOptions.statusThe Instance should be created within 48 hours once the PrivatePool is started.-
400InvalidAliUidThe PrivatePool does not belong to the user of the Instance.私有池不属于创建实例的用户。
400Invalid.InstanceIdThe Instance dose not attached to a PrivatePool.实例未与私有池匹配。
400MissingParameter.PackageTypeThe specified parameter "PackageType" can not be empty.-
400MissingParameter.PrivatePoolOptions.IdsThe specified parameter "PrivatePoolOptions.Ids" can not be empty.-
400MissingParameter.PrivatePoolOptions.IdThe specified parameter "PrivatePoolOptions.Id" can not be empty.-
400MissingParameter.InstanceCpuCoreCountThe specified parameter "InstanceCpuCoreCount" can not be empty.-
400MissingParameter.InstanceAmountThe specified parameter "InstanceAmount" can not be empty.-
400MissingParameter.InstanceCpuCoreCountOrInstanceAmountThe specified parameter "InstanceCpuCoreCount" and "InstanceAmount" must not be empty at the same time.-
400Invalid.TooManyPrivatePoolOptions.IdsToo many PrivatePoolOptions.Ids in this request.PrivatePoolOptions.Ids参数超过上限。
400Invalid.TooManyZoneIdsToo many ZoneIds in the request.ZoneIds参数超过上限。
400Invalid.TooManyInstanceTypesToo many InstanceTypes in the request.InstanceTypes参数超过上限。
400Invalid.TooManyUnpaidPrivatePoolToo many PrivatePools create but still unpaid.多个私有池未支付。
400Invalid.InstanceCpuCoreCountOrInstanceAmountBoth InstanceCpuCoreCount and InstanceAmount are provided.InstanceCpuCoreCount和InstanceAmount两个参数不需要同时提供。
400Invalid.PrivatePoolOptions.IdsThe specified parameter "PrivatePoolOptions.Ids" exist invalid element Id.-
400Invalid.PackageTypeThe specified parameter "PackageType" is invalid.-
400Invalid.PrivatePool.PurchaseThe PrivatePool has already paid.私有池已经支付。
400Invalid.AssuranceTimes.NotSupportedThe value of AssuranceTimes is not supported.AssuranceTimes参数值不支持。
400Invalid.TooManyInstanceTypesThe specified parameter "InstanceType" should only has one item.-
400Invalid.PrivatePoolOptions.MatchCriteriaThe specified parameter "PrivatePoolOptions.MatchCriteria" is invalid.-
400RepeatStartPrivatePoolPrivatePool has already been started.私有池已经启动。
400Invalid.PrivatePoolOptions.IdThe specified parameter "PrivatePoolOptions.Id" should be empty.-
400Invalid.InstanceIdModify DedicatedHost Instance's attachment attributes is not supported.-
400Invalid.InstanceIdModify Spot Instance's attachment attributes is not supported.-
400Invalid.InstanceIdModify Classic Network Instance's attachment attributes is not supported.-
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误，请重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-10-30OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2021-10-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
上一篇：CreateElasticityAssurance - 创建弹性保障服务下一篇：DescribeElasticityAssuranceInstances - 查询弹性保障服务已匹配实例列表
文档推荐