调用DescribeDedicatedBlockStorageClusters查询已创建的专属块存储集群列表。
接口说明
说明 专属块存储集群功能目前支持华南2(河源)、印度尼西亚(雅加达)以及华南1(深圳)地域。
- 请求参数的作用类似于一个过滤器,过滤器为逻辑与(AND)关系。如果某一参数为空,则过滤器不起作用。
- 在分页查询时,推荐您使用MaxResults与NextToken参数进行查询。具体使用说明:分页查询首页时,仅需设置MaxResults以限制返回信息的条目数,返回结果中的NextToken将作为查询后续页的凭证。查询后续页时,将NextToken参数设置为上一次返回结果中获取到的NextToken作为查询凭证,并设置MaxResults限制返回条目数。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDedicatedBlockStorageClusters |
系统规定参数。取值:DescribeDedicatedBlockStorageClusters。 |
MaxResults | Integer | 否 | 10 |
分页查询时每页的最大条目数。最大值为500。 默认值:10 |
NextToken | String | 否 | AAAAAdDWBF2 |
查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。 |
RegionId | String | 是 | cn-heyuan |
地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
AzoneId | String | 否 | cn-heyuan-b |
可用区ID,您可以调用DescribeZones获取可用区列表。 |
DedicatedBlockStorageClusterId.N | String | 否 | dbsc-f8z4d3k4nsgg9okb**** |
专属块存储集群ID。支持同时指定多个专属块存储集群ID进行查询。 |
Status.N | String | 否 | Running |
专属块存储集群的状态。取值范围:
N表示可同时设置多个状态,N的取值范围为1~4。 |
Category | String | 否 | cloud_essd |
专属块存储集群可创建的云盘类型。 取值仅支持cloud_essd,即ESSD云盘。 |
ClientToken | String | 否 | 123e4567-e89b-12d3-a456-426655440000 |
保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多详情,请参见如何保证幂等性。 |
Tag.N.Key | String | 否 | TestKey |
专属集群的标签键。 |
Tag.N.Value | String | 否 | TestValue |
专属集群的标签值。 |
ResourceGroupId | String | 否 | rg-acfmvs4**** |
专属集群所在的企业资源组ID。您可以调用ListResourceGroups查询资源组ID。 |
PageNumber | Integer | 否 | 1 |
分页查询时的页码。 |
PageSize | Integer | 否 | 10 |
分页查询时设置的每页行数。 取值范围1-100。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 11B55F58-D3A4-4A9B-9596-342420D0**** |
请求ID。 |
NextToken | String | AAAAAdDWBF2 |
本次调用返回的查询凭证值。 |
DedicatedBlockStorageClusters | Array of Dbsc |
由一个或多个专属块存储集群信息组成的数组。 |
|
DedicatedBlockStorageClusterId | String | dbsc-f8z4d3k4nsgg9okb**** |
专属块存储集群ID。 |
DedicatedBlockStorageClusterName | String | myDBSCCluster |
专属块存储集群名称。 |
Description | String | This is description. |
专属块存储集群的描述信息。 |
RegionId | String | cn-heyuan |
专属块存储集群所在地域ID。 |
ZoneId | String | cn-heyuan-b |
专属块存储集群所属的可用区ID。 |
Status | String | Running |
专属块存储集群的状态。可能值:
|
Category | String | cloud_essd |
专属块存储集群可创建的云盘类型。 |
Type | String | Standard |
专属块存储集群性能类型。可能值:
|
PerformanceLevel | String | PL0 |
云盘性能等级,可能值:
说明 仅在SupportedCategory=cloud_essd有效。 |
SupportedCategory | String | cloud_essd | 暂未支持该参数。 |
CreateTime | String | 1657113211 |
专属块存储集群创建时间,格式为Unix时间戳,单位为秒。 |
ExpiredTime | String | 1673020800 |
专属块存储集群到期时间,格式为Unix时间戳,单位为秒。 |
DedicatedBlockStorageClusterCapacity | Object |
专属块存储集群的存储容量信息。 |
|
AvailableCapacity | Long | 61440 |
专属块存储集群的可用容量,单位为GiB。 |
TotalCapacity | Long | 61440 |
专属块存储集群的总容量,单位为GiB。 |
DeliveryCapacity | Long | 0 |
待交付容量,单位为GiB。 |
UsedCapacity | Long | 1440 |
当前集群的已使用(已创盘)容量,单位为GiB。 |
Tags | Array of Tag |
专属集群的标签。 |
|
TagKey | String | testKey |
专属集群的标签键。 |
TagValue | String | testValue |
专属集群的标签值。 |
ResourceGroupId | String | rg-aekzsoux**** |
专属集群所在的企业资源组ID。您可以调用ListResourceGroups查询资源组ID。 |
PageNumber | Integer | 1 |
参数页码。 |
PageSize | Integer | 10 |
参数页行数。 |
TotalCount | Long | 20 |
分页查询时的结果总条数。 |
示例
请求示例
https://ebs.cn-heyuan.aliyuncs.com/?Action=DescribeDedicatedBlockStorageClusters
&MaxResults=10
&NextToken=AAAAAdDWBF2
&RegionId=cn-heyuan
&AzoneId=cn-heyuan-b
&DedicatedBlockStorageClusterId=["dbsc-f8z4d3k4nsgg9okb****"]
&Status=["Running"]
&Category=cloud_essd
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
11B55F58-D3A4-4A9B-9596-342420D0****
AAAAAdDWBF2
dbsc-f8z4d3k4nsgg9okb****
myDBSCCluster
This is description.
cn-heyuan
cn-heyuan-b
Running
cloud_essd
Standard
PL0
cloud_essd
2022-07-07 16:45:45
2023-03-09 00:00:00
61440
61440
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "11B55F58-D3A4-4A9B-9596-342420D0****",
"NextToken" : "AAAAAdDWBF2",
"DedicatedBlockStorageClusters" : [ {
"DedicatedBlockStorageClusterId" : "dbsc-f8z4d3k4nsgg9okb****",
"DedicatedBlockStorageClusterName" : "myDBSCCluster",
"Description" : "This is description.",
"RegionId" : "cn-heyuan",
"ZoneId" : "cn-heyuan-b",
"Status" : "Running",
"Category" : "cloud_essd",
"Type" : "Standard",
"PerformanceLevel" : "PL0",
"SupportedCategory" : "cloud_essd",
"CreateTime" : "2022-07-07 16:45:45",
"ExpiredTime" : "2023-03-09 00:00:00",
"DedicatedBlockStorageClusterCapacity" : {
"AvailableCapacity" : 61440,
"TotalCapacity" : 61440
}
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParameter | The input parameter %s that is mandatory for processing this request is not supplied. | 参数缺失。 |
403 | Forbidden | User is not authorized to operate. | 当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。 |
403 | Forbidden.Action | User is not authorized to operate this action. | 当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。 |
403 | InvalidDiskCategory.NotSupported | The specified disk category is not supported. | 当前操作不支持您指定的磁盘类型。请检查您的输入参数和API文档。 |
403 | NoPermission.SLR | The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS. | 当前用户无权限创建SLR。 |
404 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | 找不到指定的 API。请检查调用的 URL 和方法。您调用的 API 不存在。请检查 API 的名称是否正确,请注意确认大小写。 |
404 | InvalidRegionId.NotFound | The specified RegionId does not exist. | 指定的RegionId不存在。 |
404 | InvalidResourceId.NotFound | The specified ResourceIds are not found in our records. | 指定的资源不存在,请检查参数ResourceId是否正确。 |
404 | InvalidResourceType.NotFound | The ResourceType provided does not exist in our records. | 指定的资源类型不存在。 |
404 | InvalidZoneId.NotFound | The specified ZoneId does not exist. | 指定的ZoneId不存在。 |
404 | NoSuchResource | The specified resource does not exist. | 指定的资源不存在。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误。 |
504 | RequestTimeout | The request is timeout, please try again later. | 该请求超时,请稍后再重试。 |
访问错误中心查看更多错误码。
腾讯云1折,限时活动,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利。同意关联立享优惠
转转请注明出处:https://www.yunxiaoer.com/153363.html