云服务器内容精选

  • 请求示例 根据资源类型及标签信息查询实例列表 POST https://{endpoint}/v1/organizations/{resource_type}/resource-instances/filter { "without_any_tag" : true, "tags" : [ { "key" : "string", "values" : [ "string" ] } ], "matches" : [ { "key" : "string", "value" : "string" } ] }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 resources Array of ResourceDTO objects 资源信息列表。 total_count Integer 总记录数。 表7 ResourceDTO 参数 参数类型 描述 resource_id String 资源Id。 resource_name String 资源名称。 tags Array of Match objects 资源标签列表。 表8 Match 参数 参数类型 描述 key String 键。取值范围为policy , organizational-unit, account。 value String 值。每个值最大长度255个unicode字符。
  • 响应示例 状态码: 200 Successful { "resources" : [ { "resource_id" : "string", "resource_name" : "string", "tags" : [ { "key" : "string", "value" : "string" } ] } ], "total_count" : 0 }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 表4 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签,该字段为true时查询所有不带标签的资源。 tags 否 Array of TagsDTO objects 包含标签,最多包含10个key,每个key下面的value最多10个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 表5 TagsDTO 参数 是否必选 参数类型 描述 key 是 String 键。最大长度127个unicode字符。 key不能为空。 values 是 Array of strings 值列表。每个值最大长度255个unicode字符。
  • URI POST https://{endpoint}/v1/organizations/{resource_type}/resource-instances/filter 表1 路径参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型。枚举值:organizations:policies(服务策略)、organizations:ous(组织OU)、organizations:accounts(账号信息) 、organizations:roots:(根)。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 页面中最大结果数量。 offset 否 String 分页标记。
  • 请求示例 批量添加标签key1和key2。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/tags/action { "action": "create", "tags": [{ "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" }] }
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 action 是 String 操作标识(区分大小写):创建时为“create”。 tags 是 Array of objects 标签列表。单个实例总标签数上限20个。 详情请参见表3。 表3 tags字段数据结构说明 名称 是否必选 参数类型 说明 key 是 String 标签键。长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 value 是 String 标签值。最大长度255个unicode字符,可以为空字符串。 可以包含任何语种字母、数字、空格和_.:=+-@。
  • 响应示例 状态码: 200 请求成功。 { "resources" : [ { "resource_id" : "string", "resource_name" : "string", "resource_detail" : { }, "tags" : [ { "key" : "string", "value" : "string" } ] } ], "total_count" : 0 }
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 resources Array of ResourceDTO objects 资源信息列表。 total_count Integer 总记录数。 表7 ResourceDTO 参数 参数类型 描述 resource_id String 资源ID。 resource_name String 资源名称。 tags Array of Tag objects 资源标签列表。 resource_detail Object 资源详情。 表8 Tag 参数 参数类型 描述 key String 标签"键"的标识符或名称。 value String 标签"键"对应的"值"。您可以将标签的值设置为空字符串,但不能设置为null。
  • 请求示例 根据标签信息查询资源共享实例列表。 POST https://{endpoint}/v1/resource-shares/resource-instances/filter { "without_any_tag" : true, "tags" : [ { "key" : "string", "values" : [ "string" ] } ], "matches" : [ { "key" : "string", "value" : "string" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Security-Token 否 String 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 表3 请求Body参数 参数 是否必选 参数类型 描述 without_any_tag 否 Boolean 不包含任意一个标签,该字段为true时查询所有不带标签的资源。 tags 否 Array of TagFilter objects 包含标签,最多包含20个key,每个key下面的value最多20个,结构体不能缺失,key不能为空或者空字符串。Key不能重复,同一个key中values不能重复。返回包含所有标签的资源列表,key之间是"与"的关系,key-value结构中value是"或"的关系。无tag过滤条件时返回全量数据。 matches 否 Array of Match objects 资源共享实例绑定标签列表的匹配字段。 表4 TagFilter 参数 是否必选 参数类型 描述 key 是 String 标签"键"的标识符或名称。 values 否 Array of strings 标签"键"对应的"值"列表。 表5 Match 参数 是否必选 参数类型 描述 key 是 String 键。取值范围为policy , organizational-unit, account。 value 是 String 值。每个值最大长度255个字符。
  • 标签管理相关操作 在“标签管理”界面,还可以进行以下操作。 表1 标签管理相关操作 任务 操作步骤 新建根标签 单击“新增标签”,输入标签名称。 新建标签 单击标签后的,输入标签名称。 修改标签 单击标签后的,可对标签的名称进行修改。 删除标签 单击标签后的,可删除标签或其子节点标签。 说明: 平台预置场景标签暂不支持编辑、删除。 导出标签 单击根标签后的,可导出标签至本地。 搜索标签 在搜索框输入搜索内容,可模糊搜索标签。 多项搜索:可根据需要决定是否启用多项搜索,输入多个关键字,中间用“;”隔开,可搜索多个关键字。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值:application/json; charset=UTF-8 最小长度:1 最大长度:64 X-Auth-Token 是 String 用户Token。 最小长度:1 最大长度:16384
  • URI GET /v2/{project_id}/{resource_type}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID。 最小长度:1 最大长度:64 正则匹配:^[a-zA-Z0-9-]{1,64}$ resource_type 是 String 资源类型。 CES -alarm:告警规则,CES-dashboard:dashboard,CES-resourceGroup:资源分组,CES-qualityMonitor:质量监控 最小长度:1 最大长度:32 枚举值: CES-alarm CES-dashboard CES-resourceGroup CES-qualityMonitor
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of Tag objects 租户标签列表 数组长度:0 - 20 表4 Tag 参数 参数类型 描述 key String 键;最大长度128个unicode字符。 key不能为空。 最小长度:0 最大长度:128 values Array of strings 值列表; 每个值最大长度255个unicode字符。如果values为空列表,则表示查询任意value 最小长度:0 最大长度:255 数组长度:0 - 20 状态码: 404 表5 响应Body参数 参数 参数类型 描述 http_code Integer Http状态码。200::OK,404:资源不存在。 最小值:3 最大值:3 枚举值: 200 404 message GoAPIErrorResponseMsg object 错误信息 表6 GoAPIErrorResponseMsg 参数 参数类型 描述 details String 错误信息 最小长度:0 最大长度:1024 code String 业务错误码 最小长度:1 最大长度:16