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"}},"PathByGlobalDcGatewayId":{"description":"全域接入网关ID","in":"path","name":"global_dc_gateway_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":{"BandwidthInfoExternal":{"description":"带宽信息","properties":{"bandwidth_size":{"description":"带宽值","format":"int64","type":"integer","x-huawei-alias":"bandwidthSize"},"gcb_id":{"description":"带宽包ID","type":"string","x-huawei-alias":"gcbId"}},"type":"object"},"CreateExternalPeerLinkRequestBody":{"description":"创建参数请求体","properties":{"peer_link":{"description":"创建关联连接请求Body体","properties":{"description":{"description":"描述信息","example":"peer link test","maxLength":128,"minLength":0,"type":"string","x-quark-allow-empty":"true"},"name":{"description":"关联连接的名字","example":"peer-link-test","maxLength":64,"minLength":0,"pattern":"[\\u4e00-\\u9fa5a-zA-Z0-9-_.]*","type":"string"},"peer_site":{"description":"连接站点对象","properties":{"gateway_id":{"description":"接入网关连接对端的实例(当前ER实例)ID","example":"2646b256-3cfe-421b-ae8b-9fd7c4114284","maxLength":36,"minLength":0,"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"},"project_id":{"description":"对端实例(ER实例)归属的项目ID","example":"92ea72fe26294aa180a2712c28e43c21","maxLength":36,"minLength":0,"pattern":"[a-z0-9]{32}","type":"string"},"region_id":{"description":"归属的区域ID","example":"cn-north-7","maxLength":36,"minLength":0,"type":"string"}},"required":["gateway_id","region_id","project_id"],"type":"object","x-quark-allow-type":"MAP"}},"required":["name","peer_site"],"type":"object"}},"required":["peer_link"],"type":"object"},"CreateExternalPeerLinkResponseBody":{"description":"创建关联连接返回对象","properties":{"peer_link":{"$ref":"#/components/schemas/ExternalCreatePeerLink"},"request_id":{"description":"请求ID","type":"string"}},"required":["peer_link"],"type":"object"},"ExternalCreatePeerLink":{"description":"创建关联连接返回对象","properties":{"bandwidth_info":{"$ref":"#/components/schemas/BandwidthInfoExternal"},"created_time":{"description":"创建时间","format":"date-time","type":"string","x-huawei-extraAnnotation":"@JsonInclude(JsonInclude.Include.NON_NULL)\n@JsonFormat(pattern = \"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'\")\n@JsonProperty(\"created_time\")"},"description":{"description":"描述信息","type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"description\")\n"},"global_dc_gateway_id":{"description":"全域接入网关ID","type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"global_dc_gateway_id\")\n"},"id":{"description":"专线对等连接","type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"id\")\n"},"instance_id":{"description":"专线对等连接实例ID","type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"instance_id\")\n"},"name":{"description":"名称","type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"name\")\n"},"peer_site":{"$ref":"#/components/schemas/PeerSiteExternal"},"reason":{"description":"失败原因","type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"reason\")\n"},"status":{"description":"'状态信息'\n- ACTIVE 正常\n- ERROR 异常","type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"status\")\n"},"tenant_id":{"description":"租户ID","type":"string","x-huawei-extraAnnotation":"@JsonProperty(\"tenant_id\")\n"},"updated_time":{"description":"更新时间","format":"date-time","type":"string","x-huawei-extraAnnotation":"@JsonInclude(JsonInclude.Include.NON_NULL)\n@JsonFormat(pattern = \"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'\")\n@JsonProperty(\"created_time\")"}},"required":["name","peer_site"],"type":"object"},"PeerSiteExternal":{"description":"连接站点信息","properties":{"gateway_id":{"description":"全域接入网关ID","type":"string","x-huawei-alias":"gatewayId"},"link_id":{"description":"连接ID","type":"string","x-huawei-alias":"linkId"},"project_id":{"description":"项目ID","type":"string","x-huawei-alias":"projectId"},"region_id":{"description":"局点ID","type":"string","x-huawei-alias":"regionId"},"site_code":{"description":"网点编码","type":"string","x-huawei-alias":"siteCode"},"type":{"description":"连接类型","type":"string","x-huawei-alias":"type"}},"type":"object"}}},"consumes":"","definitions":null,"description":null,"group_id":"044e9f7ee6954f958198fe6f41f8bf50","host":"dcaas.cn-north-4.myhuaweicloud.com","id":"8b40afcffcf0425eb455cc2cf8419b9e","info_version":"v3","method":"post","name":"CreatePeerLink","parameters":null,"paths":{"/v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}/peer-links":{"post":{"description":"创建专线全域接入网关的关联连接peer-link对象,用于连接企业路由器或者其他接入网关","operationId":"CreatePeerLink","parameters":[{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/PathByGlobalDcGatewayId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalPeerLinkRequestBody"}}},"description":"创建专线关联连接peer-link请求参数对象","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExternalPeerLinkResponseBody"}}},"description":"Created","x-response-examples-1":{"application/json":{"peer_link":{"bandwidth_info":{"bandwidth_size":0,"gcb_id":null},"created_time":"2024-12-12T00:16:40.000Z","description":null,"global_dc_gateway_id":"335cb548-0ea0-4aff-80f5-502a2dab5325","id":"d6ea4641-9575-4675-ac4f-906884e37f28","instance_id":null,"name":"dgw-peer-link-94dc","peer_site":{"gateway_id":"70e29908-12f8-4d5d-9adf-4da5465b91b2","link_id":null,"project_id":"b197c48159d44a66b32c538c3f8da89a","region_id":"cn-southwest-242","site_code":"cn-southwest-242","type":"ER"},"reason":null,"status":"PENDING_CREATE","tenant_id":"b197c48159d44a66b32c538c3f8da89a"},"request_id":"196ab00b7bbf03be9187606853d80cee"}},"x-response-examples-description-1":"专线连接创建返回体"}},"summary":"创建专线关联连接","tags":["PeerLink"],"x-apiexplorer-hide":"false","x-huawei-common":{"action":"create","primaryTable":"peer_links","requiredBodykey":["peer_link"],"resourceName":"peer_link","resourcesName":"peer_links","timeout":60},"x-huawei-security":{"epsAction":"create","pdpkey":["dcaas:peerlink:create"],"policy":"all_dc_roles_except_readonly"},"x-is-registered":"Y","x-request-examples-1":{"peer_link":{"name":"dgw-peer-link-94dc","peer_site":{"gateway_id":"70e29908-12f8-4d5d-9adf-4da5465b91b2","project_id":"b197c48159d44a66b32c538c3f8da89a","region_id":"cn-southwest-242"}}},"x-request-examples-description-1":"专线连接创建请求体","x-request-examples-url-1":"POST https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/1c6edc27-5fdb-4dae-ac77-72d47c70ed83/peer-links","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"}