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"},"Fields":{"description":"显示字段列表","in":"query","name":"fields","required":false,"schema":{"items":{"maxLength":100,"minLength":0,"type":"string"},"maxItems":5,"minItems":1,"type":"array"}},"HostingId":{"description":"根椐运营专线ID过滤托管专线列表","explode":true,"in":"query","name":"hosting_id","schema":{"items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"style":"form"},"Limit":{"description":"每页返回的个数。\n取值范围:1~2000。","example":10,"in":"query","name":"limit","schema":{"default":2000,"format":"int32","maximum":2000,"minimum":1,"type":"integer"}},"Marker":{"description":"上一页最后一条资源记录的ID,为空时为查询第一页。\n使用说明:必须与limit一起使用。","example":"7f7f738f-453c-40b1-be26-28e7b9e390c1","in":"query","name":"marker","schema":{"maxLength":36,"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"}},"QueryById":{"description":"根据资源ID过滤实例","explode":true,"in":"query","name":"id","schema":{"items":{"type":"string"},"maxItems":5,"minItems":1,"type":"array"},"style":"form"},"QueryByName":{"description":"根据名字过滤查询,可查询多个名字。","example":["resourceA"],"explode":false,"in":"query","name":"name","schema":{"items":{"maxLength":64,"minLength":1,"pattern":"^[\\u4e00-\\u9fa50-9a-zA-Z_.\\-]+$","type":"string"},"maxItems":5,"minItems":1,"type":"array"},"style":"form"},"SortDir":{"description":"返回结果按照升序(asc)或降序(desc)排列,默认为asc","in":"query","name":"sort_dir","required":false,"schema":{"items":{"enum":["asc","desc"],"type":"string"},"type":"array"}},"SortKey":{"description":"排序字段。","example":["id"],"in":"query","name":"sort_key","required":false,"schema":{"default":"id","maxLength":36,"minLength":0,"type":"string"}}},"schemas":{"DirectConnect":{"description":"物理专线对象","properties":{"admin_state_up":{"default":true,"description":"管理状态:true或false","type":"boolean"},"apply_time":{"description":"物理专线的申请时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ","example":"2022-04-22T06:36:06.000Z","format":"date-time","readOnly":true,"type":"string","x-ifnull":"hide"},"auto_renew":{"description":"用于标识包周期产品是否自动续订","type":"integer"},"bandwidth":{"description":"物理专线接入带宽,单位Mbps。","example":1000,"format":"int32","maximum":100000,"minimum":2,"type":"integer"},"building_line_product_id":{"description":"该参数用于销售线路场景,标识机房内部线路资源产品ID","type":"string"},"change_mode":{"description":"标识续费变更的一种状态","format":"int32","type":"integer"},"charge_mode":{"description":"计费模式:prepayment/bandwidth/traffic","enum":["prepayment","bandwidth","traffic"],"example":"bandwidth","type":"string"},"create_time":{"description":"物理专线的创建时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ","example":"2022-04-22T06:36:06.000Z","format":"date-time","readOnly":true,"type":"string","x-ifnull":"hide"},"description":{"description":"物理专线描述信息","example":"direct to ExampleLocation","maxLength":128,"minLength":0,"type":"string"},"device_id":{"description":"物理专线连接的设备的标识ID","example":"10.200.1.20","maxLength":36,"minLength":0,"type":"string"},"email":{"description":"客户邮箱信息","example":"cloud@example.com","pattern":"^[\\u4e00-\\u9fa50-9a-zA-Z\\_\\-\\.]+@[\\u4e00-\\u9fa50-9a-zA-Z\\_\\-\\.]+\\.[\\u4e00-\\u9fa50-9a-zA-Z\\_\\-\\.]+$","type":"string"},"enterprise_project_id":{"description":"实例所属企业项目ID","example":"a3bad420-33b8-4e26-9e9b-bdf67aa8e72b","maxLength":36,"minLength":36,"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-ifnull":"hide"},"hosting_id":{"description":"hosted物理专线对应的hosting物理专线的ID","example":"41a30e95-3589-4cf9-b489-270b95ad64b3","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"},"id":{"description":"物理专线标识符ID","example":"4673e339-8412-4ee1-b73e-2ba9cdfa54c1","type":"string"},"ies_id":{"description":"归属的CloudPond站点的ID","type":"string"},"lag_id":{"description":"物理专线归属的链路聚合组(lag)的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"},"last_building_line_product_id":{"description":"该参数用于销售线路场景,标识变更前机房内部线路资源产品ID,用于在做线路带宽变更时保存上一次的记录。","type":"string"},"last_onestop_product_id":{"description":"该参数用于销售线路场景,标识变更前的一站式专线产品ID,用于在做线路带宽变更时保存上一次的记录。","type":"string"},"locales":{"$ref":"#/components/schemas/LocalesBody"},"location":{"description":"专线的接入位置信息","example":"BJ-ZJ","maxLength":255,"minLength":0,"type":"string"},"modified_bandwidth":{"description":"线路带宽变更后的带宽值","format":"int32","type":"integer"},"name":{"description":"物理专线名字","example":"client-dc-80bd","maxLength":64,"minLength":0,"type":"string"},"onestop_product_id":{"description":"该参数用于销售线路场景,标识一站式专线产品ID","type":"string"},"onestopdc_status":{"description":"一站式专线状态","type":"string"},"order_id":{"description":"物理专线对应订单号,用于支持包周期计费,识别用户订单","type":"string"},"peer_location":{"description":"物理专线对端所在的物理位置,省/市/街道或IDC名字。","example":"北京海淀区北太平庄","maxLength":255,"minLength":0,"type":"string"},"peer_port_type":{"description":"连接对端的端口类型","type":"string"},"peer_provider":{"description":"专线连接对接的运营商","type":"string"},"period_num":{"description":"物理专线对应的包周期时间","format":"int32","type":"integer"},"period_type":{"description":"物理专线对应订单号对应包周期的类型","format":"int32","type":"integer"},"port_type":{"description":"物理专线接入接口的类型,支持1G 10G 40G 100G","enum":["1G","10G","40G","100G"],"example":"10G","type":"string"},"product_id":{"description":"物理专线订单对应产品标识,用于订制包周期套餐等计费策略","type":"string"},"provider":{"description":"物理专线连接的线路运营商\n如:中国电信 中国联通 中国移动 中国其他 境外其他专线归属的运营商","example":"china telecom","type":"string"},"provider_status":{"description":"物理专线的运营商操作状态,合法值是:ACTIVE, DOWN","enum":["ACTIVE","DOWN"],"example":"ACTIVE","type":"string"},"public_border_group":{"description":"归属的可用区对应的边界组(public border group),标识是否homezone局点。","type":"string"},"ratio_95peak":{"description":"95计费保底带宽率","maximum":100,"minimum":0,"type":"integer"},"reason":{"description":"如果专线资源的状态是Error的情况下,该参数会显示相关错误信息。","type":"string"},"signed_agreement_status":{"description":"专线协议的签署状态","enum":["signed"],"type":"string","x-open-region-cloud":"cmcc,hws,hws_hk,hws_ocb,ocb,hws_eu"},"signed_agreement_time":{"description":"专线协议的签署时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ","example":"2022-04-22T06:36:06.000Z","format":"date-time","type":"string","x-open-region-cloud":"cmcc,hws,hws_hk,hws_ocb,ocb,hws_eu"},"spec_code":{"description":"物理专线订单对应产品规格,用于订制包周期套餐等计费策略","type":"string"},"status":{"description":"资源状态,合法值是:\nACTIVE:专线已经开通完成且线路处于正常状态\nDOWN:专线对应的端口处于down的状态,可能存在线路故障等异常。\nBUILD:申请专线正在施工建设中\nERROR:专线配置异常,请联系客服解决相关问题。\nPENDING_DELETE:正在删除\nDELETED:已删除\nAPPLY:申请开通\nDENY:客户需求无法满足,拒绝工勘。\nPENDING_PAY:待支付\nPAID:已支付\nPENDING_SURVEY:待工勘\nLEASED_LINE_DELIVERY:运营商施工","enum":["BUILD","PAID","APPLY","PENDING_SURVEY","ACTIVE","DOWN","ERROR","PENDING_DELETE","DELETED","DENY","PENDING_PAY","LEASED_LINE_DELIVERY"],"type":"string"},"support_feature":{"description":"用户专线可支持的特性列表","items":{"type":"string"},"type":"array"},"tags":{"description":"标签信息","items":{"$ref":"#/components/schemas/Tag"},"maxItems":10,"minItems":0,"type":"array","x-open-region-cloud":"hws,hws_hk,ocb,cmcc"},"tenant_id":{"$ref":"#/components/schemas/TenantIdDef"},"type":{"default":"standard","description":"物理专线的类型,类型包括标准(standard),运营专线(hosting),托管专线(hosted),一站式标准(onestop_standard),一站式托管(onestop_hosted)。","enum":["standard","hosting","hosted","onestop_standard","onestop_hosted"],"example":"hosted","type":"string"},"vgw_type":{"default":"default","deprecated":true,"description":"专线要求的网关类型","enum":["default"],"type":"string"},"vlan":{"description":"为托管hosted物理专线分配的vlan。","format":"int32","maximum":3999,"minimum":0,"type":"integer"}},"type":"object"},"ListDirectConnectsResponseBody":{"properties":{"direct_connects":{"description":"物理专线对象列表","items":{"$ref":"#/components/schemas/DirectConnect"},"type":"array"},"page_info":{"$ref":"#/components/schemas/PageInfo"},"request_id":{"description":"操作请求ID","example":"183717507e98ad335d5d93bac47f66a1","type":"string"}},"required":["direct_connects","page_info","request_id"],"type":"object"},"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"},"PageInfo":{"description":"分页查询页的信息","properties":{"current_count":{"description":"当前列表中资源数量","format":"int32","maximum":2000,"minimum":0,"type":"integer"},"next_marker":{"description":"下一页的marker,值为资源的uuid,为空时表示最后一页","maxLength":36,"minLength":0,"type":"string"},"previous_marker":{"description":"上一页的marker,值为资源的uuid","maxLength":36,"minLength":0,"type":"string"}},"required":["current_count","previous_marker"],"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"},"TenantIdDef":{"description":"实例所属项目ID。","example":"32f7402e18154ce5861c9989df956394","maxLength":32,"minLength":32,"pattern":"[a-fA-F0-9]{32}","type":"string","x-ifnull":"hide"}}},"consumes":"","definitions":null,"description":null,"group_id":"044e9f7ee6954f958198fe6f41f8bf50","host":"dcaas.cn-north-4.myhuaweicloud.com","id":"db992607febb4ca0bad7c43ffffa1f83","info_version":"v3","method":"get","name":"ListDirectConnects","parameters":null,"paths":{"/v3/{project_id}/dcaas/direct-connects":{"get":{"description":"查询租户创建的所有的direct connect对象.","operationId":"ListDirectConnects","parameters":[{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Marker"},{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/Fields"},{"$ref":"#/components/parameters/SortKey"},{"$ref":"#/components/parameters/SortDir"},{"$ref":"#/components/parameters/HostingId"},{"$ref":"#/components/parameters/EnterpriseProjectIds"},{"$ref":"#/components/parameters/QueryById"},{"$ref":"#/components/parameters/QueryByName"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDirectConnectsResponseBody"}}},"description":"OK","x-response-examples-1":{"application/json":{"direct_connects":[{"admin_state_up":true,"apply_time":"2018-10-19T07:08:11.000Z","auto_renew":0,"bandwidth":100,"building_line_product_id":null,"change_mode":null,"charge_mode":null,"create_time":"2018-10-19T07:08:11.000Z","description":"","device_id":"172.16.40.2","email":"cloud@example.com","hosting_id":null,"id":"6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a","ies_id":null,"last_building_line_product_id":null,"last_onestop_product_id":null,"location":"Biere","modified_bandwidth":null,"name":"direct connect1","onestop_product_id":null,"onestopdc_status":null,"order_id":"","peer_location":"","peer_port_type":null,"peer_provider":null,"port_type":"10G","product_id":"","provider":"OTC","provider_status":"ACTIVE","public_border_group":"center","ratio_95peak":null,"reason":null,"spec_code":"100ge","status":"BUILD","support_feature":[],"tenant_id":"6fbe9263116a4b68818cf1edce16bc4f","type":"standard","vgw_type":"default","vlan":null}],"request_id":"9a4f4dfc4fb2fc101e65bba07d908535"}},"x-response-examples-2":{"application/json":{"direct_connects":[{"admin_state_up":true,"apply_time":"2018-10-19T07:08:11.000Z","auto_renew":0,"bandwidth":100,"building_line_product_id":null,"change_mode":null,"charge_mode":null,"create_time":"2018-10-19T07:08:11.000Z","description":"","device_id":"172.16.40.2","email":"cloud@example.com","hosting_id":null,"id":"6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a","ies_id":null,"last_building_line_product_id":null,"last_onestop_product_id":null,"location":"ExampleLocation","modified_bandwidth":null,"name":"direct connect1","onestop_product_id":null,"onestopdc_status":null,"order_id":"","peer_location":"","peer_port_type":null,"peer_provider":null,"port_type":"10G","product_id":"","provider":"ExampleProvider","provider_status":"ACTIVE","public_border_group":"center","ratio_95peak":null,"reason":null,"spec_code":"100ge","status":"BUILD","support_feature":[],"tenant_id":"6fbe9263116a4b68818cf1edce16bc4f","type":"standard","vgw_type":"default","vlan":null}],"request_id":"9a4f4dfc4fb2fc101e65bba07d908535"}},"x-response-examples-description-1":"成功查询物理连接列表","x-response-examples-description-2":"成功查询物理连接列表","x-response-examples-tags-1":"dt","x-response-examples-tags-2":"hws,hws_hk,ocb,cmcc"}},"summary":"查询物理连接列表","tags":["DirectConnect"],"x-apiexplorer-hide":"false","x-is-registered":"Y","x-request-examples-description-1":"查询物理连接列表","x-request-examples-url-1":"GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects","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"}