DescribePrivateConnects

1. API Description

This API (DescribePrivateConnects) is used to get Private Connects

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
privateConnectIds	No	Array of String	List of Private Connect IDs. Up to 100 IDs supported per query.
privateConnectName	No	String	Private Connect name. Supports fuzzy matching.
connectivityStatus	No	ConnectivityStatus	Filter by connectivity status.
privateConnectStatus	No	BusinessStatus	Filter by Private Connect business status.
endpointTypes	No	Array of EndpointType	Filter by endpoint type.
resourceGroupId	No	String	Resource group ID. If not specified, Private Connects in all resource groups visible to the user are returned.
pageSize	No	Integer	Page size to return. Default: 20, maximum: 1000.
pageNum	No	Integer	Page number to return. Default: 1. Default value: 1
tagKeys	No	Array of String	Search by tag keys. Up to 20 tag keys.
tags	No	Array of Tag	Search by tags. Up to 20 tags.

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.
totalCount	Integer	Total number of Private Connects matching the criteria.
dataSet	Array of PrivateConnect	List of Private Connects.

4. Code Example

Example

1. Get the list of 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",
            "expiredTime":"2023-01-01T00:00:00Z",
            "privateConnectStatus":"RUNNING",
            "privateConnectName":"private-name",
            "source":"CONSOLE",
            "tags":{
                "tags":[
                    {
                        "key":"your-tag-key",
                        "value":"your-tag-value"
                    }
                ]
            },
            "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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

HTTP Status Code	Error Code	Description