huawei-cloud-api-definitions-DC 0.1.20250117

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":{"parameters":{"AuthToken":{"description":"用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","name":"X-Auth-Token","required":true,"schema":{"maxLength":10240,"minLength":0,"type":"string"}},"PathByGdgwId":{"description":"全域接入网关ID","in":"path","name":"gdgw_id","required":true,"schema":{"description":"全域接入网关ID","pattern":"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}","type":"string"}},"ProjectId":{"description":"租户项目ID","in":"path","name":"project_id","required":true,"schema":{"maxLength":36,"minLength":0,"pattern":"[a-fA-F0-9]{32}","type":"string"}}},"schemas":{"AddGdgwRouteAction":{"allOf":[{"properties":{"type":{"$ref":"#/components/schemas/RouteTypeOfGdgw"}},"type":"object"},{"$ref":"#/components/schemas/BaseAddRouteAction"}],"required":["type"],"type":"object"},"AddressFamily":{"description":"地址族类型:\n- ipv4: ipv4\n- ipv6: ipv6","enum":["ipv4","ipv6"],"type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"address_family\")\n"},"BaseAddRouteAction":{"properties":{"description":{"$ref":"#/components/schemas/RouteDescription"},"destination":{"$ref":"#/components/schemas/RouteDestination"},"nexthop":{"$ref":"#/components/schemas/RouteNextHop"}},"required":["destination","nexthop"],"type":"object"},"BaseDeleteRouteAction":{"properties":{"destination":{"$ref":"#/components/schemas/RouteDestination"},"nexthop":{"$ref":"#/components/schemas/RouteNextHop"}},"required":["destination","nexthop"],"type":"object"},"CommonRoutetable":{"description":"路由明细","properties":{"address_family":{"$ref":"#/components/schemas/AddressFamily"},"description":{"description":"路由描述","maxLength":1024,"minLength":0,"type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"description\")\n"},"destination":{"description":"路由子网","maxLength":64,"minLength":64,"type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"destination\")\n"},"gateway_id":{"description":"网关id","maxLength":36,"minLength":36,"type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"gateway_id\")\n"},"id":{"description":"路由id","maxLength":36,"minLength":36,"type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"id\")\n"},"nexthop":{"description":"下一跳id","maxLength":36,"minLength":36,"type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"nexthop\")\n"},"obtain_mode":{"description":"路由类型:\n- customized: 默认路由\n- specific: 自定义路由\n- bgp: 动态路由","enum":["customized","specific","bgp"],"type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"obtain_mode\")\n"},"status":{"description":"路由状态:\n- ACTIVE: 下发正常\n- ERROR: 下发失败\n- PENDING_CREATE: 待下发","enum":["ACTIVE","ERROR","PENDING_CREATE"],"type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"status\")\n"},"tenant_id":{"description":"租户id","maxLength":64,"minLength":64,"type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"tenant_id\")\n"},"type":{"description":"下一跳类型:\n- vif_peer: 虚拟接口对等体\n- gdgw: 全域接入网关","enum":["vif_peer","gdgw"],"maxLength":255,"minLength":0,"type":"string"}},"required":["id","tenant_id","destination","nexthop","type","obtain_mode","status","address_family"],"type":"object"},"DeleteGdgwRouteAction":{"allOf":[{"properties":{"type":{"$ref":"#/components/schemas/RouteTypeOfGdgw"}},"type":"object"},{"$ref":"#/components/schemas/BaseDeleteRouteAction"}],"required":["type"],"type":"object"},"GdgwRouteTableRequest":{"description":"修改路由入参对象","properties":{"add_routes":{"description":"需要添加的路由","items":{"allOf":[{"$ref":"#/components/schemas/AddGdgwRouteAction"}]},"maxItems":100,"minItems":0,"type":"array","x-quark-allow-type":"LIST"},"del_routes":{"description":"需要删除的路由","items":{"allOf":[{"$ref":"#/components/schemas/DeleteGdgwRouteAction"}]},"maxItems":100,"minItems":0,"type":"array","x-quark-allow-type":"LIST"},"update_routes":{"description":"需要更新的路由\n仅更新该条路由的附加信息,不执行交换机的路由更新操作。当前支持更新:路由描述-description信息","items":{"allOf":[{"$ref":"#/components/schemas/UpdateRouteAction"}]},"maxItems":100,"minItems":0,"type":"array","x-quark-allow-type":"LIST"}},"type":"object"},"RouteDescription":{"description":"路由描述","maxLength":255,"minLength":0,"pattern":"^[^<>`]*$","type":"string","x-quark-allow-empty":"true","x-quark-allow-null":"true"},"RouteDestination":{"description":"路由子网","maxLength":2147483647,"minLength":0,"type":"string"},"RouteNextHop":{"description":"下一跳id","maxLength":255,"minLength":0,"type":"string"},"RouteTypeOfGdgw":{"description":"下一跳类型:\n- vif_peer: 虚拟接口对等体\n- gdgw: 全域接入网关","enum":["vif_peer","gdgw"],"maxLength":255,"minLength":0,"type":"string"},"UpdateGdgwRoutetableRequestBody":{"description":"注意:新增、删除、修改操作互斥,一次请求只能执行其中一类操作","properties":{"dry_run":{"description":"是否dry run模式执行","type":"boolean"},"gdgw_routetable":{"$ref":"#/components/schemas/GdgwRouteTableRequest"}},"type":"object"},"UpdateGdgwRoutetableResponseBody":{"description":"修改全域接入网关路由表返回的response","properties":{"gdgw_routetable":{"description":"全域接入网关路由表","items":{"$ref":"#/components/schemas/CommonRoutetable"},"maxItems":2000,"minItems":0,"type":"array"},"request_id":{"description":"请求id","maxLength":36,"minLength":0,"type":"string"}},"required":["request_id","gdgw_routetable"],"type":"object"},"UpdateRouteAction":{"properties":{"description":{"$ref":"#/components/schemas/RouteDescription"},"destination":{"$ref":"#/components/schemas/RouteDestination"},"nexthop":{"$ref":"#/components/schemas/RouteNextHop"}},"required":["destination","nexthop"],"type":"object"}}},"consumes":"","definitions":null,"description":null,"group_id":"044e9f7ee6954f958198fe6f41f8bf50","host":"dcaas.cn-north-4.myhuaweicloud.com","id":"d0fd5f16878d4dc4ac432d21c8511ecf","info_version":"v3","method":"put","name":"UpdateGdgwRouteTable","parameters":null,"paths":{"/v3/{project_id}/dcaas/gdgw/{gdgw_id}/routetables":{"put":{"description":"支持的修改操作:新增、删除、修改","operationId":"UpdateGdgwRouteTable","parameters":[{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/PathByGdgwId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGdgwRoutetableRequestBody"}}},"description":"修改全域接入网关路由表","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGdgwRoutetableResponseBody"}}},"description":"OK","x-response-examples-1":{"application/json":{"gdgw_routetable":[{"address_family":"ipv4","description":"","destination":"1.1.1.0/24","gateway_id":"0851a5e0-6623-42c2-bb02-b8956e313dd8","id":"94912503-0a97-48ee-909b-6676129a565e","nexthop":"b9060822-06bf-4c48-995d-29a3fb04a3c3","obtain_mode":"specific","status":"PENDING_CREATE","tenant_id":"4bd6efdb0fb747b39aa2c0162c112226","type":"vif_peer"}],"request_id":"d365091f89df06c8737bd81a72efc8b2"}},"x-response-examples-description-1":"更新专线网关路由表响应体"}},"summary":"修改全域接入网关路由表","tags":["GdgwRoutetable"],"x-apiexplorer-hide":"false","x-huawei-common":{"action":"update","cts_operation_id":"UpdateGdgwRouteTable","cts_resource_type":"dcaasGlobalDcGateway","cts_service_type":"DC","cts_trace_name":"updateGdgwRouteTable","primaryTable":"dc_routes","requiredBodykey":["gdgw_routetable"],"resourceName":"gdgw_routetable","resourcesName":"gdgw_routetables","timeout":60},"x-huawei-security":{"enableEProject":true,"epsAction":"update","pdpkey":["dcaas:gdgw:updateGdgwRouteTable"],"policy":"all_dc_roles_except_readonly"},"x-is-registered":"Y","x-request-examples-1":{"gdgw_routetable":{"add_routes":[{"description":"","destination":"1.1.1.0/24","nexthop":"b9060822-06bf-4c48-995d-29a3fb04a3c3","type":"vif_peer"}]}},"x-request-examples-description-1":"更新专线网关路由表请求体","x-request-examples-url-1":"PUT https://{dc_endpoint}/v3/4bd6efdb0fb747b39aa2c0162c112226/dcaas/gdgw/0851a5e0-6623-42c2-bb02-b8956e313dd8/routetables","x-support-sdk":"Y"}}},"product_short":"DC","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"修改全域接入网关路由表","tags":"全域接入网关路由表","uri":null,"version":"3.0.1"}