# 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.

<table><thead><tr><th width="195.6944979547184">Parameter Name</th><th width="111.734375">Required</th><th width="105">Type</th><th>Description</th></tr></thead><tbody><tr><td>privateConnectIds</td><td>No</td><td>Array of String</td><td>Private connect ID(s).<br>You can query up to 100 IDs in each request.</td></tr><tr><td>privateConnectName</td><td>No</td><td>String</td><td>Private connect name.<br>Fuzzy search is supported.</td></tr><tr><td>connectivityStatus</td><td>No</td><td>String</td><td>Connectivity state.<br>See <a href="/pages/QGlc5uBFvAM7iixepjmI#connectionstatus"><code>ConnectionStatus</code></a> for valid value.</td></tr><tr><td>privateConnectStatus</td><td>No</td><td>String</td><td>Private connect state.<br>See <a href="/pages/QGlc5uBFvAM7iixepjmI#privateconnectstatus">privateConnectStatus</a> for valid value.</td></tr><tr><td>endpointTypes</td><td>No</td><td>Array of String</td><td><p>Access point type in private connect.</p><p>See <a href="/pages/QGlc5uBFvAM7iixepjmI#endpointtype">EndpointType</a> for valid value.</p></td></tr><tr><td>resourceGroupId</td><td>No</td><td>String</td><td><p>Resource group ID.</p><p>If the value is null, then return all the private connects in the authorized resource groups.</p></td></tr><tr><td>tagKeys</td><td>No</td><td>Array of String</td><td><p>Query using tag keys.</p><p>A maximum of 20 tag keys can be used.</p></td></tr><tr><td>tags</td><td>No</td><td>Array of <a href="/pages/QGlc5uBFvAM7iixepjmI#tag">Tag</a></td><td><p>Query using tags.</p><p>A maximum of 20 tags can be used.</p></td></tr><tr><td>pageNum</td><td>No</td><td>Integer</td><td><p>Number of pages returned.</p><p>Default value: 1.</p></td></tr><tr><td>pageSize</td><td>No</td><td>Integer</td><td><p>Number of items in the current page result.</p><p>Default value: 20;</p><p>Maximum value: 1000.</p></td></tr></tbody></table>

## 3. Output Parameters

<table><thead><tr><th width="191.33333333333331">Parameter Name</th><th width="228.9310130515849">Type</th><th>Description</th></tr></thead><tbody><tr><td>requestId</td><td>String</td><td>The unique request ID, which is returned for each request. RequestId is required for locating a problem.</td></tr><tr><td>dataSet</td><td>Array of <a href="/pages/QGlc5uBFvAM7iixepjmI#privateconnect">PrivateConnect</a></td><td>Information on private connects.</td></tr><tr><td>totalCount</td><td>Integer</td><td>Number of private connects meeting the filtering conditions.</td></tr></tbody></table>

## 4. Code Example

{% tabs %}
{% tab title="Example" %}
**Query information of Layer 2 private connects.**

```json
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
  }
}
```

{% endtab %}
{% endtabs %}

## 5. Developer Resources

Zenlayer Cloud API 2.0 integrates [SDKs](/api-reference/api-introduction/toolkit/api-sdk.md) 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](/api-reference/api-introduction/instruction/commonerrorcode.md).​


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.console.zenlayer.com/api-reference/networking/sdn/private-connect/describeprivateconnects.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.