文档

GetDisk - 查询单个云盘

更新时间:

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

地域

cn-hangzhou
DiskIdstring

磁盘 ID

d-bp67***********

返回参数

名称类型描述示例值
object

GetDiskResponse

Diskobject

云盘列表。

CreationTimestring

创建时间

2021-11-18T19:30:16+08:00
ModifyAtstring

修改时间。

2021-11-18T19:30:16+08:00
DiskIdstring

云盘 ID。

d-bp19c*********
DiskNamestring

云盘名称。

diskName
Descriptionstring

云盘描述信息。

desc
RegionIdstring

地域 ID。

cn-hangzhou
ZoneIdstring

云盘所属的可用区 ID。

cn-hangzhou-k
Categorystring

云盘种类为 cloud_essd,表示 ESSD 云盘。

cloud_essd
Sizelong

云盘大小,单位为 GiB。

20
KmsKeyIdstring

同地域内的云盘加密的密钥 ID。

key-hz**************
PerformanceLevelstring

ESSD 云盘的性能等级。可能值:

  • PL0:单盘最高随机读写 IOPS 1 万。
  • PL1:单盘最高随机读写 IOPS 5 万。
  • PL2:单盘最高随机读写 IOPS 10 万。
  • PL3:单盘最高随机读写 IOPS 100 万。
PL1
Encryptedboolean

是否为加密云盘。

true
Statusstring

云盘状态。可能值:

  • In_use
  • Available
  • Attaching
  • Detaching
  • Creating
  • ReIniting
Available
AttachedTimestring

该云盘最后一次挂载的时间。按照ISO 8601标准表示,使用 UTC+0 时间。格式为:yyyy-MM-ddThh:mmZ。

2021-11-18T19:30:16+08:00
DetachedTimestring

该云盘最后一次卸载时间。

2021-11-18T19:30:16+08:00
Attachmentsobject []

云盘所涉及的挂载信息。由Attachment对象组成的列表,查询共享块存储时不返回该列表。

InstanceIdstring

云盘挂载的实例 ID。您需要注意:

  • 该参数值仅在Status参数值为In_use时才有值,其他状态时为空。

  • 对于开启多重挂载特性的云盘,该值始终为空。您可以通过返回的Attachment对象组成的列表,查看云盘所涉及的所有挂载信息。

i-cad***********
AttachedTimestring

该云盘最后一次挂载的时间。按照 ISO8601 标准表示,使用 UTC+0 时间。格式为:yyyy-MM-ddThh:mmZ。

2021-11-18T19:30:16+08:00
NamespaceIdinteger

命名空间 ID

308e2*****************
AccessAuthorizationobject []

安全挂载授权对象。

Podobject

容器实例参数对象。

ClusterIdstring

集群 ID。

ccf9**************
PodIdstring

Pod ID。

pid****************
Ecsobject

ECS 实例参数对象。

InstanceIdstring

云盘授权挂载的实例 ID。

i-uf6*******************
AccessTokenstring

云盘挂载 Token。

4cd9******************
Tagsobject []

标签信息。

TagKeystring

资源的标签键

tag_key
TagValuestring

资源的标签值

tag_value
BurstingEnabledboolean

是否开启 Burst(性能突发)。可能值:

  • true:是。
  • false:否。

DiskCategory取值为cloud_auto时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘

true
Throughputlong

目标云盘吞吐量,仅支持修改专属存储集群云盘吞吐量,单位 MB/s。

取值范围:60~单盘最大吞吐量。

更多信息,请参见云盘性能

600
Iopslong

云盘总 IOPS。

46800
ProvisionedIopslong

ESSD AutoPL 云盘预配置的读写 IOPS。可能值:0~min{50000, 1000*容量-基准性能}。

基准性能=min{1,800+50*容量, 50,000}。

DiskCategory取值为cloud_auto时才支持设置该参数。更多信息,请参见ESSD AutoPL 云盘

5000
IopsReadlong

云盘读 IOPS。

500
IopsWritelong

云盘写 IOPS。

500
DeviceNguidstring

云盘设备 ID。

4cd************
ResourceGroupIdstring

资源组 ID

rg-aek*************
RequestIdstring

请求 ID

B9C4B3B3-0D72-5FB0-9319-F4D3BB9E22AC

示例

正常返回示例

JSON格式

{
  "Disk": {
    "CreationTime": "2021-11-18T19:30:16+08:00",
    "ModifyAt": "2021-11-18T19:30:16+08:00\n",
    "DiskId": "d-bp19c*********",
    "DiskName": "diskName",
    "Description": "desc",
    "RegionId": "cn-hangzhou",
    "ZoneId": "cn-hangzhou-k",
    "Category": "cloud_essd",
    "Size": 20,
    "KmsKeyId": "key-hz**************",
    "PerformanceLevel": "PL1",
    "Encrypted": true,
    "Status": "Available",
    "AttachedTime": "2021-11-18T19:30:16+08:00\n",
    "DetachedTime": "2021-11-18T19:30:16+08:00\n",
    "Attachments": [
      {
        "InstanceId": "i-cad***********",
        "AttachedTime": "2021-11-18T19:30:16+08:00",
        "NamespaceId": 0
      }
    ],
    "AccessAuthorization": [
      {
        "Pod": {
          "ClusterId": "ccf9**************",
          "PodId": "pid****************"
        },
        "Ecs": {
          "InstanceId": "i-uf6*******************"
        },
        "AccessToken": "4cd9******************"
      }
    ],
    "Tags": [
      {
        "TagKey": "tag_key",
        "TagValue": "tag_value"
      }
    ],
    "BurstingEnabled": true,
    "Throughput": 600,
    "Iops": 46800,
    "ProvisionedIops": 5000,
    "IopsRead": 500,
    "IopsWrite": 500,
    "DeviceNguid": "4cd************",
    "ResourceGroupId": "rg-aek*************"
  },
  "RequestId": "B9C4B3B3-0D72-5FB0-9319-F4D3BB9E22AC"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe parameter %s is invalid.参数错误
400InvalidParameter.ConflictThe specified parameter %s and %s are not blank at the same time.参数冲突
400InvalidParameter.FormatSpecified parameter format is not valid.返回值格式不正确(Format 不支持)。返回格式支持 XML 与 JSON,默认为 XML。
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.参数缺失。
403ForbiddenUser is not authorized to operate.当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
403Forbidden.ActionUser is not authorized to operate this action.当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.您的账户余额不足。
403LastTokenProcessingThe last token request is processing.相同clientToken的请求正在执行,请稍后再重试。
403NoPermission.SLRThe RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.当前用户无权限创建SLR。
403OperationDeniedThe operation is not allowed.当前操作不允许执行。
404InvalidApi.NotFoundSpecified api is not found, please check your url and method.找不到指定的 API。请检查调用的 URL 和方法。您调用的 API 不存在。请检查 API 的名称是否正确,请注意确认大小写。
404NoSuchResourceThe specified resource does not exist.指定的资源不存在。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误。
504RequestTimeoutThe request is timeout, please try again later.该请求超时,请稍后再重试。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈