文档平台 API 中心 云硬盘 云硬盘相关接口 查询实例关联的云硬盘数量

查询实例关联的云硬盘数量

最近更新时间:2018-10-26 15:10:08

1. 接口描述

接口请求域名: cbs.tencentcloudapi.com 。

本接口(DescribeInstancesDiskNum)用于查询实例已挂载云硬盘数量。

  • 支持批量操作,当传入多个云服务器实例ID,返回结果会分别列出每个云服务器挂载的云硬盘数量。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cbs.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstancesDiskNum
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
InstanceIds.N Array of String 云服务器实例ID,通过DescribeInstances接口查询。

3. 输出参数

参数名称 类型 描述
AttachDetail Array of AttachDetail 各个云服务器已挂载和可挂载弹性云盘的数量。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询多个实例挂载的云硬盘数量

输入示例

https://cbs.tencentcloudapi.com/?Action=DescribeInstancesDiskNum
&InstanceIds.0=ins-9w5d2buw
&InstanceIds.1=ins-jw0vit58
&<公共请求参数>

输出示例

{
  "Response": {
    "AttachDetail": [
      {
        "AttachedDiskCount": 1,
        "InstanceId": "ins-9w5d2buw",
        "MaxAttachCount": 10
      },
      {
        "AttachedDiskCount": 2,
        "InstanceId": "ins-jw0vit58",
        "MaxAttachCount": 10
      }
    ],
    "RequestId": "55db49cf-b9d7-da27-825b-5a02ba6884ca"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InvalidDisk.NotPortable 不支持非弹性云盘
InvalidDiskId.NotFound 输入的DiskId不存在。
InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
MissingParameter 参数缺失。请求没有带必选参数。

如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >