云主机

产品文档

云主机

帮助中心 > OpenAPI & SDK > 云主机 > describeImageConstraints

describeImageConstraints

描述

查询单个镜像的实例规格限制。

详细操作说明请参考帮助文档:实例使用限制

接口说明

  • 该接口与批量查询镜像的实例规格限制返回的信息一致。
  • 通过此接口可以查询镜像的实例规格限制信息。
  • 只有官方镜像、第三方镜像有实例规格的限制,用户的私有镜像没有此限制。

请求方式

GET

请求地址

https://vm.jdcloud-api.com/v1/regions/{regionId}/images/{imageId}/constraints

名称 类型 是否必需 示例值 描述
regionId String cn-north-1 地域ID。
imageId String i-eumm****d6 镜像ID。

请求参数

返回参数

名称 类型 示例值 描述
result Result 响应结果。
requestId String c2hmmaan8w06w19qcdfuic4w03f7ft2d 请求ID。

Result

名称 类型 示例值 描述
imageConstraints ImageConstraint 镜像限制信息。

ImageConstraint

名称 类型 示例值 描述
imageId String img-m5s0****29 镜像ID。
imageInstanceTypeConstraint ImageInstanceTypeConstraint 镜像对实例规格的约束信息。

ImageInstanceTypeConstraint

名称 类型 示例值 描述
constraintsType String excludes 对实例规格的限制类型。可能值:
excludes:不支持的实例规格,当前只支持 excludes 一种类型。
includes:支持的实例规格。
instanceTypes String[ ] ["g.n4.xlarge","m.n4.xlarge"] 实例规格列表。

请求示例

GET

/v1/regions/cn-north-1/images/img-m5s0****29/constraints

返回示例

{
    "requestId": "46162394283a49252c51f0e94e9e2e25", 
    "result": {
        "imageConstraints": {
            "imageId": "img-m5s0****29", 
            "imageInstanceTypeConstraint": {
                "constraintsType": "excludes", 
                "instanceTypes": [
                    "p.c1p40g.3large", 
                    "p.c1p40g.xlarge", 
                    "m.n4.2xlarge", 
                    "g.n2.metal"
                ]
            }
        }
    }
}

返回码

HTTP状态码 错误码 描述 错误解析
200 OK
404 NOT_FOUND Image 'xx' not found 镜像不存在。
500 INTERNAL Internal server error 系统内部错误,请稍后重试。如果多次尝试失败,请提交工单。
500 UNKNOWN Unknown server error 服务暂时不可用,请稍后重试。如果多次尝试失败,请提交工单。
更新时间:2021-09-01 20:20:29
文档反馈 docs feedback