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"}},"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":{"HostedDirectConnect":{"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","type":"string"},"bandwidth":{"description":"托管专线接入带宽,单位Mbps。","format":"int32","maximum":400000,"minimum":2,"type":"integer"},"create_time":{"description":"托管专线创建时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ","example":"2022-04-22T06:36:06.000Z","format":"date-time","type":"string"},"description":{"description":"托管专线的描述信息","maxLength":128,"minLength":0,"type":"string"},"hosting_id":{"description":"hosted物理专线对应的hosting物理专线的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"},"id":{"description":"托管专线ID","example":"0d0fdf63-f2c4-491c-8866-d504796189be","maxLength":36,"minLength":36,"type":"string"},"location":{"description":"专线的接入位置信息","maxLength":255,"minLength":0,"type":"string"},"name":{"description":"托管专线名字","maxLength":64,"minLength":0,"type":"string"},"peer_location":{"description":"托管专线对端所在的物理位置,省/市/街道或IDC名字。","maxLength":255,"minLength":0,"type":"string"},"port_type":{"description":"托管专线接入接口的类型,支持1G 10G 40G 100G","enum":["1G","10G","40G","100G"],"example":"10G","type":"string"},"provider":{"description":"专线线路的提供商","type":"string"},"provider_status":{"description":"托管专线的运营商操作状态,合法值是:ACTIVE, DOWN","enum":["ACTIVE","DOWN"],"type":"string"},"status":{"description":"操作状态,合法值是:\nBUILD:已开通\nACTIVE:托管专线正常\nDOWN:专线对应的端口处于down的状态,可能存在线路故障等异常。\nERROR:托管专线异常\nPENDING_DELETE:删除中\nPENDING_UPDATE:更新中\nPENDING_CREATE:创建中","enum":["BUILD","ACTIVE","DOWN","ERROR","PENDING_DELETE","PENDING_UPDATE","PENDING_CREATE"],"type":"string"},"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"},"vlan":{"description":"hosted物理专线预分配的vlan。","format":"int32","maximum":3999,"minimum":0,"type":"integer"}},"type":"object"},"ListHostedDirectConnectsResponseBody":{"properties":{"hosted_connects":{"items":{"$ref":"#/components/schemas/HostedDirectConnect"},"type":"array"},"page_info":{"$ref":"#/components/schemas/PageInfo"},"request_id":{"description":"本次操作的请求ID","type":"string"}},"required":["direct_connects","page_info","request_id"],"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"},"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":"2dfc2f816cbb41c683ec54fcbe31ce09","info_version":"v3","method":"get","name":"ListHostedDirectConnects","parameters":null,"paths":{"/v3/{project_id}/dcaas/hosted-connects":{"get":{"description":"查询合作伙伴创建的托管专线连接列表.","operationId":"ListHostedDirectConnects","parameters":[{"$ref":"#/components/parameters/ProjectId"},{"$ref":"#/components/parameters/AuthToken"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Marker"},{"$ref":"#/components/parameters/Fields"},{"$ref":"#/components/parameters/SortDir"},{"$ref":"#/components/parameters/SortKey"},{"$ref":"#/components/parameters/HostingId"},{"$ref":"#/components/parameters/QueryById"},{"$ref":"#/components/parameters/QueryByName"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListHostedDirectConnectsResponseBody"}}},"description":"OK","x-response-examples-1":{"application/json":{"hosted_connects":[{"admin_state_up":true,"apply_time":"2022-07-13T08:25:38.000Z","bandwidth":10,"create_time":"2022-07-13T08:25:38.000Z","description":"Hosted Connect","hosting_id":"2cfb53be-b05f-40d5-a2f8-3a59ac383836","id":"0278b472-ffa5-4eb3-8c0d-979d479f8ef6","location":"Biere","name":"client-dc-faf1","peer_location":"","port_type":"10G","provider":"OTC","provider_status":"ACTIVE","status":"ACTIVE","tenant_id":"0605768a3300d5762f82c01180692873","type":"hosted","vlan":441}],"request_id":"a59a3776faa1d055f8124dc7b0977a90"}},"x-response-examples-2":{"application/json":{"hosted_connects":[{"admin_state_up":true,"apply_time":"2022-07-13T08:25:38.000Z","bandwidth":10,"create_time":"2022-07-13T08:25:38.000Z","description":"Hosted Connect","hosting_id":"2cfb53be-b05f-40d5-a2f8-3a59ac383836","id":"0278b472-ffa5-4eb3-8c0d-979d479f8ef6","location":"ExampleLocation","name":"client-dc-faf1","peer_location":"","port_type":"10G","provider":"ExampleProvider","provider_status":"ACTIVE","status":"ACTIVE","tenant_id":"0605768a3300d5762f82c01180692873","type":"hosted","vlan":441}],"request_id":"a59a3776faa1d055f8124dc7b0977a90"}},"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":"POST https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-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"}