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":{"CreateSecurityGroupRuleOption":{"description":"","properties":{"action":{"description":"功能说明:安全组规则生效策略\n取值范围:allow 允许,deny 拒绝\n约束:默认值为allow","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"description":{"description":"功能说明:安全组的描述信息\n取值范围:0-255个字符,不能包含“<”和“>”","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"direction":{"description":"功能说明:安全组规则的出入控制方向\n取值范围:ingress 表示入方向;egress 表示出方向","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"enabled":{"description":"功能说明:是否启用安全组规则。\n取值范围:true, false。\n约束:默认值为true。","type":"boolean","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk"},"ethertype":{"description":"功能说明:IP地址协议类型\n取值范围:IPv4,IPv6\n约束:不填默认值为IPv4","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"multiport":{"description":"功能说明:端口取值范围\n取值范围:支持单端口(80),连续端口(1-30)以及不连续端口(22,3389,80)\n约束:端口值的范围1~65535","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"priority":{"description":"功能说明:规则在安全组中的优先级\n取值范围:1~100,1代表最高优先级\n约束:默认值为100","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"protocol":{"description":"功能说明:协议类型\n取值范围:icmp、tcp、udp、icmpv6或IP协议号(0~255)\n约束:为空表示支持所有协议。协议为icmpv6时,网络类型应该为IPv6;协议为icmp时,网络类型应该为IPv4","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"remote_address_group_id":{"description":"功能说明:远端地址组ID\n取值范围:租户下存在的地址组ID\n约束:与remote_ip_prefix,remote_group_id功能互斥","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"remote_group_id":{"description":"功能说明:远端安全组ID,表示该安全组内的流量允许或拒绝\n取值范围:租户下存在的安全组ID\n约束:与remote_ip_prefix,remote_address_group_id功能互斥","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"remote_ip_prefix":{"description":"功能说明:远端IP地址,当direction是egress时为虚拟机访问端的地址,当direction是ingress时为访问虚拟机的地址\n取值范围:IP地址,或者cidr格式\n约束:与remote_group_id、remote_address_group_id互斥","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"security_group_id":{"description":"功能说明:安全组规则所属的安全组ID","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"}},"required":["direction","security_group_id"]},"CreateSecurityGroupRuleRequestBody":{"description":"This is a auto create Body Object","properties":{"dry_run":{"description":"功能说明:是否只预检此次请求\n取值范围:\n-true:发送检查请求,不会创建安全组规则。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回响应码202。\n-false(默认值):发送正常请求,并直接创建安全组规则。","type":"boolean"},"security_group_rule":{"$ref":"#/definitions/CreateSecurityGroupRuleOption","description":"创建安全组规则的请求体"}},"required":["security_group_rule"]},"CreateSecurityGroupRuleResponseBody":{"description":"This is a auto create Response Object","properties":{"request_id":{"description":"请求ID","type":"string"},"security_group_rule":{"$ref":"#/definitions/SecurityGroupRule","description":"创建安全组规则的响应体"}},"required":["request_id","security_group_rule"]},"SecurityGroupRule":{"description":"","properties":{"action":{"description":"功能说明:安全组规则生效策略\n取值范围:allow 允许,deny 拒绝\n约束:默认值为deny","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"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,hcso,sbc"},"description":{"description":"功能说明:安全组的描述信息\n取值范围:0-255个字符,不能包含“<”和“>”","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"direction":{"description":"功能说明:安全组规则的出入控制方向\n取值范围:ingress 表示入方向;egress 表示出方向","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"enabled":{"description":"功能说明:是否启用安全组规则。\n取值范围:true, false。\n约束:默认值为true。","type":"boolean","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk"},"ethertype":{"default":"IPv4","description":"功能说明:IP地址协议类型\n取值范围:IPv4,IPv6\n约束:不填默认值为IPv4","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"id":{"description":"功能描述:安全组规则对应的唯一标识\n取值范围:带“-”的标准UUID格式","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"multiport":{"description":"功能说明:端口取值范围\n取值范围:支持单端口(80),连续端口(1-30)以及不连续端口(22,3389,80)","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"priority":{"description":"功能说明:优先级\n取值范围:1~100,1代表最高优先级","format":"int32","type":"integer","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"project_id":{"description":"功能说明:安全组规则所属项目ID","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"protocol":{"description":"功能说明:协议类型\n取值范围:icmp、tcp、udp、icmpv6或IP协议号\n约束:为空表示支持所有协议。协议为icmpv6时,网络类型应该为IPv6;协议为icmp时,网络类型应该为IPv4","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"remote_address_group_id":{"description":"功能说明:远端地址组ID\n取值范围:租户下存在的地址组ID\n约束:与remote_ip_prefix,remote_group_id功能互斥","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"remote_group_id":{"description":"功能说明:远端安全组ID,表示该安全组内的流量允许或拒绝\n取值范围:租户下存在的安全组ID\n约束:与remote_ip_prefix,remote_address_group_id功能互斥","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"remote_ip_prefix":{"description":"功能说明:远端IP地址,当direction是egress时为虚拟机访问端的地址,当direction是ingress时为访问虚拟机的地址\n取值范围:IP地址,或者cidr格式\n约束:与remote_group_id、remote_address_group_id互斥","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"security_group_id":{"description":"功能说明:安全组规则所属的安全组ID","type":"string","x-admin":"False","x-internal":"False","x-open-region-cloud":"hc,hk,otc,tlf,ctc,hcso,sbc,obc"},"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,hcso,sbc"}},"required":["action","created_at","description","direction","enabled","ethertype","id","multiport","priority","project_id","protocol","remote_address_group_id","remote_group_id","remote_ip_prefix","security_group_id","updated_at"]}},"description":null,"group_id":"4784d190da9948c381c1603ddda2f4ff","host":"vpc.cn-north-4.myhuaweicloud.com","id":"8dfc66e9af33415aa9ff077d6aa7047e","info_version":"v3","method":"post","name":"CreateSecurityGroupRule","parameters":{},"paths":{"/v3/{project_id}/vpc/security-group-rules":{"post":{"consumes":[],"deprecated":false,"description":"创建安全组规则","operationId":"CreateSecurityGroupRule","parameters":[{"description":"This is a auto create Body Object","in":"body","name":"CreateSecurityGroupRuleRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateSecurityGroupRuleRequestBody"}},{"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\n获取项目ID,请参见获取项目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":"1666b2708aaf849337572d6846dce781","security_group_rule":{"action":"allow","created_at":"2020-08-13T07:12:36Z","description":"security group rule description","direction":"ingress","enabled":true,"ethertype":"IPv4","id":"f626eb24-d8bd-4d26-ae0b-c16bb65730cb","multiport":"33","priority":1,"project_id":"060576782980d5762f9ec014dd2f1148","protocol":"tcp","remote_address_group_id":null,"remote_group_id":null,"remote_ip_prefix":"10.10.0.0/16","security_group_id":"0552091e-b83a-49dd-88a7-4a5c86fd9ec3","updated_at":"2020-08-13T07:12:36Z"}}},"schema":{"$ref":"#/definitions/CreateSecurityGroupRuleResponseBody"}}},"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":19,"x-publishpath":"","x-request-examples-1":{"security_group_rule":{"action":"allow","description":"security group rule description","direction":"ingress","multiport":"33","priority":1,"protocol":"tcp","remote_ip_prefix":"10.10.0.0/16","security_group_id":"1c8d9f94-6022-4518-bb98-e0145fcc7b33"}},"x-request-examples-description-1":"","x-request-examples-text-1":"{\n\t\"security_group_rule\": {\n\t\t\"security_group_id\": \"1c8d9f94-6022-4518-bb98-e0145fcc7b33\",\n\t\t\"direction\": \"ingress\",\n\t\t\"protocol\": \"tcp\",\n\t\t\"description\": \"security group rule description\",\n\t\t\"action\": \"allow\",\n\t\t\"priority\": 1,\n                \"multiport\": \"33\",\n                \"remote_ip_prefix\": \"10.10.0.0/16\"\n\t}\n}","x-request-examples-url-1":"POST https://{Endpoint}/v3/{project_id}/vpc/security-group-rules","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"}