Qin Ying, Fan 62ab8a5fe2 DC API 20231101 version

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>

2024-03-11 15:10:40 +00:00

9.4 KiB

Raw Permalink Blame History

Querying the Connection List

Function

This API is used to query the connection list.

URI

GET /v2.0/dcaas/direct-connects

**Table 1** Parameter description
Parameter	Type	Mandatory	Description
direct_connects	List	Yes	Specifies the connection list.

Request

Table 2 lists the request parameter.

**Table 2** Request parameter
Parameter	Type	Mandatory	Description
fields	String	No	Specifies the parameters expected to be returned. If you do not specify it, all parameters will be returned.

Response

Table 3 lists the response parameter.

**Table 3** Response parameter
Parameter	Type	Description
direct_connects	List	Specifies the connection list.

For details about the direct_connects field, see Table 1.

Examples

Example request

Querying all connections

GET /v2.0/dcaas/direct-connects

Querying a connection using its ID

GET /v2.0/dcaas/direct-connects?id=6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a

Example response

{ 
        "direct_connects" : [{ 
        "name": "direct connect",
        "id": "294ebeeb-62dd-4ece-99f5-73055df6d835",
        "description": "",
        "tenant_id": "0605768ad980d5762f8ac010b919754c",
        "type": "hosted",
        "hosting_id": "0e85c677-6eb5-4ef6-87a7-74d4586be895",
        "vlan": 228,
        "charge_mode": null,
        "port_type": "1G",
        "bandwidth": 2,
        "location": "Biere",
        "peer_location": "",
        "device_id": "18.8.215.131",
        "interface_name": "Eth-Trunk2",
        "redundant_id": null,
        "provider": "OTC",
        "provider_status": "ACTIVE",
        "status": "ACTIVE",
        "apply_time": "2022-12-08T01:59:36.000Z",
        "reason": null,
        "admin_state_up": true,
        "order_id": null,
        "product_id": null,
        "spec_code": null,
        "applicant": null,
        "mobile": null,
        "email": null,
        "create_time": "2022-12-08T01:59:36.000Z",
        "region_id": null,
        "service_key": null,
        "cable_label": null,
        "peer_port_type": null,
        "peer_provider": null,
        "onestop_product_id": null,
        "building_line_product_id": null,
        "last_onestop_product_id": null,
        "period_type": null,
        "period_num": null,
        "vgw_type": "default",
        "lag_id": null
    }] 
}

Status Codes

For details, see Common Status Codes.

Parent topic: Connection

9.4 KiB Raw Permalink Blame History