1. 接口描述
接口请求域名： tcb.tencentcloudapi.com 。
获取环境列表，含环境下的各个资源信息。尤其是各资源的唯一标识，是请求各资源的关键参数
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeEnvs。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-08。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| EnvId | 否 | String | 环境ID，如果传了这个参数则只返回该环境的相关信息 示例值：yourenvid-2fb346 |
| IsVisible | 否 | Boolean | 指定Channels字段为可见渠道列表或不可见渠道列表 示例值：true |
| Channels.N | 否 | Array of String | 渠道列表，代表可见或不可见渠道由IsVisible参数指定 示例值：["ide","qc_console"] |
| Limit | 否 | Integer | 分页参数，单页限制个数 示例值：10 |
| Offset | 否 | Integer | 分页参数，偏移量 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| EnvList | Array of EnvInfo | 环境信息列表 |
| Total | Integer | 环境个数 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 分批查询环境信息
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEnvs
<公共请求参数>
{
"Limit": 50,
"Offset": 100
}输出示例
{
"Response": {
"EnvList": [
{
"Alias": "env-alias",
"CreateTime": "2026-04-16 10:32:21",
"CustomLogServices": [],
"Databases": [],
"EnvChannel": "wxrun",
"EnvId": "env-alias-3gf2x8bcb714facd",
"EnvType": "run",
"Functions": [],
"IsAutoDegrade": false,
"IsDauPackage": false,
"IsDefault": false,
"LogServices": [],
"Meta": [],
"PackageId": "",
"PackageName": "",
"PackageType": "normal",
"PayMode": "postpaid",
"PostgreSQL": [],
"Region": "ap-shanghai",
"Source": "miniapp",
"StaticStorages": [],
"Status": "NORMAL",
"Storages": [
{
"AppId": "",
"Bucket": "656e-env-alias",
"CdnDomain": "656e-env-alias.tcb.qcloud.la",
"ExternalStorage": {
"BasePath": "",
"BucketName": "",
"Enabled": false,
"Region": ""
},
"Region": "ap-shanghai"
}
],
"Tags": [],
"UpdateTime": "2026-04-16 10:32:35"
}
],
"Total": 10000,
"RequestId": "3c628980-0441-48d7-a9ca-850209a646c2"
}
}示例2 查询某个环境的信息
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEnvs
<公共请求参数>
{
"EnvId": "pg-cassieluliu-d5gmvd3id25eb60d6"
}输出示例
{
"Response": {
"EnvList": [
{
"Alias": "alias",
"CreateTime": "2026-05-08 16:31:20",
"CustomLogServices": [],
"Databases": [],
"EnvChannel": "qc_console",
"EnvId": "alis-d5gmvd3id25eb60d6",
"EnvType": "baas",
"Functions": [
{
"Namespace": "palis-d5gmvd3id25eb60d6",
"Region": "ap-shanghai"
}
],
"IsAutoDegrade": false,
"IsDauPackage": false,
"IsDefault": false,
"LogServices": [],
"Meta": [
{
"Key": "postgresql",
"Value": "enable"
}
],
"PackageId": "baas_personal",
"PackageName": "个人版",
"PackageType": "baas",
"PayMode": "prepayment",
"PostgreSQL": [
{
"InstanceName": "postgres-4**0*5*g",
"Name": "postgres",
"Region": "ap-shanghai",
"Status": 1,
"Version": "17.6"
}
],
"Region": "ap-shanghai",
"Source": "qcloud",
"StaticStorages": [
{
"Bucket": "14c1-st*tic-**-***********-d5g*******5**6**6****9***930",
"DefaultDirName": "",
"ExternalStorage": {
"BasePath": "",
"BucketName": "",
"Enabled": false,
"Region": ""
},
"Region": "ap-shanghai",
"StaticDomain": "asdas-1259548930.tcloudbaseapp.com",
"Status": "online"
}
],
"Status": "NORMAL",
"Storages": [
{
"AppId": "",
"Bucket": "7067-asasff-121412430",
"CdnDomain": "7067-asafsfafasf-id25eb60d6-112131430.tcb.qcloud.la",
"ExternalStorage": {
"BasePath": "",
"BucketName": "",
"Enabled": false,
"Region": ""
},
"Region": "ap-shanghai"
}
],
"Tags": [],
"UpdateTime": "2026-05-08 16:33:26"
}
],
"Total": 1,
"RequestId": "332159dc-278e-45b9-ba47-1444e3f35002"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | 您没有查看该资源的权限。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.Action | 接口名非法。 |
| InvalidParameter.EnvId | 环境ID非法。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.Param | 缺少必要参数。 |
| ResourceNotFound.UserNotExists | 用户不存在。 |
