huawei-cloud-api-definitions-NAT 0.1.20250307

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"BatchOperateResourceTagsRequestBody":{"description":"批量添加删除的请求体。","properties":{"action":{"description":"功能说明:操作标识。\n取值范围:\ncreate(创建)\ndelete(删除)","enum":["create","delete"],"type":"string","x-huawei-extraAnnotation":""},"tags":{"description":"标签列表。","items":{"$ref":"#/definitions/Tag","description":""},"maxItems":10,"minItems":1,"type":"array","x-huawei-extraAnnotation":""}},"required":["action","tags"]},"Tag":{"description":"","properties":{"key":{"description":"键。最大长度128个unicode字符。key不能为空。","maxLength":128,"minLength":1,"type":"string"},"value":{"description":"值。每个值最大长度255个unicode字符。","maxLength":255,"minLength":0,"type":"string"}},"required":["key","value"],"x-huawei-extraAnnotation":""}},"description":null,"group_id":"69ed306c85e24c1eb4496ff482cbca90","host":"nat.cn-north-4.myhuaweicloud.com","id":"d886c94888e649e5b1efad0f70ebdcb2","info_version":"v2","method":"post","name":"BatchCreateDeleteTransitIpTags","parameters":{},"paths":{"/v3/{project_id}/transit-ips/{resource_id}/tags/action":{"post":{"consumes":[],"deprecated":false,"description":"- 为指定中转IP实例批量添加或删除标签\n- 标签管理服务需要使用该接口批量管理中转IP实例的标签。\n- 一个中转IP上最多有10个标签。","operationId":"BatchCreateDeleteTransitIpTags","parameters":[{"description":"项目的ID。","in":"path","maxLength":32,"minLength":1,"name":"project_id","required":true,"type":"string","x-order":1},{"description":"中转IP的ID。","in":"path","maxLength":36,"minLength":36,"name":"resource_id","required":true,"type":"string","x-order":3},{"description":"用户Token。\n用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。\n请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","maxLength":10240,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-order":4},{"description":"批量添加删除中转IP的请求体。","in":"body","name":"BatchCreateDeleteTransitIpTagsRequestBody","required":true,"schema":{"$ref":"#/definitions/BatchOperateResourceTagsRequestBody"}}],"produces":[],"responses":{"204":{"description":"批量添加或删除操作成功。"}},"summary":"批量添加删除中转IP标签","tags":["中转IP标签管理"],"x-apiErrorCodes":[{"errorCode":"400","errorDescription":"Bad Request","errorDescriptionEn":"Bad Request","errorMessage":"","httpStatus":"400","solution":"","solutionEn":""},{"errorCode":"401","errorDescription":"Unauthorized","errorDescriptionEn":"Unauthorized","errorMessage":"","httpStatus":"401","solution":"","solutionEn":""},{"errorCode":"403","errorDescription":"Forbidden","errorDescriptionEn":"Forbidden","errorMessage":"","httpStatus":"403","solution":"","solutionEn":""},{"errorCode":"404","errorDescription":"Not Found","errorDescriptionEn":"Not Found","errorMessage":"","httpStatus":"404","solution":"","solutionEn":""},{"errorCode":"500","errorDescription":"Internal Server Error","errorDescriptionEn":"Internal Server Error","errorMessage":"","httpStatus":"500","solution":"","solutionEn":""}],"x-apiexplorer-hide":"","x-constraint":"此接口为幂等接口:\n- 创建时如果请求体中存在重复key则报错。\n- 创建时,不允许设置重复key数据,如果数据库已存在该key,就覆盖value的值。\n- 删除时,如果删除的标签不存在,默认处理成功,删除时不对标签字符集范围做校验。\n- 删除时tags结构体不能缺失,key不能为空,或者空字符串。","x-first-open-time":"","x-hybridcloud":"","x-is-registered":"Y","x-name":"批量添加删除中转IP标签","x-obc":"Y","x-open-region-cloud":"hc,hk","x-order":5,"x-publishpath":"","x-request-examples-1":{"action":"create","tags":[{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}]},"x-request-examples-2":{"action":"delete","tags":[{"key":"key1","value":"value1"},{"key":"key2","value":"value2"}]},"x-request-examples-description-1":"批量添加中转IP标签。","x-request-examples-description-2":"批量删除中转IP标签。","x-request-examples-text-1":"{\n\t\"action\": \"create\",\n\t\"tags\": [{\n\t\t\t\"key\": \"key1\",\n\t\t\t\"value\": \"value1\"\n\t\t},\n\t\t {\n\t\t\t\"key\": \"key2\",\n\t\t\t\"value\": \"value2\"\n\t\t}\n\t]\n}\n","x-request-examples-text-2":"{\n\t\"action\": \"delete\",\n\t\"tags\": [{\n\t\t\t\"key\": \"key1\"\n\t\t,\n\t\t\t\"value\": \"value1\"\n\t\t},\n\t\t{\n\t\t\t\"key\": \"key2\",\n\t\t\t\"value\": \"value2\"\n\t\t}\n\t]\n}","x-request-examples-url-1":"POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/action","x-request-examples-url-2":"POST  https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/transit-ips/56121618-fb0a-4a51-aff0-e2eb9cba4c73/tags/action","x-scope":"Commercial","x-source":"","x-support-sdk":"Y","x-version":"v3"}}},"product_short":"NAT","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"批量添加删除中转IP标签","tags":"中转IP标签管理","uri":null,"version":"2.0"}