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":{"AllowedAddressPair":{"description":"","properties":{"ip_address":{"description":"功能说明:IP地址约束:不支持0.0.0.0如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组。","type":"string"},"mac_address":{"description":"功能说明:MAC地址","type":"string"}}},"CreateSubNetworkInterfaceOption":{"description":"","properties":{"allowed_address_pairs":{"description":"1. 扩展属性:IP/Mac对列表,allowed_address_pair参见“allowed_address_pair对象”\n2. 使用说明: IP地址不允许为 “0.0.0.0”如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组硬件SDN环境不支持ip_address属性配置为CIDR格式。","items":{"$ref":"#/definitions/AllowedAddressPair","description":""},"type":"array"},"description":{"description":"功能说明:辅助弹性网卡的描述信息\n取值范围:0-255个字符,不能包含“<”和“>”","type":"string","x-admin":"False","x-internal":"False"},"ipv6_enable":{"description":"功能说明:辅助弹性网卡是否启用ipv6地址\n取值范围:true(开启),false(关闭)\n默认值:false","type":"boolean","x-admin":"False","x-internal":"False"},"ipv6_ip_address":{"description":"功能说明:辅助弹性网卡的IPv6地址\n取值范围:不填则随机分配","type":"string","x-admin":"False","x-internal":"False"},"parent_id":{"description":"功能说明:宿主网络接口的ID\n取值范围:标准UUID\n约束:必须是实际存在的端口ID","type":"string","x-admin":"False","x-internal":"False"},"private_ip_address":{"description":"功能说明:辅助弹性网卡的私有IPv4地址\n取值范围:必须在虚拟子网的网段内,不填则随机在虚拟子网网段内随机分配","type":"string","x-admin":"False","x-internal":"False"},"project_id":{"description":"功能说明:辅助弹性网卡所属的项目ID\n取值范围:标准UUID\n约束:只有管理员有权限指定","type":"string","x-admin":"False","x-internal":"False"},"security_groups":{"description":"功能说明:安全组的ID列表;例如:\"security_groups\": [\"a0608cbf-d047-4f54-8b28-cd7b59853fff\"]\n取值范围:默认值为系统默认安全组","items":{"description":"","type":"string"},"type":"array","x-huawei-extraAnnotation":""},"virsubnet_id":{"description":"功能说明:虚拟子网ID\n取值范围:标准UUID","type":"string","x-huawei-extraAnnotation":""},"vlan_id":{"description":"功能说明:辅助弹性网卡的VLAN ID\n取值范围:1-4094\n约束:同一个宿主网络接口下唯一","type":"string","x-huawei-extraAnnotation":""}},"required":["parent_id","virsubnet_id"]},"CreateSubNetworkInterfaceRequestBody":{"description":"This is a auto create Body Object","properties":{"dry_run":{"description":"功能说明:是否只预检此次请求\n取值范围:\n-true:发送检查请求,不会创建辅助弹性网卡。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回响应码202。\n-false(默认值):发送正常请求,并直接创建辅助弹性网卡。","type":"boolean","x-admin":"False","x-internal":"False"},"sub_network_interface":{"$ref":"#/definitions/CreateSubNetworkInterfaceOption","description":"创建辅助弹性网卡请求体对象","x-admin":"False","x-internal":"False"}},"required":["sub_network_interface"]},"CreateSubNetworkInterfaceResponseBody":{"description":"This is a auto create Response Object","properties":{"request_id":{"description":"请求ID","type":"string","x-admin":"False","x-internal":"False"},"sub_network_interface":{"$ref":"#/definitions/SubNetworkInterface","description":"辅助弹性网卡的响应体","x-admin":"False","x-internal":"False"}},"required":["request_id","sub_network_interface"]},"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"]},"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"]},"SubNetworkInterface":{"description":"","properties":{"allowed_address_pairs":{"description":"1. 扩展属性:IP/Mac对列表,allowed_address_pair参见“allowed_address_pair对象”\n2. 使用说明: IP地址不允许为 “0.0.0.0”如果allowed_address_pairs配置地址池较大的CIDR(掩码小于24位),建议为该port配置一个单独的安全组硬件SDN环境不支持ip_address属性配置为CIDR","items":{"$ref":"#/definitions/AllowedAddressPair"},"type":"array"},"created_at":{"description":"功能说明:辅助弹性网卡的创建时间\n取值范围:UTC时间格式:yyyy-MM-ddTHH:mm:ss","format":"date-time","type":"string","x-admin":"False","x-internal":"False"},"description":{"description":"功能说明:辅助弹性网卡的描述信息\n取值范围:0-255个字符,不能包含“<”和“>”","type":"string","x-admin":"False","x-internal":"False"},"id":{"description":"功能说明:辅助弹性网卡的唯一标识\n取值范围:带(-)的标准UUID","type":"string","x-admin":"False","x-internal":"False"},"instance_id":{"description":"功能说明:辅助弹性网卡所属实例ID,例如RDS实例ID","type":"string"},"instance_type":{"description":"功能说明:辅助弹性网卡所属实例类型,例如“RDS”","type":"string"},"ipv6_ip_address":{"description":"功能说明:辅助弹性网卡的IPv6地址","type":"string","x-admin":"False","x-internal":"False"},"mac_address":{"description":"功能说明:辅助弹性网卡的mac地址\n取值范围:合法的mac地址,系统随机分配","type":"string","x-admin":"False","x-internal":"False"},"parent_device_id":{"description":"功能说明:设备ID\n取值范围:标准UUID","type":"string","x-admin":"False","x-internal":"False"},"parent_id":{"description":"功能说明:宿主网络接口的ID\n取值范围:标准UUID","type":"string","x-admin":"False","x-internal":"False"},"private_ip_address":{"description":"功能说明:辅助弹性网卡的私有IPv4地址\n取值范围:必须在虚拟子网的网段内,不填则随机在虚拟子网网段内随机分配","type":"string","x-admin":"False","x-internal":"False"},"project_id":{"description":"功能说明:辅助弹性网卡所属项目ID","type":"string","x-admin":"False","x-internal":"False"},"scope":{"description":"功能说明:辅助弹性网卡所在站点的公网出口信息","type":"string"},"security_enabled":{"description":"功能说明:辅助弹性网卡安全使能标记,如果不使能则安全组不生效。\n取值范围:true(使能),false(不使能)","type":"boolean","x-admin":"False","x-internal":"False"},"security_groups":{"description":"功能说明:安全组的ID列表;例如:\"security_groups\": [\"a0608cbf-d047-4f54-8b28-cd7b59853fff\"]\n取值范围:默认值为系统默认安全组","items":{"description":"","type":"string"},"type":"array","x-admin":"False","x-internal":"False"},"state":{"description":"功能说明:辅助弹性网卡当前状态","type":"string"},"tags":{"description":"功能说明:辅助弹性网卡的标签列表","items":{"$ref":"#/definitions/ResourceTag","description":""},"type":"array","x-admin":"False","x-internal":"False"},"virsubnet_id":{"description":"功能说明:虚拟子网ID\n取值范围:标准UUID","type":"string","x-admin":"False","x-internal":"False"},"vlan_id":{"description":"功能说明:辅助弹性网卡的VLAN ID\n取值范围:1-4094\n约束:同一个宿主网络接口下唯一","format":"int32","type":"integer","x-admin":"False","x-internal":"False"},"vpc_id":{"description":"功能说明:辅助弹性网卡所属的VPC_ID\n取值范围:标准UUID","type":"string","x-admin":"False","x-internal":"False"}},"required":["created_at","description","id","ipv6_ip_address","mac_address","parent_device_id","parent_id","private_ip_address","project_id","security_groups","tags","virsubnet_id","vlan_id","vpc_id","security_enabled","allowed_address_pairs","state","instance_id","instance_type","scope"]}},"description":null,"group_id":"4784d190da9948c381c1603ddda2f4ff","host":"vpc.cn-north-4.myhuaweicloud.com","id":"4fb777b52bbe4b22816a0008b1a6b4f2","info_version":"v3","method":"post","name":"CreateSubNetworkInterface","parameters":{},"paths":{"/v3/{project_id}/vpc/sub-network-interfaces":{"post":{"consumes":[],"deprecated":false,"description":"创建辅助弹性网卡","operationId":"CreateSubNetworkInterface","parameters":[{"description":"This is a auto create Body Object","in":"body","name":"CreateSubNetworkInterfaceRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateSubNetworkInterfaceRequestBody"}},{"description":"用户Token。\n获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-order":1},{"description":"项目ID","in":"path","name":"project_id","pattern":"[0-9a-fA-F]{32}","required":true,"type":"string","x-order":2}],"produces":[],"responses":{"201":{"description":"Created","examples":{"application/json":{"request_id":"ceb6273e-1ec9-4168-ac11-3dfeaacfc889","sub_network_interface":{"created_at":"2020-05-19T01:16:25","description":null,"id":"2be868f2-f7c9-48db-abc0-eea0b9105b0d","ipv6_ip_address":null,"mac_address":"fa:16:3e:48:f8:6f","parent_device_id":"1ab01f1d-4ef7-4d83-82be-802b3aca0223","parent_id":"637748df-2986-4350-8303-95d259580fb3","private_ip_address":"10.0.0.225","project_id":"8c6fb137a48a428aaf9a0229dca4edb3","security_groups":["6727c950-9f01-47a2-a7aa-7d3686c4c95b"],"tags":[],"virsubnet_id":"08278e6c-61ca-46c1-9fc3-0d4f6c12f193","vlan_id":2787,"vpc_id":"63b97e6b-3598-430f-9eb8-1caf06937be8"}}},"schema":{"$ref":"#/definitions/CreateSubNetworkInterfaceResponseBody"}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ErrorResp"}},"401":{"description":"Unauthorized","schema":{"$ref":"#/definitions/ErrorResp"}},"403":{"description":"Forbidden","schema":{"$ref":"#/definitions/ErrorResp"}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ErrorResp"}},"500":{"description":"Internal Server Error","schema":{"$ref":"#/definitions/ErrorResp"}}},"summary":"创建辅助弹性网卡","tags":["辅助弹性网卡"],"x-apiexplorer-hide":"false","x-constraint":"","x-first-open-time":"","x-hybridcloud":"false","x-is-registered":"Y","x-name":"创建辅助弹性网卡","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso","x-order":23,"x-publishpath":"","x-request-examples-1":{"sub_network_interface":{"parent_id":"637748df-2986-4350-8303-95d259580fb3","security_groups":["6727c950-9f01-47a2-a7aa-7d3686c4c95b"],"virsubnet_id":"08278e6c-61ca-46c1-9fc3-0d4f6c12f193"}},"x-request-examples-description-1":"创建辅助弹性网卡","x-request-examples-text-1":"{\n    \"sub_network_interface\": {\n        \"virsubnet_id\": \"08278e6c-61ca-46c1-9fc3-0d4f6c12f193\",\n        \"parent_id\": \"637748df-2986-4350-8303-95d259580fb3\",\n        \"security_groups\": [\n            \"6727c950-9f01-47a2-a7aa-7d3686c4c95b\"\n        ]\n    }\n}","x-request-examples-url-1":"POST https://{Endpoint}/v3/8c6fb137a48a428aaf9a0229dca4edb3/vpc/sub-network-interfaces","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":"辅助弹性网卡","uri":null,"version":"2.0"}