有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

本接口 (DescribeInstancesModification) 用于查询指定实例支持调整的机型配置。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstancesModification。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceIds.N Array of String 一个或多个待查询的实例ID。可通过 DescribeInstances 接口返回值中的InstanceId获取。每次请求批量实例的上限为20。
示例值:["ins-4txox06m"]
Filters.N Array of Filter
  • status

  • 按照【配置规格状态】进行过滤。配置规格状态形如:SELL、UNAVAILABLE。

    类型:String

    必选:否


    每次请求的Filters的上限为10,Filter.Values的上限为2。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 实例调整的机型配置的数量。
    示例值:10
    InstanceTypeConfigStatusSet Array of InstanceTypeConfigStatus 实例支持调整的机型配置列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询指定实例支持调整的机型配置

    查询指定实例支持调整的机型配置

    输入示例

    POST / HTTP/1.1
    Host: cvm.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeInstancesModification
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Values": [
                    "SELL"
                ],
                "Name": "status"
            }
        ],
        "InstanceIds": [
            "ins-bzps2kwdg"
        ]
    }

    输出示例

    {
        "Response": {
            "InstanceTypeConfigStatusSet": [
                {
                    "Status": "SELL",
                    "InstanceTypeConfig": {
                        "GPU": 0,
                        "Zone": "ap-guangzhou-2",
                        "FPGA": 0,
                        "InstanceFamily": "SA2",
                        "InstanceType": "SA2.MEDIUM4",
                        "Memory": 4,
                        "GpuCount": 0,
                        "CPU": 2
                    },
                    "Message": null
                }
            ],
            "TotalCount": 1,
            "RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation.ZoneInconsistent 给定实例所在可用区不相同,请给定相同可用区的实例。
    InvalidFilter 无效的过滤器。
    InvalidFilterValue.LimitExceeded Filter
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidParameterValue.InstanceIdMalformed 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidParameterValue.ZoneNotSupported 请求不支持该可用区
    UnsupportedOperation.UnsupportedChangeInstanceFamily 指定机型不支持跨机型调整配置。