huawei-cloud-api-definitions-VPC 0.1.20250523

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"AddressGroup":{"properties":{"created_at":{"description":"功能说明:地址组创建时间\n取值范围:UTC时间格式:yyyy-MM-ddTHH:mm:ss;系统自动生成","format":"date-time","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"},"description":{"description":"功能说明:地址组描述信息\n取值范围:0-255个字符\n约束:不能包含“<”和“>”。","maxLength":255,"minLength":0,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"},"enterprise_project_id":{"description":"功能说明:企业项目ID。\n取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。","maxLength":36,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"},"id":{"description":"功能说明:地址组唯一标识\n取值范围:合法UUID的字符串","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"},"ip_extra_set":{"description":"功能说明:地址组包含的地址集及其备注信息","items":{"$ref":"#/definitions/IpExtraSetRespOption","description":""},"type":"array","x-admin":"False","x-internal":"False"},"ip_set":{"description":"功能说明:地址组可包含地址集\n取值范围:可以是单个ip地址,ip地址范围,ip地址cidr\n约束:当前一个地址组ip_set数量限制默认值为20,即配置的ip地址、ip地址范围或ip地址cidr的总数默认限制20","items":{"description":"","type":"string"},"type":"array","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"},"ip_version":{"description":"功能说明:IP地址组ip版本\n取值范围:4, 表示ipv4地址组;6, 表示ipv6地址组","format":"int32","type":"integer","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"},"max_capacity":{"description":"功能说明:地址组最大条目数,限制地址组可以包含的地址数量\n取值范围:0-20\n默认值:20","format":"int32","type":"integer","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"},"name":{"description":"功能说明:地址组名称\n取值范围:0-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)","maxLength":64,"minLength":0,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"},"status":{"description":"功能说明:地址组状态\n取值范围:\n      NORMAL:正常\n      UPDATING:更新中\n      UPDATE_FAILED:更新失败\n默认值:NORMAL\n约束:当地址组处于UPDATING(更新中)状态时,不允许再次更新","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"},"status_message":{"description":"功能说明:地址组状态详情信息","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"},"tags":{"description":"IP地址组资源标签","items":{"$ref":"#/definitions/ResourceTag","description":""},"type":"array","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso"},"tenant_id":{"description":"功能说明:资源所属项目ID","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"},"updated_at":{"description":"功能描述:地址组最近一次更新资源的时间\n取值范围:UTC时间格式:yyyy-MM-ddTHH:mm:ss;系统自动生成","format":"date-time","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc"}},"required":["created_at","description","enterprise_project_id","id","ip_extra_set","ip_set","ip_version","max_capacity","name","status","status_message","tags","tenant_id","updated_at"]},"CreateAddressGroupOption":{"description":"","properties":{"description":{"description":"功能说明:地址组描述信息\n取值范围:0-255个字符,不能包含“<”和“>”。","type":"string","x-admin":"False","x-internal":"False"},"enterprise_project_id":{"default":"0","description":"功能说明:企业项目ID。创建IP地址组时,给IP地址组绑定企业项目ID。\n取值范围:最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。","type":"string","x-admin":"False","x-internal":"False"},"ip_extra_set":{"description":"功能说明:IP地址组包含的IP列表及其备注信息\n约束:ip数量限制默认20, 与ip_set参数只能二选一","items":{"$ref":"#/definitions/IpExtraSetOption","description":""},"type":"array","x-admin":"False","x-internal":"False"},"ip_set":{"description":"功能说明:地址组可包含地址集\n取值范围:可以是单个ip地址,ip地址范围,ip地址cidr\n约束:当前一个地址组ip_set数量限制默认值为20,即配置的ip地址、ip地址范围或ip地址cidr的总数默认限制20","items":{"description":"","type":"string"},"type":"array","x-admin":"False","x-internal":"False"},"ip_version":{"description":"功能说明:地址组ip版本\n取值范围:4, 表示ipv4地址组;6,表示ipv6地址组","format":"int32","type":"integer","x-admin":"False","x-internal":"False"},"max_capacity":{"description":"功能说明:地址组最大条目数,限制地址组可以包含的地址数量\n取值范围:0-20\n默认值:20","format":"int32","type":"integer","x-admin":"False","x-internal":"False"},"name":{"description":"功能说明:地址组名称\n取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)","type":"string","x-admin":"False","x-internal":"False"}},"required":["ip_version","name"]},"CreateAddressGroupRequestBody":{"description":"This is a auto create Body Object","properties":{"address_group":{"$ref":"#/definitions/CreateAddressGroupOption","description":"创建地址组的请求体"},"dry_run":{"description":"功能说明:是否只预检此次请求\n取值范围:\n-true:发送检查请求,不会创建地址组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回响应码202。\n-false(默认值):发送正常请求,并直接创建地址组。","type":"boolean"}},"required":["address_group"]},"CreateAddressGroupResponseBody":{"description":"This is a auto create Response Object","properties":{"address_group":{"$ref":"#/definitions/AddressGroup","description":"创建地址组的响应体"},"request_id":{"description":"请求ID","type":"string"}},"required":["address_group","request_id"]},"ErrorResp":{"description":"","properties":{"error_code":{"description":"错误码","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"error_msg":{"description":"错误消息","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"request_id":{"description":"请求ID","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"}},"required":["error_code","error_msg","request_id"]},"IpExtraSetOption":{"description":"","properties":{"ip":{"description":"功能说明:单个IP地址、IP地址范围或ip地址网段,支持IPv4、IPv6","type":"string","x-admin":"False","x-internal":"False"},"remarks":{"description":"功能说明:IP的备注信息\n取值范围:0-255个字符,不能包含“<”和“>”。","type":"string","x-admin":"False","x-internal":"False"}},"required":["ip"]},"IpExtraSetRespOption":{"description":"","properties":{"ip":{"description":"功能说明:单个IP地址、IP地址范围或ip地址网段,支持IPv4、IPv6","type":"string","x-admin":"False","x-internal":"False"},"remarks":{"description":"功能说明:IP的备注信息\n取值范围:0-255个字符,不能包含“<”和“>”。","type":"string","x-admin":"False","x-internal":"False"}},"required":["ip","remarks"]},"ResourceTag":{"description":"","properties":{"key":{"description":"功能说明:标签键\n约束:同一资源的key值不能重复。","maxLength":128,"minLength":1,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso"},"value":{"description":"功能说明:标签值","maxLength":255,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso"}},"required":["key","value"]}},"description":null,"group_id":"4784d190da9948c381c1603ddda2f4ff","host":"vpc.cn-north-4.myhuaweicloud.com","id":"1450fde0a9f24409a89fe64e7703fe7e","info_version":"v3","method":"post","name":"CreateAddressGroup","parameters":{},"paths":{"/v3/{project_id}/vpc/address-groups":{"post":{"consumes":[],"deprecated":false,"description":"创建地址组","operationId":"CreateAddressGroup","parameters":[{"description":"This is a auto create Body Object","in":"body","name":"CreateAddressGroupRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateAddressGroupRequestBody"}},{"description":"用户Token。\n获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,obc","x-order":1},{"description":"项目ID","in":"path","name":"project_id","pattern":"[0-9a-fA-F]{32}","required":true,"type":"string","x-example":"05137572fa00d5eb2fdcc014b0f5c751","x-order":2}],"produces":[],"responses":{"201":{"description":"地址组创建API的POST操作正常返回","examples":{"application/json":{"address_group":{"created_at":"2019-06-28T02:06:38.000+00:00","description":"test","enterprise_project_id":"0aad99bc-f5f6-4f78-8404-c598d76b0ed2","id":"dd18a501-fcd5-4adc-acfe-b0e2384baf08","ip_extra_set":[{"ip":"192.168.5.0/24"},{"ip":"192.168.3.20-192.168.3.100"},{"ip":"192.168.3.40"},{"ip":"192.168.3.2"}],"ip_set":["192.168.5.0/24","192.168.3.20-192.168.3.100","192.168.3.40","192.168.3.2"],"ip_version":4,"max_capacity":20,"name":"AutoTester746010.580123789","status":"NORMAL","status_message":"","tenant_id":"b2782e6708b8475c993e6064bc456bf8","updated_at":"2019-06-28T02:06:38.000+00:00"},"request_id":"f568db7a-2675-4271-8747-3e3f1c6381ba"}},"schema":{"$ref":"#/definitions/CreateAddressGroupResponseBody"}},"400":{"description":"服务器未能处理请求。","schema":{"$ref":"#/definitions/ErrorResp"}},"401":{"description":"被请求的页面需要用户名和密码。","schema":{"$ref":"#/definitions/ErrorResp"}},"403":{"description":"对被请求页面的访问被禁止。","schema":{"$ref":"#/definitions/ErrorResp"}},"404":{"description":"服务器无法找到被请求的页面。","schema":{"$ref":"#/definitions/ErrorResp"}},"409":{"description":"由于冲突,请求无法被完成。","schema":{"$ref":"#/definitions/ErrorResp"}},"500":{"description":"请求未完成。服务异常。","schema":{"$ref":"#/definitions/ErrorResp"}},"501":{"description":"请求未完成。服务器不支持所请求的功能。","schema":{"$ref":"#/definitions/ErrorResp"}}},"summary":"创建地址组","tags":["IP地址组"],"x-apiexplorer-hide":"false","x-constraint":"当前每租户的地址组配额默认值为50","x-first-open-time":"2019-6-30","x-hybridcloud":"false","x-is-registered":"Y","x-name":"创建地址组","x-open-region-cloud":"hc,hk","x-order":9,"x-publishpath":"","x-request-examples-1":{"address_group":{"description":"test","ip_set":["192.168.3.2","192.168.3.40","192.168.3.20-192.168.3.100","192.168.5.0/24"],"ip_version":4,"name":"AutoTester746010.580123789"}},"x-request-examples-description-1":"创建地址组","x-request-examples-text-1":"{\n    \"address_group\": {\n        \"ip_version\": 4,\n        \"name\": \"AutoTester746010.580123789\",\n        \"ip_set\": [\n            \"192.168.3.2\",\n            \"192.168.3.40\",\n            \"192.168.3.20-192.168.3.100\",\n            \"192.168.5.0/24\"\n        ],\n        \"description\": \"test\"\n    }\n}","x-request-examples-url-1":"POST https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups","x-scope":"Commercial","x-source":"SelfDeveloped","x-support-sdk":"Y","x-version":"v3"}}},"product_short":"VPC","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建地址组","tags":"IP地址组","uri":null,"version":"2.0"}