tencent cloud

APIs

DocumentaçãoAPIsEdge ZoneNetwork APIsDescribePrivateNetworkInstances

查询私网实例

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-05-26 23:12:37

1. 接口描述

接口请求域名: edgezone.intl.tencentcloudapi.com 。

查询私网实例,支持通过私网实例ID、私网实例名称、可用区ID等参数进行查询

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribePrivateNetworkInstances。
Version 是 String 公共参数,本接口取值:2026-04-01。
Region 是 String 公共参数,详见产品支持的 地域列表。
NetworkInstanceId 否 String 私网实例Id
NetworkInstanceName 否 String 新实例名称
ZoneId 否 String 可用区ID
Offset 否 Integer 分页偏移量,默认0
Limit 否 Integer 每页数量,默认 20,最大 100

3. 输出参数

参数名称 类型 描述
TotalCount Integer 私网实例总数
PrivateNetworkInstanceSet Array of PrivateNetworkInstanceInfo 私网实例集合
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 根据可用区查询私网实例

输入示例

POST / HTTP/1.1
Host: edgezone.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrivateNetworkInstances
<公共请求参数>

{
    "ZoneId": "ap-beijing",
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "RequestId": "test-req-013",
        "TotalCount": 1,
        "PrivateNetworkInstanceSet": [
            {
                "NetworkInstanceId": "ein-a1b2c3d4",
                "ZoneId": "ap-beijing-a",
                "NetworkInstanceName": "test-pri-instance",
                "Network": "10.0.0.0",
                "Mask": 24,
                "ServerCount": 3,
                "AvailableIpCount": 251,
                "CreatedAt": "2026-04-07T00:00:00",
                "UpdatedAt": "2026-04-07T00:00:00"
            }
        ]
    }
}

5. 开发者资源

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。

Ajuda e Suporte

Esta página foi útil?

comentários