Querying the Hosted Connection List¶

Function¶

This API is used to query hosted connections created by partners.

URI¶

GET /v3/{project_id}/dcaas/hosted-connects

**Table 1** Path parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

**Table 2** Query parameters¶
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the number of records returned on each page. Value range: 1-2000 Minimum: 1 Maximum: 2000 Default: 2000
marker	No	String	Specifies the ID of the last resource record on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. Minimum: 0 Maximum: 36
fields	No	Array	Specifies the list of fields to be displayed. Array length: 1-5
sort_dir	No	Array	Specifies the sorting order of returned results. The value can be asc (default) or desc.
sort_key	No	String	Specifies the field for sorting. Default: id Minimum: 0 Maximum: 36
hosting_id	No	Array	Specifies operations connection ID by which hosted connections are queried. Array length: 0-5
id	No	Array	Specifies the resource ID by which instances are queried. Array length: 1-5
name	No	Array	Specifies the resource name by which instances are queried. You can specify multiple names. Array length: 1-5

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240

Response Parameters¶

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
request_id	String	Specifies the request ID of the current operation.
hosted_connects	Array of HostedDirectConnect objects	Specifies the hosted connection.
page_info	PageInfo object	Specifies the pagination query information.

**Table 5** HostedDirectConnect¶
Parameter	Type	Description
id	String	Specifies the hosted connection ID. Minimum: 36 Maximum: 36
tenant_id	String	Specifies the project ID.
name	String	Specifies the connection name. Minimum: 0 Maximum: 64
description	String	Provides supplementary information about the connection. Minimum: 0 Maximum: 128
bandwidth	Integer	Specifies the connection bandwidth, in Mbit/s. Minimum: 2 Maximum: 400000
location	String	Specifies information about the Direct Connect location. Minimum: 0 Maximum: 255
peer_location	String	Specifies the location of the on-premises facility at the other end of the connection, specific to the street or data center name. Minimum: 0 Maximum: 255
hosting_id	String	Specifies the ID of the operations connection on which the hosted connection is created.
provider	String	Specifies the provider of the leased line.
admin_state_up	Boolean	Specifies the administrative status. The value can be true or false. Default: true
vlan	Integer	Specifies the VLAN allocated to the hosted connection. Minimum: 0 Maximum: 3999
status	String	Specifies the operating status. BUILD: The hosted connection has been created. ACTIVE: The hosted connection is normal. DOWN: The port used by the hosted connection is down, indicating that there may be line faults. ERROR: The hosted connection is abnormal. PENDING_DELETE: The hosted connection is being deleted. PENDING_UPDATE: The hosted connection is being updated. PENDING_CREATE: The hosted connection is being created. Enumeration values: BUILD ACTIVE DOWN ERROR PENDING_DELETE PENDING_UPDATE PENDING_CREATE
apply_time	String	Specifies when the connection was requested. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.
create_time	String	Specifies when the connection was created. The UTC time format is yyyy-MM-ddTHH:mm:ss.SSSZ.
provider_status	String	Specifies the carrier status. The status can be ACTIVE or DOWN. Enumeration values: ACTIVE DOWN
port_type	String	Specifies the type of the port used by the connection. The value can be 1G, 10G, 40G, or 100G. Enumeration values: 1G 10G 40G 100G
type	String	Specifies the type of the connection. The value is hosted. Default: hosted

**Table 6** PageInfo¶
Parameter	Type	Description
previous_marker	String	Specifies the marker of the previous page. The value is the resource UUID. Minimum: 0 Maximum: 36
current_count	Integer	Specifies the number of resources in the current list. Minimum: 0 Maximum: 2000
next_marker	String	Specifies the marker of the next page. The value is the resource UUID. If this parameter is left empty, the resource is on the last page. Minimum: 0 Maximum: 36

Example Requests¶

Querying the hosted connection list

POST https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects

Example Responses¶

Status code: 200

The hosted connection list is queried.

{
  "request_id" : "a59a3776faa1d055f8124dc7b0977a90",
  "hosted_connects" : [ {
    "id" : "0278b472-ffa5-4eb3-8c0d-979d479f8ef6",
    "name" : "client-dc-faf1",
    "description" : "Hosted Connect",
    "tenant_id" : "0605768a3300d5762f82c01180692873",
    "hosting_id" : "2cfb53be-b05f-40d5-a2f8-3a59ac383836",
    "vlan" : 441,
    "bandwidth" : 10,
    "location" : "ExampleLocation",
    "peer_location" : "",
    "provider" : "ExampleProvider",
    "type" : "hosted",
    "port_type" : "10G",
    "provider_status" : "ACTIVE",
    "status" : "ACTIVE",
    "apply_time" : "2022-07-13T08:25:38.000Z",
    "admin_state_up" : true,
    "create_time" : "2022-07-13T08:25:38.000Z"
  } ]
}

Status Codes¶

Status Code	Description
200	OK

Error Codes¶

See Error Codes.

last updated: 2024-11-20 09:22 UTC - commit: 93bc57de5f64056465c69d29eee0df72ff6014f0