云主机

产品文档

云主机

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

describeInstancesCustomData

描述

批量查询云主机用户自定义元数据。

详细操作说明请参考帮助文档:自定义元数据

接口说明

  • 使用 filters 过滤器进行条件筛选,每个 filter 之间的关系为逻辑与(AND)的关系。
  • 单次查询最大可查询10台云主机实例自定义元数据。

请求方式

GET

请求地址

https://vm.jdcloud-api.com/v1/regions/{regionId}/instancesCustomData

名称 类型 是否必需 示例值 描述
regionId String cn-north-1 地域ID。

请求参数

名称 类型 是否必选 示例值 描述
pageNumber Integer 页码;默认为1。
pageSize Integer 分页大小;默认为10;取值范围[1, 10]。
filters Filter[ ] filters 中支持使用以下关键字进行过滤
instanceId: 云主机ID,精确匹配,支持多个
privateIpAddress: 主网卡内网主IP地址,模糊匹配,支持多个
vpcId: 私有网络ID,精确匹配,支持多个
status: 云主机状态,精确匹配,支持多个,参考 云主机状态
name: 云主机名称,模糊匹配,支持单个
imageId: 镜像ID,精确匹配,支持多个
agId: 使用可用组id,支持单个
faultDomain: 错误域,支持多个
networkInterfaceId: 弹性网卡ID,精确匹配,支持多个
subnetId: 子网ID,精确匹配,支持多个

Filter

名称 类型 是否必选 示例值 描述
name String 过滤条件的名称
operator String 过滤条件的操作符,默认eq
values String[ ] 过滤条件的值

返回参数

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

Result

名称 类型 示例值 描述
customData CustomData[ ] 云主机实例自定义元数据列表。
totalCount Number 本次查询可匹配到的总记录数,使用者需要结合pageNumberpageSize计算是否可以继续分页。

CustomData

名称 类型 示例值 描述
instanceId String i-eumm****d6 云主机ID。
metadata Metadata[ ] 自定义元数据。
为key-value键值对形式,可在实例系统内通过元数据服务查询获取。单实例最多支持40对键值对。
userdata Userdata[ ] 自定义脚本。
目前仅支持启动脚本,即 launch-script,须 base64 编码且编码前数据长度不能超过16KB。

Userdata

名称 类型 示例值 描述
key String launch-script 脚本类型,当前仅支持输入 launch-script,即启动脚本。
value String IyEvYmluL2Jhc2gKZWNobyAnMTIzJw 脚本内容,须 Base64 编码,且编码前长度不能超过16KB。

Metadata

名称 类型 示例值 描述
key String index key,字符长度不超过256,支持全字符。
value String 1 value,字符长度不超过16KB,支持全字符。

请求示例

GET

/v1/regions/cn-north-1/instancesCustomData?pageNumber=1&pageSize=10&filters.1.name=instanceId&filters.1.values.1=i-eumm****d6

返回示例

{
    "requestId": "1ba20ebdf2fa27e39ea8efec75066351", 
    "result": {
        "customData": [
            {
                "instanceId": "i-eumm****d6", 
                "metadata": [
                    {
                        "key": "k8s-kube-reserved-cpu", 
                        "value": "110"
                    }, 
                    {
                        "key": "k8s-node-variables", 
                        "value": "H4sJwIb83YcAA/5xTXW+bQBD8L/tsY1AAktIAAAAX+LAVVtXsznw69F"
                    }
                ], 
                "userdata": [
                    {
                        "key": "launch-script", 
                        "value": "IyEvdXNyL2Jpbi9lbnYgYmFzaAoKTE9DS0VSX0ZJTEU"
                    }
                ]
            }
        ], 
        "totalCount": 1
    }
}

返回码

HTTP状态码 错误码 描述 错误解析
200 OK
400 OUT_OF_RANGE PageSize out of range 分页大小超出规定范围。
500 INTERNAL Internal server error 系统内部错误,请稍后重试。如果多次尝试失败,请提交工单。
500 UNKNOWN Unknown server error 服务暂时不可用,请稍后重试。如果多次尝试失败,请提交工单。
更新时间:2021-09-01 20:20:29
文档反馈 docs feedback