云服务器内容精选

  • URI DELETE /v3/{project_id}/firewalls/{firewall_id}/tags/{tag_key} 表1 路径参数 参数 是否必选 参数类型 描述 firewall_id 是 String 功能说明:ACL唯一标识 取值范围:合法UUID 约束:ID对应的ACL必须存在 project_id 是 String 项目ID tag_key 是 String 功能说明:标签键
  • 响应参数 状态码: 400 表2 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码: 401 表3 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码: 403 表4 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码: 404 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID。 error_msg String 错误消息。 error_code String 错误码。
  • 请求参数 表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个字符。作为更新参数时非必填
  • 响应参数 状态码: 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" } }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,可通过如何获取用户Token获取 表4 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of CreateTag objects 创建防火墙标签列表 表5 CreateTag 参数 是否必选 参数类型 描述 key 否 String 标签键 value 否 String 标签值
  • URI PUT /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/save 表1 路径参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙ID,可通过防火墙ID获取方式获取 project_id 是 String 项目ID,可以从调API处获取,也可以从控制台获取。可通过项目ID获取方式获取 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,可通过如何获取企业项目ID获取,用户未开启企业项目时为0
  • 请求示例 保存项目id为408972e72dcd4c1a9b033e955802a36b的防火墙资源标签,防火墙id为e743cfaf-8164-4807-aa13-d893d83313cf,企业项目id为fb55459c-41b3-47fc-885d-540946fddda4。请求体中包含两个标签,分别为key:test、value:1和key:tag_zjw-1、value:1。 https://{Endpoint}/v2/408972e72dcd4c1a9b033e955802a36b/cfw-cfw/e743cfaf-8164-4807-aa13-d893d83313cf/tags/save?fw_instance_id=e743cfaf-8164-4807-aa13-d893d83313cf&enterprise_project_id=fb55459c-41b3-47fc-885d-540946fddda4 { "tags" : [ { "key" : "test", "value" : "1" }, { "key" : "tag_zjw-1", "value" : "1" } ] }
  • 请求参数 表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的值。 如果待删除的标签不存在,调用该接口将默认处理成功,删除时,不对标签字符集范围做校验。
  • 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 具体错误信息。
  • URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 instance_id 是 实例ID。
  • 响应参数 状态码: 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 错误描述。