云服务器内容精选

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 tags Array of ListTag objects tag对象列表 request_id String 请求ID total_count Integer 资源数量 表5 ListTag 参数 参数类型 描述 key String 功能说明:标签键 约束:key不能为空 最大长度:128 values Array of strings 功能描述:标签值列表。 如果values为空列表,则表示any_value(查询任意value)。value之间为或的关系。 最大长度:255 状态码: 400 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 401 表7 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 403 表8 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 404 表9 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码 状态码: 500 表10 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_msg String 错误消息 error_code String 错误码
  • 响应示例 状态码: 200 操作正常返回 { "request_id" : "65ae533b-f32c-49df-9b5d-e55eda8f2c25", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value2" ] }, { "key" : "key3", "values" : [ "value3" ] }, { "key" : "key4", "values" : [ "value4" ] }, { "key" : "key5", "values" : [ "value5" ] }, { "key" : "keyyyy", "values" : [ "value2" ] } ] }
  • URI GET /v3/{project_id}/firewalls/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 功能说明:查询记录数 取值范围:1-1000 约束:默认为1000 offset 否 Integer 功能说明:索引位置, 从第一条数据偏移offset条数据后开始查询 约束:默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息 状态码: 401 表4 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息 状态码: 403 表5 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息 状态码: 404 表6 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息 状态码: 409 表7 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息 状态码: 500 表8 响应Body参数 参数 参数类型 描述 code String 请求返回的错误码 message String 请求返回的错误信息
  • 操作场景 标签是弹性云服务器的标识。为弹性云服务器添加标签,可以方便用户识别和管理拥有的弹性云服务器资源。 您可以在创建弹性云服务器时添加标签,也可以在弹性云服务器创建完成后,在云服务器的详情页添加标签,您最多可以给弹性云服务器添加10个标签。 创建弹性云服务器时添加的标签,将同步添加至一同创建的EIP和云硬盘(包括系统盘、数据盘)上。如果云服务器使用的是已有EIP,则该标签不会在EIP上标识。 如您的组织已经设定弹性云服务器的相关标签策略,则需按照标签策略规则为弹性云服务器添加标签。如果添加的标签不符合标签策略规则,则可能会导致弹性云服务器创建失败,请联系组织管理员了解标签策略详情。 云服务器创建成功后,您可以在弹性云服务器、EIP和云硬盘详情页,查看到对应的标签。
  • 有关标签的基本知识 标签用于标识资源,当您拥有相同类型的许多云资源时,可以使用标签按各种维度(例如用途、所有者或环境)对云资源进行分类。 图1 标签示例 图1说明了标签的工作方式。在此示例中,您为每个云资源分配了两个标签,每个标签都包含您定义的一个“键”和一个“值”,一个标签使用键为“所有者”,另一个使用键为“用途”,每个标签都拥有相关的值。 您可以根据为云资源添加的标签快速搜索和筛选特定的云资源。例如,您可以为账户中的资源定义一组标签,以跟踪每个云资源的所有者和用途,使资源管理变得更加轻松。
  • 响应参数 表2 参数说明 参数 参数类型 描述 tags Array of objects 标签列表。 详情请参见表3。 表3 tags字段数据结构说明 参数 参数类型 描述 key String 标签键。最大长度36个unicode字符,key不能为空。 字符集:0-9,A-Z,a-z,“_”,“-”,中文。 value Array of strings 标签值。最大长度43个unicode字符,可以为空字符串。 字符集:0-9,A-Z,a-z,“_”,“.”,“-”,中文。
  • 请求示例 按标签查询资源,备查询绑定了指定标签的设备。 POST https://{endpoint}/v5/iot/{project_id}/tags/query-resources { "resource_type" : "device", "tags" : [ { "tag_key" : "testTagName", "tag_value" : "testTagValue" } ] }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 resources Array of ResourceDTO objects 资源列表。 page Page object 查询结果的分页信息。 表7 ResourceDTO 参数 参数类型 描述 resource_id String 资源id。例如,要查询的资源类型为device,那么对应的资源id就是device_id。 表8 Page 参数 参数类型 描述 count Long 满足查询条件的记录总数。 marker String 本次分页查询结果中最后一条记录的ID,可在下一次分页查询时使用。
  • URI POST /v5/iot/{project_id}/tags/query-resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数说明:项目ID。获取方法请参见 获取项目ID 。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 参数说明:分页查询时每页显示的记录数。 取值范围:1-50的整数,默认值为10。 最小值:1 最大值:50 缺省值:10 marker 否 String 参数说明:上一次分页查询结果中最后一条记录的ID,在上一次分页查询时由 物联网平台 返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的,越新的数据记录ID也会越大。若填写marker,则本次只查询记录ID小于marker的数据记录。若不填写,则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据,则每次查询时必须填写上一次查询响应中的marker值。 取值范围:长度为24的十六进制字符串,默认值为ffffffffffffffffffffffff。 缺省值:ffffffffffffffffffffffff offset 否 Integer 参数说明:表示从marker后偏移offset条记录开始查询。当offset为0时,表示从marker后第一条记录开始输出。限制offset最大值是出于API性能考虑,您可以搭配marker使用该参数实现翻页,例如每页50条记录,1-11页内都可以直接使用offset跳转到指定页,但到11页后,由于offset限制为500,您需要使用第11页返回的marker作为下次查询的marker,以实现翻页到12-22页。 取值范围:0-500的整数,默认为0。 最小值:0 最大值:500 缺省值:0
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 参数说明:用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 Instance-Id 否 String 参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考查看实例详情 。 表4 请求Body参数 参数 是否必选 参数类型 描述 resource_type 是 String 参数说明:要查询的资源类型,当前支持设备(device)。 tags 是 Array of TagV5DTO objects 参数说明:标签列表,支持按照标签key和value组合查询,传入的多个标签之间是或的关系。 表5 TagV5DTO 参数 是否必选 参数类型 描述 tag_key 是 String 参数说明:标签键,在同一资源下标签键唯一。绑定资源时,如果设置的键已存在,则将覆盖之前的标签值。如果设置的键值不存在,则新增标签。 取值范围:长度不超过64,只允许中文、字母、数字、以及_.-等字符的组合。 tag_value 否 String 参数说明:标签值。 取值范围:长度不超过128,只允许中文、字母、数字、以及_.-等字符的组合。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表4 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”字段。 该字段为false或者未提供该参数时,该条件不生效。 tags 否 Array of TmsKeyValues objects 包含标签,最多包含20个key,每个key下面的value最多20个。无tag过滤条件时返回全量数据。 数组长度:0 - 20 sys_tags 否 Array of TmsKeyValues objects 企业项目.仅op_service权限可以使用此字段做资源实例过滤条件. 无sys_tags时按照tag接口处理,无tag过滤条件时返回全量数据。 数组长度:0 - 1 matches 否 Array of TmsMatchesKeyValue objects 搜索字段,key为要匹配的字段,当前限定为resource_name。value为匹配的值。 根据key的值确认是否需要模糊匹配,如resource_name需要实现前缀搜索。 表5 TmsKeyValues 参数 是否必选 参数类型 描述 key 否 String 键。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : = + - @; _sys_开头属于系统标签,租户不能输入 最小长度:1 最大长度:128 values 否 Array of strings 值。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @ 表6 TmsMatchesKeyValue 参数 是否必选 参数类型 描述 key 否 String 要匹配的字段 resource_name 表示按照APIG实例的名称去匹配 枚举值: resource_name value 否 String 值。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @ 最大长度:255
  • 响应示例 状态码: 200 返回的实例列表 { "resources" : [ { "resource_id" : "e120108ac331422cb539d8609e9a7bb2", "resouce_detail" : null, "resource_name" : "apig_instance", "tags" : [ { "key" : "test-key", "value" : "test-value" } ] } ], "total_count" : 1 } 状态码: 401 Unauthorized { "error_code" : "APIC.7102", "error_msg" : "Incorrect token or token resolution failed" } 状态码: 403 Forbidden { "error_code" : "APIC.7106", "error_msg" : "No permissions to request for the method" } 状态码: 500 Internal Server Error { "error_code" : "APIC.9000" }
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 resources Array of TmsResourceResp objects 实例列表 total_count Integer 总记录数 表8 TmsResourceResp 参数 参数类型 描述 resource_id String 实例编号 resouce_detail String 实例详细描述。暂不支持 resource_name String 实例名称 tags Array of TmsKeyValue objects 实例绑定的标签列表 数组长度:0 - 20 表9 TmsKeyValue 参数 参数类型 描述 key String 键。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : = + - @; _sys_开头属于系统标签,租户不能输入 最小长度:1 最大长度:128 value String 值。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255 状态码: 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求示例 根据标签过滤实例列表 { "without_any_tag" : false, "tags" : [ { "key" : "test-key", "values" : [ "test-value" ] } ], "matches" : [ { "key" : "resource_name", "value" : "test-apig" } ] } 根据企业项目id过滤实例列表 { "without_any_tag" : false, "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "values" : [ "0" ] } ], "matches" : [ { "key" : "resource_name", "value" : "test-apig" } ] }