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"}},"ProjectId":{"description":"租户项目ID","in":"path","name":"project_id","required":true,"schema":{"maxLength":36,"minLength":0,"pattern":"[a-fA-F0-9]{32}","type":"string"}}},"schemas":{"CreateGlobalDcGateway":{"description":"创建global-dc-gateway的属性详情。","example":{"name":"bj-dc-gateway"},"properties":{"address_family":{"description":"网关的地址簇,IPv4或者ipv6和IPv4双栈\n- ipv4\n- dual","enum":["ipv4","dual"],"type":"string"},"bgp_asn":{"description":"global-dc-gateway对应的ASN号","example":"65001","format":"int64","maximum":4294967295,"minimum":1,"type":"integer"},"description":{"description":"描述信息。","example":"global-dc-gateway-description","maxLength":255,"minLength":0,"pattern":"^[^<>]*$","type":"string"},"enterprise_project_id":{"default":"0","description":"global-dc-gateway所属的企业项目ID。","example":"b06fe2a2-d31e-47b3-86a6-ff3af8186b2a","maxLength":36,"minLength":0,"type":"string"},"name":{"description":"global-dc-gateway名字。","example":"global-dc-gateway-name","maxLength":64,"minLength":0,"pattern":"^[\\u4e00-\\u9fa50-9a-zA-Z_.\\-]+$","type":"string"},"tags":{"description":"global-dc-gateway关联TAG。","items":{"$ref":"#/components/schemas/Tag"},"maxItems":10,"minItems":0,"type":"array","x-open-region-cloud":"hws,hws_hk,ocb,cmcc"},"tenant_id":{"description":"项目ID。","example":"cef6293371db41929ffd7459d5fd6e01","maxLength":255,"minLength":0,"pattern":"[a-z0-9]{32}","type":"string","x-ifnull":"hide"}},"required":["name"]},"CreateGlobalDcGatewayEntry":{"description":"global-dc-gateway详情。","properties":{"address_family":{"description":"网关的地址簇,IPv4或者ipv6和IPv4双栈\n- ipv4\n- dual","enum":["ipv4","dual"],"type":"string"},"admin_state_up":{"description":"该GDGW的管理状态,true为激活状态、false为冻结状态","readOnly":true,"type":"boolean"},"available_peer_link_count":{"description":"该全域接入网关上GDGW允许创建关联连接(PeerLink)的数量","example":"5","format":"int32","readOnly":true,"type":"integer"},"bgp_asn":{"description":"DGW对应BGP的ASN编号","example":"65001","format":"int64","maximum":65535,"minimum":0,"type":"integer"},"created_time":{"description":"创建时间。","example":"2022-04-27T01:54:50.632Z","format":"date-time","type":"string"},"current_peer_link_count":{"description":"全域接入网关(GDGW)上关联连接的数量,表示DGW挂载ER的数量","example":"2","format":"int32","readOnly":true,"type":"integer"},"description":{"description":"描述信息","example":"global-dc-gateway-to-bj-region","maxLength":128,"minLength":0,"type":"string","x-ifnull":"hide"},"enterprise_project_id":{"description":"global-dc-gateway所属的企业项目ID。","example":"3cc6930f-f1d1-4172-a572-336eac9d2689","maxLength":36,"minLength":0,"type":"string","x-ifnull":"hide"},"global_center_network_id":{"description":"DGW加载的全球中心网络实例的ID","example":"9ee69ef0-f1d1-4172-a572-336eac9d2689","maxLength":36,"minLength":0,"readOnly":true,"type":"string"},"id":{"description":"专线全域接入网关(global-dc-gateway)ID","example":"deddb081-a65b-4d3f-881a-c6a60114e9ad","maxLength":36,"minLength":0,"type":"string"},"location_name":{"description":"DGW创建网关设备归属的位置","example":"北京-中金","maxLength":36,"minLength":0,"type":"string"},"name":{"description":"global-dc-gateway名字。","example":"global-dc-gateway-name","maxLength":64,"minLength":0,"type":"string","x-ifnull":"hide"},"region_id":{"description":"DGW所属Region","example":"cn-north4","maxLength":36,"minLength":0,"type":"string"},"status":{"$ref":"#/components/schemas/GlobalDcGatewayStatus"},"tags":{"description":"global-dc-gateway关联TAG。","items":{"$ref":"#/components/schemas/Tag"},"maxItems":10,"minItems":0,"type":"array","x-ifnull":"hide","x-open-region-cloud":"hws,hws_hk,ocb,cmcc"},"tenant_id":{"description":"项目ID。","example":"cef6293371db41929ffd7459d5fd6e01","maxLength":255,"minLength":0,"pattern":"[a-z0-9]{32}","type":"string","x-ifnull":"hide"}}},"CreateGlobalDcGatewayRequestBody":{"description":"创建global-dc-gateway的请求体。","properties":{"global_dc_gateway":{"$ref":"#/components/schemas/CreateGlobalDcGateway"}},"required":["global_dc_gateway"],"type":"object"},"CreateGlobalDcGatewayResponseBody":{"description":"创建global-dc-gateway的返回体。","properties":{"global_dc_gateway":{"$ref":"#/components/schemas/CreateGlobalDcGatewayEntry"},"request_id":{"description":"请求ID。","example":"ab25f4f5-46a6-4f2b-aaef-7510f0f06da2","maxLength":36,"minLength":0,"type":"string"}},"type":"object"},"GlobalDcGatewayStatus":{"description":"GDGW资源状态,DOWN (未连接状态), PENDING_UPDATE(连接状态更新中),ACTIVE (已连接状态), ERROR (出错)。","enum":["DOWN","PENDING_UPDATE","ACTIVE","ERROR"],"example":"ACTIVE","type":"string"},"Tag":{"description":"资源标签。","properties":{"key":{"description":"标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。","example":"key","maxLength":36,"minLength":0,"type":"string","x-open-region-cloud":"hws,hws_hk,ocb,cmcc"},"value":{"description":"标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。","example":"value","maxLength":43,"minLength":0,"type":"string","x-open-region-cloud":"hws,hws_hk,ocb,cmcc"}},"required":["key"],"type":"object"}}},"consumes":"","definitions":null,"description":null,"group_id":"044e9f7ee6954f958198fe6f41f8bf50","host":"dcaas.cn-north-4.myhuaweicloud.com","id":"fcf371d1737b4ba2965a95e879d9d4d9","info_version":"v3","method":"post","name":"CreateGlobalDcGateway","parameters":null,"paths":{"/v3/{project_id}/dcaas/global-dc-gateways":{"post":{"description":"创建专线全域接入网关实例(global-dc-gateway),用于接入全球的ER实例","operationId":"CreateGlobalDcGateway","parameters":[{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/ProjectId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGlobalDcGatewayRequestBody"}}},"description":"创建全域接入网关请求参数","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGlobalDcGatewayResponseBody"}}},"description":"Created","x-response-examples-1":{"application/json":{"global_dc_gateway":{"address_family":"ipv4","admin_state_up":true,"available_peer_link_count":3,"bgp_asn":64512,"created_time":"2024-12-11T23:33:19.000Z","current_peer_link_count":null,"description":"","enterprise_project_id":"0","global_center_network_id":null,"id":"71f6ac9b-2745-4fb8-96c8-9d97d969c4b5","location_name":null,"name":"dgw-2c18","region_id":null,"status":"DOWN","tags":[{"key":"key1","value":"value1"}],"tenant_id":"b197c48159d44a66b32c538c3f8da89a"},"request_id":"2e97ccd07037d0f48abc620979b65976"}},"x-response-examples-description-1":"全域接入网关创建返回体"}},"summary":"创建专线全域接入网关","tags":["GlobalDcGateway"],"x-huawei-security":{"enableEProject":true,"epsAction":"create","pdpKey":"dcaas:gdgw:create"},"x-is-registered":"Y","x-request-examples-1":{"global_dc_gateway":{"address_family":"ipv4","bgp_asn":"64512","description":"","enterprise_project_id":"0","name":"dgw-2c18","tags":[{"key":"key1","value":"value1"}]}},"x-request-examples-description-1":"全域接入网关创建请求体","x-request-examples-url-1":"POST https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways","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"}