边缘安全加速平台 EO 查询环境信息

1. 接口描述

接口请求域名： teo.tencentcloudapi.com 。

在版本管理模式下，用于查询环境信息，可获取环境 ID、类型、当前生效版本等。版本管理功能内测中，当前仅白名单开放。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeEnvironments。
Version	是	String	公共参数，本接口取值：2022-09-01。
Region	否	String	公共参数，此参数为可选参数。
ZoneId	是	String	站点 ID。

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	环境总数。
EnvInfos	Array of EnvInfo	环境列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询版本发布环境列表

查询站点 ID 为 zone-2k3lomh6sdcb 的站点的环境列表信息。

输入示例

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

{
    "ZoneId": "zone-2k3lomh6sdcb"
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "EnvInfos": [
            {
                "EnvId": "env-2kplomhisdcb",
                "EnvType": "production",
                "Status": "running",
                "Scope": [
                    "ALL"
                ],
                "CreateTime": "2023-09-21T00:00:00+00:00",
                "UpdateTime": "2023-09-22T00:00:00+00:00",
                "CurrentConfigGroupVersionInfos": [
                    {
                        "VersionId": "ver-2k3lomh6sdcb",
                        "VersionNumber": "1.0",
                        "GroupId": "cg-2k3lomh6sdcb",
                        "GroupType": "l7_acceleration",
                        "Description": "用于生产",
                        "Status": "active",
                        "CreateTime": "2023-09-22T00:00:00+00:00"
                    }
                ]
            }
        ],
        "RequestId": "9bd9c732-0f9a-4cd3-a3e8-1e9db5e53631"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

查询环境信息

本页目录：