云服务器内容精选

  • 请求参数 表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的值。 如果待删除的标签不存在,调用该接口将默认处理成功,删除时,不对标签字符集范围做校验。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of ResourceTagObject objects 资源标签对列表 表4 ResourceTagObject 参数 参数类型 描述 resource_id String 资源ID,不同资源(节点,部署,配置项,密钥)有不同的资源ID key String 标签键,最大长度36个字符。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_” value String 标签值,每个值最大长度43个字符,删除时如果value有值按照key/value删除,如果value没值,则按照key删除。不能为空,只能包含大小写字母,数字,中划线“-”,下划线“_”
  • 请求示例 查询某种资源类型的所有标签 GET https://{endpoint}/v3/{project_id}/tag-mgr/{resource_type}/tags Request Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  • 响应示例 状态码: 200 请求成功 { "tags" : [ { "resource_id" : "hilens-5b54c065e57c47e0bb44291a07371dd8", "value" : "v1", "key" : "k1" }, { "resource_id" : "hilens-8c6d32ab93ba49e9b8d149dbfd410e7f", "value" : "v2", "key" : "k3" }, { "resource_id" : "hilens-19a27038ee2f437ab41241a64a907589", "value" : "v3", "key" : "k3" }, { "resource_id" : "hilens-0cbda3fa887a4e00ad1fe82453b671e1", "value" : "v4", "key" : "k4" } ] }
  • 响应参数 状态码: 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 /v1/{project_id}/pools/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定每一页查询返回的最大条目数,默认为200。 offset 否 Integer 分页列表的起始页,默认为0。
  • 响应消息 参数说明 表5 参数说明 名称 参数类型 描述 instances Array of objects 实例列表。详情请参见表6。 total_count Integer 总记录数。 表6 instance字段数据结构说明 名称 参数类型 描述 instance_id String 实例ID,可以调用“查询实例列表”接口获取。如果未申请实例,可以调用“创建实例”接口创建。 instance_name String 实例名称。 tags Array of objects 标签列表。如果没有标签,默认为空数组。详情请参见表7。 表7 tags字段数据结构说明 名称 参数类型 描述 key String 标签键。 key不能为空,长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @。 _sys_开头属于系统标签,租户不能输入。 字符集:0-9,A-Z,a-z,“_”,“-”,中文。 value String 标签值。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @。 可以为空(empty or null),长度0~255个半角字符。 字符集:0-9,A-Z,a-z,“_”,“.”,“-”,中文。 响应示例 根据标签返回指定实例: { "instances": [ { "instance_id": "2acbf2223caf3bac3c33c6153423c3ccin02", "instance_name": "test-single", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value1" } ] } ] } 返回总记录数: { "total_count": 4 }
  • 请求示例 根据标签,按实例名称查询1~100条指定实例信息 { "offset": "100", "limit": "100", "action": "filter", "matches": [ { "key": "instance_name", "value": "test-single" } ], "tags": [ { "key": "key1", "values": [ "value1", "value2" ] } ] } 按照实例名称或按实例ID查询总记录数 { "action": "count", "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "instance_name", "value": "test-single" }, { "key": "instance_id", "value": "958693039f284d6ebfb177375711072ein02" } ] }
  • 请求消息 参数说明 表2 参数说明 名称 参数类型 是否必选 描述 offset String 否 索引位置偏移量,表示从第一条数据偏移offset条数据后开始查询。 “action”值为“count”时,不传该参数。 “action”值为“filter”时,取值必须为数字,不能为负数。默认取0值,表示从第一条数据开始查询。 limit String 否 查询记录数。 “action”值为“count”时,不传该参数。 “action”值为“filter”时,取值范围:1~100。不传该参数时,默认查询前100条实例信息。 action String 是 操作标识。 取值为“filter”,表示根据标签过滤条件查询实例。 取值为“count”,表示仅返回总记录数,禁止返回其他字段。 matches Array of objects 否 搜索字段。 该字段值为空,表示不按照实例名称或实例ID查询。 该字段值不为空,具体值请参见表4。 tags Array of objects 否 包含标签,最多包含20个key。详情请参见表3。 表3 tags字段数据结构说明 名称 参数类型 是否必选 描述 key String 是 标签键。 key不能为空,长度1~128个半角字符。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @。 _sys_开头属于系统标签,租户不能输入。 说明: 搜索时不对该参数做字符集校验。 values Array of strings 是 标签值列表。 可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : / = + - @。 可以为空(empty or null),长度0~255个半角字符。 如果values为空列表,则表示查询任意value。value之间为或的关系。 表4 matches字段数据结构说明 名称 参数类型 是否必选 描述 key String 是 取值为“instance_name”或“instance_id”,分别表示按实例名称或按实例ID匹配查询。 value String 是 待匹配的实例名称或实例ID,可以调用“查询实例列表”接口获取。如果未申请实例,可以调用“创建实例”接口创建。
  • 响应示例 状态码: 400 Bad Request { "error_code" : "common.01000001", "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"} 状态码: 401 Unauthorized { "error_code": 'APIG.1002', "error_msg": 'Incorrect token or token resolution failed'} 状态码: 403 Forbidden { "error" : { "code" : "403", "message" : "X-Auth-Token is invalid in the request", "error_code" : null, "error_msg" : null, "title" : "Forbidden" }, "error_code" : "403", "error_msg" : "X-Auth-Token is invalid in the request", "title" : "Forbidden"} 状态码: 404 Not Found { "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404"} 状态码: 408 Request Timeout { "error_code" : "common.00000408", "error_msg" : "timeout exception occurred"} 状态码: 500 Internal Server Error { "error_code" : "common.00000500", "error_msg" : "internal error0"}
  • 响应参数 状态码: 200 表5 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,定位辅助信息。 状态码: 204 表6 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,定位辅助信息。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 common_error_code String CBC公共错误码。 solution_msg String 解决方案描述。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 租户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of ResourceTag objects 标签列表。 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 键。 value 否 String 值。
  • URI PUT /v1/{project_id}/instances/{instance_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。获取方法,请参见获取项目ID。 instance_id 是 String LakeFormation实例ID。创建实例时自动生成。例如:2180518f-42b8-4947-b20b-adfc53981a25。