开发指南

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

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,如果传了这个参数则只返回该环境的相关信息
IsVisible Boolean 指定Channels字段为可见渠道列表或不可见渠道列表
如只想获取渠道A的环境 就填写IsVisible= true,Channels = ["A"], 过滤渠道A拉取其他渠道环境时填写IsVisible= false,Channels = ["A"]
Channels.N Array of String 渠道列表,代表可见或不可见渠道由IsVisible参数指定

3. 输出参数

参数名称 类型 描述
EnvList Array of EnvInfo 环境信息列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询环境信息

输入示例

https://tcb.tencentcloudapi.com/?Action=DescribeEnvs
&EnvId=yourenvid-2fb346
&<公共请求参数>

输出示例

{
    "Response": {
        "EnvList": [
            {
                "EnvId": "yourenvid-2fb346",
                "Source": "miniapp",
                "Alias": "默认环境",
                "Status": "NORMAL",
                "PayMode": "postpaid",
                "Tags": [],
                "PackageName": "free",
                "IsAutoDegrade": true,
                "EnvChannel": "xx",
                "Region": "xx",
                "IsDefault": true,
                "PackageId": "free",
                "CreateTime": "2018-08-13 10:52:09",
                "UpdateTime": "2018-08-13 10:52:40",
                "LogServices": [],
                "StaticStorages": [],
                "Databases": [
                    {
                        "InstanceId": "default",
                        "Region": "ap-shanghai",
                        "Status": "RUNNING"
                    }
                ],
                "CustomLogServices": [
                    {
                        "ClsTopicId": "xx",
                        "ClsRegion": "xx",
                        "ClsLogsetId": "xx",
                        "CreateTime": "2020-09-22 00:00:00"
                    }
                ],
                "Storages": [
                    {
                        "Region": "ap-shanghai",
                        "Bucket": "yourenvid-2fb346-12532284",
                        "CdnDomain": "yourenvid-2fb346.tcb.qcloud.la",
                        "AppId": "xx"
                    }
                ],
                "Functions": [
                    {
                        "Namespace": "yourenvid-2fb346",
                        "Region": "ap-shanghai"
                    }
                ]
            }
        ],
        "RequestId": "75ec26f6-b624-40f1-a3f4-e724843f483e"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.UnauthorizedOperation 您没有查看该资源的权限。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.Action 接口名非法。
InvalidParameter.EnvId 环境ID非法。
MissingParameter 缺少参数错误。
MissingParameter.Param 缺少必要参数。
ResourceNotFound.UserNotExists 用户不存在。
目录