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"}},"EnterpriseProjectIds":{"description":"根据企业项目ID过滤资源实例","explode":false,"in":"query","name":"enterprise_project_id","schema":{"items":{"maxLength":36,"minLength":0,"pattern":"0|[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"},"maxItems":10,"minItems":1,"type":"array"},"style":"form"},"ExtFields":{"description":"show response ext-fields","in":"query","name":"ext_fields","schema":{"items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"}},"Fields":{"description":"显示字段列表","in":"query","name":"fields","required":false,"schema":{"items":{"maxLength":100,"minLength":0,"type":"string"},"maxItems":5,"minItems":1,"type":"array"}},"Limit":{"description":"每页返回的个数。\n取值范围:1~2000。","example":10,"in":"query","name":"limit","schema":{"default":2000,"format":"int32","maximum":2000,"minimum":1,"type":"integer"}},"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":{"GlobalDcGatewayEntry":{"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"},"locales":{"$ref":"#/components/schemas/LocalesBody"},"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"},"reason":{"description":"失败原因","example":"global-dc-gateway-to-bj-region","maxLength":255,"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"},"updated_time":{"description":"更新时间。","example":"2022-04-28T01:54:50.632Z","format":"date-time","type":"string"}}},"GlobalDcGatewayStatus":{"description":"GDGW资源状态,DOWN (未连接状态), PENDING_UPDATE(连接状态更新中),ACTIVE (已连接状态), ERROR (出错)。","enum":["DOWN","PENDING_UPDATE","ACTIVE","ERROR"],"example":"ACTIVE","type":"string"},"LocalesBody":{"description":"Locale地址描述信息。","properties":{"en_us":{"description":"区域英文名称。","example":"hangzhou-Odin","maxLength":255,"minLength":0,"pattern":"^[^<>]*$","type":"string"},"zh_cn":{"description":"区域中文名称。","example":"杭州奥丁","maxLength":255,"minLength":0,"pattern":"^[^<>]*$","type":"string","x-open-region-cloud":"hws,hws_hk,hws_eu,hcs,fcs,hcs_sm,hcso_g42,hcso_g42_b,mix,cmcc,ctc,hws_ocb,hk_sbc,hk_tm,hk_g42,hk_vdf"}},"type":"object"},"ShowGlobalDcGatewayResponseBody":{"description":"查询global-dc-gateway详情的返回体。","properties":{"global_dc_gateway":{"$ref":"#/components/schemas/GlobalDcGatewayEntry"},"request_id":{"description":"请求ID。","example":"e09daf2d-7689-4815-812e-bd9e12a53906","maxLength":36,"minLength":0,"type":"string"}},"type":"object"},"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":"a4978574247544a38af7c7f476aaf265","info_version":"v3","method":"get","name":"ShowGlobalDcGateway","parameters":null,"paths":{"/v3/{project_id}/dcaas/global-dc-gateways/{global_dc_gateway_id}":{"get":{"description":"查询专线全域接入网关实例详情信息","operationId":"ShowGlobalDcGateway","parameters":[{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Fields"},{"$ref":"#/components/parameters/ExtFields"},{"$ref":"#/components/parameters/EnterpriseProjectIds"},{"$ref":"#/components/parameters/PathByGlobalDcGatewayId"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowGlobalDcGatewayResponseBody"}}},"description":"OK","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-12T07:33:19.000Z","current_peer_link_count":0,"description":"","enterprise_project_id":"0","global_center_network_id":null,"id":"71f6ac9b-2745-4fb8-96c8-9d97d969c4b5","locales":null,"location_name":null,"name":"dgw-2c18","reason":null,"region_id":null,"status":"DOWN","tags":[],"tenant_id":"b197c48159d44a66b32c538c3f8da89a","updated_time":"2024-12-12T07:33:19.000Z"}}},"x-response-examples-description-1":"全域接入网关详情查询结果"}},"summary":"查询专线全域接入网关详情","tags":["GlobalDcGateway"],"x-huawei-security":{"enableEProject":true,"epsAction":"show","pdpKey":"dcaas:gdgw:show"},"x-is-registered":"Y","x-request-examples-description-1":"查询全域接入网关详情","x-request-examples-url-1":"GET https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/global-dc-gateways/71f6ac9b-2745-4fb8-96c8-9d97d969c4b5","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"}