huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20260619

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"BatchTagActionRequestBody":{"properties":{"action":{"description":"操作标识。取值:\n- create,表示添加标签。\n- delete,表示删除标签。","enum":["create","delete"],"type":"string"},"tags":{"description":"标签列表。","items":{"$ref":"#/definitions/BatchTagActionTagOption"},"type":"array"}},"required":["action","tags"]},"BatchTagActionTagOption":{"properties":{"key":{"description":"标签键。最大长度36个unicode字符,不能为null或者空字符串,不能为空格,校验和使用之前会自动过滤掉前后空格。\n字符集:0-9,A-Z,a-z,“_”,“-”,中文。","type":"string"},"value":{"description":"标签值。最大长度43个unicode字符,可以为空字符串,不能为空格,校验和使用之前会自动过滤掉前后空格。\n字符集:0-9,A-Z,a-z,“_”,“.”,“-”,中文。\n- “action”值为“create”时,该参数必选。\n- “action”值为“delete”时,该参数可选。\n说明:\n删除标签时,如果value有值,则按照key/value匹配删除;如果value没有值,则按照key删除。","type":"string"}},"required":["key"]},"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"eb47d65c39244357bb64ce62a8a961d6","info_version":"v3","method":"post","name":"BatchTagAction","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/tags/action":{"post":{"description":"批量添加或删除指定数据库实例的标签。","operationId":"BatchTagAction","parameters":[{"description":"用户Token。","in":"header","name":"x-auth-token","required":true,"type":"string","x-example":"******"},{"description":"租户在某一region下的project ID。","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"实例ID。","in":"path","name":"instance_id","required":true,"type":"string"},{"description":"请求体。","in":"body","name":"BatchTagActionRequestBody","required":true,"schema":{"$ref":"#/definitions/BatchTagActionRequestBody"}}],"responses":{"200":{"description":"Success."},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"批量添加或删除资源标签","tags":["标签管理"],"x-constraint":"- 该接口支持如下数据库实例。\n  - GeminiDB Cassandra\n  - GeminiDB Mongo副本集4.0\n  - GeminiDB Influx\n  - GeminiDB Redis\n- 一个数据库实例具有20个标签配额,且标签key唯一。\n  - 添加标签时,如果请求体中存在重复key,调用该接口将会报错。\n  - 添加标签时,如果请求体中的key与指定实例已有的key重复,将会覆盖已有key对应的value的值。\n- 如果待删除的标签不存在,调用该接口将默认处理成功,删除时,不对标签字符集范围做校验。该场景下,要求请求体中tags结构体不能缺失,且key不能为空,或者空字符串。","x-is-registered":"N","x-request-examples-1":{"action":"create","tags":[{"key":"key1","values":"value1"},{"key":"key2","values":"value2"}]},"x-request-examples-2":{"action":"delete","tags":[{"key":"key1"},{"key":"key2","values":"value3"}]},"x-request-examples-description-1":"添加标签:","x-request-examples-description-2":"删除标签:","x-request-examples-url-1":"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/afbf982b46ca421e9118f7db916058b5in02/tags/action","x-request-examples-url-2":"POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/afbf982b46ca421e9118f7db916058b5in02/tags/action","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"批量添加或删除资源标签","tags":"标签管理","uri":null,"version":"2.0"}