Querying the Hosted Connection List

project_id

Yes

String

Specifies the project ID.

limit

No

Integer

Specifies the number of records returned on each page. Value range: 1 to 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, which can be asc (ascending order) or desc (descending order). The default value is asc.

sort_key

No

String

Specifies the sorting field.

Default: id

Minimum: 0

Maximum: 36

hosting_id

No

Array

Specifies operations connection ID by which hosted connections are filtered.

Array Length: 0 - 5

id

No

Array

Specifies the resource ID by which instances are filtered.

Array Length: 1 - 5

name

No

Array

Specifies the resource name by which instances are filtered. You can specify multiple names.

Array Length: 1 - 5

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

request_id

String

Specifies the request ID of the current operation.

hosted_connects

Array of HostedDirectConnect objects

Specifies the parameters for creating a hosted connection.

page_info

PageInfo object

Specifies the pagination query information.

id

String

Specifies the hosted connection ID.

Minimum: 36

Maximum: 36

tenant_id

String

Specifies the ID of the project that the instance belongs to.

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, which 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 of the hosted connection. The options are as follows:

• BUILD: The hosted connection has been created.
• ACTIVE: The associated virtual gateway is normal.
• DOWN: The port used by the hosted connection is down, indicating that there may be line faults.
• ERROR: The associated virtual gateway 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.

create_time

String

Specifies when the connection was created.

provider_status

String

Specifies the status of the carrier's leased line. 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 a connection. The value can be standard (a standard connection), hosting (an operations connection) or hosted (a hosted connection).

Default: standard

Enumeration values:

• standard
• hosting
• hosted
• onestop_standard
• onestop_hosted

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 the value is empty, the resource is on the last page.

Minimum: 0

Maximum: 36

200

OK