Querying Details About a Connection

Function

This API is used to query details about a connection.

URI

GET /v3/{project_id}/dcaas/direct-connects/{direct_connect_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

direct_connect_id

Yes

String

Specifies the connection ID.

Minimum: 36

Maximum: 36

project_id

Yes

String

Specifies the project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

fields

No

Array

Specifies the list of fields to be displayed.

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.

direct_connect

DirectConnect object

Specifies the connection.

Table 5 DirectConnect

Parameter

Type

Description

id

String

Specifies the connection ID.

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

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

bandwidth

Integer

Specifies the connection bandwidth, in Mbit/s.

Minimum: 2

Maximum: 100000

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

device_id

String

Specifies the ID of the device connected to the connection.

Minimum: 0

Maximum: 36

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

hosting_id

String

Specifies the ID of the operations connection on which the hosted connection is created.

charge_mode

String

Specifies the billing mode. The value can be prepayment, bandwidth, or traffic.

Enumeration values:

  • prepayment

  • bandwidth

  • traffic

provider

String

Specifies the line carrier of a connection.

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 connection status.

  • ACTIVE: The connection is in the normal state.

  • DOWN: The port for the connection is in the down state, which may cause line faults.

  • BUILD: Operations related to the connection are being performed.

  • ERROR: The connection configuration is incorrect. Contact customer service to rectify the fault.

  • PENDING_DELETE: The connection is being deleted.

  • DELETED: The connection has been deleted.

  • APPLY: A request for a connection is submitted.

  • DENY: A site survey is rejected because the customer fails to meet the requirements.

  • PENDING_PAY: The order for the connection is to be paid.

  • PAID: The order for the connection has been paid.

  • PENDING_SURVEY: A site survey is required for the connection.

Enumeration values:

  • BUILD

  • PAID

  • APPLY

  • PENDING_SURVEY

  • ACTIVE

  • DOWN

  • ERROR

  • PENDING_DELETE

  • DELETED

  • DENY

  • PENDING_PAY

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

peer_port_type

String

Specifies the peer port type.

peer_provider

String

Specifies the carrier of the leased line.

order_id

String

Specifies the connection order ID, which is used to support duration-based billing and identify user orders.

product_id

String

Specifies the product ID corresponding to the connection's order. The product ID is used to specify billing policies such as duration-based packages.

spec_code

String

Specifies the product specifications corresponding to the connection's order. The specifications are used to specify billing policies such as duration-based packages.

period_type

Integer

Specifies whether a connection in a specified order is billed by year or month.

period_num

Integer

Specifies the required service duration of a yearly/monthly connection.

vgw_type

String

Specifies the gateway type required by a connection.

Default: default

Enumeration values:

  • default

lag_id

String

Specifies the ID of the LAG that the connection belongs to.

signed_agreement_time

String

Specifies when the Direct Connect Disclaimers were signed.

enterprise_project_id

String

Specifies the ID of the enterprise project that the connection belongs to.

Minimum: 36

Maximum: 36

locales

LocalesBody object

Specifies the region of the connection. (This parameter is not supported currently.)

support_feature

Array of strings

Lists the features supported by the connection. (This parameter is not supported currently.)

ies_id

String

Specifies the edge site ID. (This parameter is not supported currently.)

reason

String

Displays error information if the status of a line is Error. (This parameter is not supported currently.)

email

String

Specifies the customer email information. (This parameter is not supported currently.)

onestop_product_id

String

Specifies the product ID if the connection is a full-service connection. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

building_line_product_id

String

Specifies the product ID of the line resource used in the equipment room. This parameter is used in line sales scenarios. (This parameter is not supported currently.)

last_onestop_product_id

String

Specifies the product ID of a full-service connection before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

last_building_line_product_id

String

Specifies the product ID of the line resource used in the equipment room before the change. This parameter is used in line sales scenarios and used to save the last record when the line bandwidth is changed. (This parameter is not supported currently.)

modified_bandwidth

Integer

Specifies the new bandwidth after the line bandwidth is changed. (This parameter is not supported currently.)

change_mode

Integer

Specifies the status of a renewal change. (This parameter is not supported currently.)

onestopdc_status

String

Specifies the status of a full-service connection. (This parameter is not supported currently.)

public_border_group

String

Specifies the public border group of the AZ, indicating whether the site is a HomeZones site. (This parameter is not supported currently.)

auto_renew

Integer

Specifies whether to automatically renew a yearly/monthly subscription. (This parameter is not supported currently.)

ratio_95peak

Integer

Specifies the percentage of the minimum bandwidth for 95th percentile billing. (This parameter is not supported currently.)

Minimum: 0

Maximum: 100

Table 6 LocalesBody

Parameter

Type

Description

en_us

String

Specifies the region name in English.

Minimum: 0

Maximum: 255

Example Requests

Querying a connection

GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects/6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a

Example Responses

Status code: 200

OK

  • The details of the connection are queried.

    {
  "direct_connect" : {
    "bandwidth" : 100,
    "create_time" : "2018-10-19T09:53:26.000Z",
    "port_type" : "10G",
    "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
    "apply_time" : "2018-10-19T09:53:26.000Z",
    "peer_location" : "",
    "peer_port_type" : null,
    "peer_provider" : null,
    "location" : "ExampleLocation",
    "provider" : "ExampleProvider",
    "type" : "standard",
    "status" : "BUILD",
    "description" : "",
    "provider_status" : "ACTIVE",
    "order_id" : "",
    "vlan" : null,
    "device_id" : "172.16.40.2",
    "name" : "direct connect1",
    "admin_state_up" : true,
    "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f",
    "hosting_id" : null,
    "product_id" : "",
    "vgw_type" : "default",
    "spec_code" : "100ge",
    "charge_mode" : null,
    "support_feature" : [ ],
    "ies_id" : null,
    "reason" : null,
    "email" : "cloud@example.com",
    "onestop_product_id" : null,
    "building_line_product_id" : null,
    "last_building_line_product_id" : null,
    "last_onestop_product_id" : null,
    "modified_bandwidth" : null,
    "change_mode" : null,
    "onestopdc_status" : null,
    "public_border_group" : "center",
    "auto_renew" : 0,
    "ratio_95peak" : null
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

last updated: 2024-11-08 14:02 UTC - commit: f65304f3bc08b9f6afa0abaf125b6427352d3bfa