云服务器内容精选

  • URI GET /v1/{project_id}/pools/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定每一页查询返回的最大条目数,默认为200。 offset 否 Integer 分页列表的起始页,默认为0。
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 tags Array of PoolTag objects 资源标签的列表。 表4 PoolTag 参数 参数类型 描述 key String 资源类型的标签 values Array of strings 资源类型的标签值 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码:403 表7 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。
  • 标签命名规则 每个标签由一对键值对(Key-Value)组成。 每个 数据加密 服务资源最多可以添加20个标签。 对于每个资源,每个标签键(Key)都必须是唯一的,每个标签键(Key)只能有一个值(Value)。 标签共由两部分组成:“标签键”和“标签值”,其中,“标签键”和“标签值”的命名规则如表 标签参数说明所示。 标签以键值对的形式表示,用于标识存储库,便于对存储库进行分类和搜索。此处的标签仅用于存储库的过滤和管理。一个存储库最多添加10个标签。 如您的组织已经设定数据加密服务的相关标签策略,则需按照标签策略规则为密钥、凭据等添加标签。标签如果不符合标签策略的规则,则可能会导致密钥、凭据创建失败,请联系组织管理员了解标签策略详情。 表1 标签参数说明 参数 规则 样例 标签键 必填。 对于同一个自定义密钥,标签键唯一。 长度不超过128个字符。 首尾不能包含空格。 不能以_sys_开头。 可以包含以下字符: 中文 英文 数字 空格 特殊字符_.:=+-@ cost 标签值 可以为空。 长度不超过255个字符。 可以包含以下字符: 中文 英文 数字 空格 特殊字符_.:=+-@ 100
  • 响应参数 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of TmsTag objects 标签列表。 表4 TmsTag 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。 两头不能有空白字符。 value 否 String 值。每个值最大长度255个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @。
  • 响应参数 状态码:200 表3 响应Body参数 参数 参数类型 描述 tags Array of TmsTagValues objects 标签列表。 表4 TmsTagValues 参数 参数类型 描述 key String 键,最大长度128个unicode字符。 values Array of strings 值列表。 状态码:400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。 状态码:503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码,失败时返回。 error_msg String 错误描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识。取值: create,表示添加标签。 delete,表示删除标签。 tags 是 Array of BatchTagActionTagOption objects 标签列表。 表4 BatchTagActionTagOption 参数 是否必选 参数类型 描述 key 是 String 标签键。最大长度128个unicode字符,不能为null或者空字符串,不能为空格,校验和使用之前会自动过滤掉前后空格。 字符集:0-9,A-Z,a-z,“_”,“-”,中文。 value 否 String 标签值。最大长度255个unicode字符,可以为空字符串。 字符集:0-9,A-Z,a-z,“_”,“.”,“-”,中文。 “action”值为“create”时,该参数必选。 “action”值为“delete”时,该参数可选。 说明: 删除标签时,如果value有值,则按照key/value匹配删除;如果value没有值,则按照key删除。
  • 请求示例 URI样例 POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags/action 添加2个标签 { "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] } 删除2个标签 { "action" : "delete", "tags" : [ { "key" : "key1" }, { "key" : "key2", "value" : "value3" } ] }
  • 接口约束 该接口支持如下数据库实例: GeminiDB Cassandra GeminiDB Mongo GeminiDB Influx GeminiDB Redis 一个数据库实例具有20个标签配额,且标签key唯一。 添加标签时,如果请求体中存在重复key,调用该接口将会报错。 添加标签时,如果请求体中的key与指定实例已有的key重复,将会覆盖已有key对应的value的值。 如果待删除的标签不存在,调用该接口将默认处理成功,删除时,不对标签字符集范围做校验。
  • 请求消息 请求参数如表2所示。 表2 请求参数 参数 是否必选 参数类型 描述 tags 是 Array of objects 标签列表,详情参见表3 action 是 String 操作标识(仅支持小写):create(创建) 表3 tags 字段数据结构说明 参数 是否必选 参数类型 描述 key 是 String 键。 不能为空。 对于同一资源键值唯一。 长度不超过36个字符。 标签的键必须唯一且输入不能为空。 value 是 String 值。 长度不超过43个字符。
  • 请求示例 批量添加2组标签到指定云服务器。 POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/tags/action { "action": "create", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value3" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String 请求状态 message String 请求失败原因 result LabelEntity object 标签详情 表4 LabelEntity 参数 参数类型 描述 id String 标签id label_type String 标签所属工作项类型,对应工作项的type字段 color String 标签颜色RGB title String 标签标题
  • 响应示例 状态码: 200 OK { "status" : "success", "message" : "ok", "result" : { "id" : "1030868827803529217", "label_type" : "requirement", "color" : "#A6DD82", "title" : "Tag-IR-05" } }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 label_type 是 String 标签归属的工作项分类,不传该参数时默认查询所有类型下的标签。作为更新参数时无效。 feature:特性 raw requirement:原始需求 requirement:研发需求 task:任务 bug:缺陷 color 是 String 标签颜色,作为更新参数时非必填。可选颜色代码:"#86CAFF", "#6DDEBB", "#A6DD82", "#FAC20A", "#FA9841", "#F66F6A", "#F3689A", "#A97AF8", "#71757F", "#5E7CE0", "#207AB3", "#169E6C", "#6CA83B", "#B58200", "#B54E04", "#B02121", "#AD215B", "#572DB3", "#4F4F4F", "#3C51A6" title 是 String 标签标题,最长支持15个字符。作为更新参数时非必填
  • URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/addTag 表1 路径参数 参数 是否必选 参数类型 描述 identifier 是 String 参数解释: 应用唯一标识。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 modelName 是 String 参数解释: 数据模型的英文名称。 约束限制: 不涉及。 取值范围: 大写字母开头,只能包含字母、数字、“_”,且长度为[1-60]个字符。 默认取值: 不涉及。