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":{"ShowVifPeerResponseBody":{"description":"虚拟接口对等体对象","properties":{"vif_peer":{"$ref":"#/components/schemas/VifPeer"}},"required":["vif_peer"],"type":"object"},"UpdateVifPeer":{"description":"更新虚拟接口对等体参数","properties":{"description":{"description":"VIF对等体名字描述信息","maxLength":128,"minLength":0,"type":"string"},"name":{"description":"VIF对等体名字","example":"peer-ipv4","maxLength":64,"minLength":0,"type":"string"},"remote_ep_group":{"description":"远端子网列表,记录用户侧的cidrs","items":{"type":"string"},"type":"array"}},"type":"object"},"UpdateVifPeerRequestBody":{"description":"更新对等体参数","properties":{"vif_peer":{"$ref":"#/components/schemas/UpdateVifPeer"}},"type":"object"},"VifPeer":{"description":"虚拟接口对等体对象","properties":{"address_family":{"description":"接口的地址簇类型,ipv4,ipv6","type":"string"},"bgp_asn":{"description":"BGP邻居的AS号","example":65000,"format":"int32","maximum":4294967295,"minimum":1,"type":"integer"},"bgp_md5":{"description":"BGP邻居的MD5密码","type":"string"},"bgp_route_limit":{"description":"BGP的路由配置规格","format":"int32","type":"integer"},"bgp_status":{"description":"接口BGP协议状态,如果是静态路由接口则状态为 null","maxLength":10,"type":"string"},"description":{"description":"VIF对等体名字描述信息","maxLength":128,"minLength":0,"type":"string"},"device_id":{"description":"归属的设备ID","type":"string"},"enable_bfd":{"description":"是否使能bfd功能:true或false","example":false,"type":"boolean"},"enable_nqa":{"description":"是否使能nqa功能:true或false","example":false,"type":"boolean"},"id":{"description":"资源ID","example":"c768eb52-12a8-4859-9b43-81194643040c","maxLength":36,"minLength":36,"type":"string"},"local_gateway_ip":{"description":"VIF对等体云侧接口地址","type":"string"},"name":{"description":"VIF对等体名字","example":"peer-ipv4","maxLength":64,"minLength":0,"type":"string"},"receive_route_num":{"description":"路由模式为bgp:receive_route_num值为接收搭配BGP的路由数目;\n路由模式为static:该字段无意义,值为-1;\n注:若早期接入云的部分用户无法获取该字段信息,如需要请联系客服迁移专线端口。","example":2,"format":"int32","type":"integer"},"remote_ep_group":{"description":"远端子网列表,记录租户侧的cidrs","items":{"type":"string"},"type":"array"},"remote_gateway_ip":{"description":"VIF对等体客户侧接口地址","type":"string"},"route_mode":{"description":"路由模式:static/bgp","enum":["bgp","static"],"example":"bgp","maxLength":255,"type":"string"},"service_ep_group":{"description":"该字段用于公网专线接口,表示租户可以访问云上公网服务地址列表","items":{"type":"string"},"type":"array"},"status":{"description":"VIF对等体状态","example":"ACTIVE","type":"string"},"tenant_id":{"description":"归属租户ID","example":"0605768a3300d5762f82c01180692873","maxLength":36,"minLength":36,"type":"string"},"vif_id":{"description":"vif对等体对应的虚拟接口ID","example":"0d0fdf63-f2c4-491c-8866-d504796189be","maxLength":36,"minLength":36,"type":"string"}},"type":"object"}}},"consumes":"","definitions":null,"description":null,"group_id":"044e9f7ee6954f958198fe6f41f8bf50","host":"dcaas.cn-north-4.myhuaweicloud.com","id":"c0b9387278fc4223b980c016644e5d73","info_version":"v3","method":"put","name":"UpdateVifPeer","parameters":null,"paths":{"/v3/{project_id}/dcaas/vif-peers/{vif_peer_id}":{"put":{"description":"更新虚拟接口对等体信息,包括远端子网,名字和描述等。 本接口只在支持Ipv6的区域开放,如需要使用请联系客服","operationId":"UpdateVifPeer","parameters":[{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/ProjectId"},{"description":"虚拟接口对等体ID","in":"path","name":"vif_peer_id","required":true,"schema":{"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","x-q-type":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVifPeerRequestBody"}}}},"responses":{"200":{"content":{"application/json":{"example":{"vif_peer":{"address_family":"ipv4","bgp_asn":null,"bgp_md5":null,"bgp_route_limit":100,"bgp_status":null,"description":"mytest","id":"4c95de3e-9f75-4357-9c79-b22498dd71c7","local_gateway_ip":"12.3.4.1/30","name":"vif-0819","receive_route_num":-1,"remote_ep_group":["20.1.1.0/24"],"remote_gateway_ip":"12.3.4.2/30","route_mode":"static","status":"ACTIVE","tenant_id":"ed28c294165741faaeccab26913122a1","vif_id":"5d6c17bc-0ebe-420b-8734-21f519e9d7ad"}},"schema":{"$ref":"#/components/schemas/ShowVifPeerResponseBody"}}},"description":"OK"}},"summary":"更新虚拟接口对等体","tags":["VirtualInterface"],"x-apiexplorer-hide":"false","x-is-registered":"Y","x-open-region-cloud":"hws,hws_hk","x-request-examples-1":{"vif_peer":{"description":"mytest","name":"vif-0819","remote_ep_group":["20.1.1.0/24"]}},"x-request-examples-description-1":"更新虚拟接口对等体的名称和名称,修改远端子网列表。","x-request-examples-url-1":"PUT https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dcaas/vif-peers/68250543-0a13-4ac7-aa36-d018856ac640","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"}