查看云硬盘配置

最近更新时间:2024-03-12 01:38:06

我的收藏

1. 接口描述

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

本接口(DescribeDiskConfigs)用于查询云硬盘配置。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDiskConfigs。
Version String 公共参数,本接口取值:2020-03-24。
Region String 公共参数,详见产品支持的 地域列表
Filters.N Array of Filter 过滤器列表。
  • zone
  • 按照【可用区】进行过滤。
    类型:String
    必选:否

    3. 输出参数

    参数名称 类型 描述
    DiskConfigSet Array of DiskConfig 云硬盘配置列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询磁盘配置

    输入示例

    POST / HTTP/1.1
    Host: lighthouse.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeDiskConfigs
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Name": "zone",
                "Values": [
                    "ap-guangzhou-2"
                ]
            }
        ]
    }

    输出示例

    {
        "Response": {
            "DiskConfigSet": [
                {
                    "Zone": "ap-guangzhou-2",
                    "DiskType": "CLOUD_PREMIUM",
                    "MaxDiskSize": 1000,
                    "MinDiskSize": 10,
                    "DiskStepSize": 10,
                    "DiskSalesState": "SOLD_OUT"
                },
                {
                    "Zone": "ap-guangzhou-2",
                    "DiskType": "CLOUD_SSD",
                    "MaxDiskSize": 1000,
                    "MinDiskSize": 20,
                    "DiskStepSize": 10,
                    "DiskSalesState": "SOLD_OUT"
                }
            ],
            "RequestId": "8f8e7988-39e6-4ed6-8e36-135b639e9a3a"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.RequestError 请求错误。
    InternalError.RequestError 请求出现错误。
    InvalidParameter.InvalidFilter 参数非法,Filter 参数非法。
    InvalidParameterValue.InvalidZone 参数Zone的取值不合法。
    InvalidParameterValue.ZoneInvalid 非法的可用区。
    UnauthorizedOperation.NoPermission 无权限。