DescribePrivateConnects

1. API Description

This API is used to query information of one or more Layer 2 private connects. You can filter the query results with private connect ID, name, and etc.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

privateConnectIds

No

Array of String

Private connect ID(s). You can query up to 100 IDs in each request.

privateConnectName

No

String

Private connect name. Fuzzy search is supported.

connectivityStatus

No

String

Connectivity state. See ConnectionStatus for valid value.

privateConnectStatus

No

String

Private connect state. See privateConnectStatus for valid value.

endpointTypes

No

Array of String

Access point type in private connect.

See EndpointType for valid value.

resourceGroupId

No

String

Resource group ID.

If the value is null, then return all the private connects in the authorized resource groups.

pageNum

No

Integer

Number of pages returned.

Default value: 1.

pageSize

No

Integer

Number of items in the current page result.

Default value: 20;

Maximum value: 1000.

3. Output Parameters

Parameter Name
Type
Description

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

dataSet

Information on private connects.

totalCount

Integer

Number of private connects meeting the filtering conditions.

4. Code Example

Query information of Layer 2 private connects.

POST /api/v2/sdn HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribePrivateConnects
<Common Request Params>

Request:
{}

Response:
{   
  "requestId": "TDB181167-C39F-4C3E-8E88-B8FDE755FDC0",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
     "dataSet": [
         {
            "endpointA":{
                "endpointType":"PORT",
                "dataCenter":{
                    "dcId":"SIN1",
                    "cityName":"Singapore",
                    "areaName":"Asia Pacific",
                    "dcName":"Equinix_SG1",
                    "dcAddress":"20 Ayer Rajah Crescent, Ayer Rajah Industrial Park, Singapore 139964",
                    "countryName":"Singapore"
                },
                "vlanId":"1001",
                "endpointId":"endpoint A id",
                "endpointName":"portName",
                "connectivityStatus":"ACTIVE"
            },
            "resourceGroupName":"Default Resource Group",
            "createTime":"2023-01-01T00:00:00Z",
            "privateConnectStatus":"RUNNING",
            "privateConnectName":"private-name",
            "endpointZ":{
                "endpointType":"PORT",
                "dataCenter":{
                    "dcId":"SIN1",
                    "cityName":"Singapore",
                    "areaName":"Asia Pacific",
                    "dcName":"Equinix_SG1",
                    "dcAddress":"20 Ayer Rajah Crescent, Ayer Rajah Industrial Park, Singapore 139964",
                    "countryName":"Singapore"
                },
                "vlanId":1002,
                "endpointId":"endpoint z id",
                "endpointName":"SIN1-10G",
                "connectivityStatus":"ACTIVE"
            },
            "resourceGroupId":"resource-group-id",
            "privateConnectId":"private-connect-id",
            "connectivityStatus":"ACTIVE",
            "bandwidthMbps":10
        }
     ],
     "totalCount": 1
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​

Last updated