帮你快速理解、总结文档立即下载
文档中心>云开发 CloudBase>API 文档>环境相关接口>查询环境访问控制配置(域名来源)

查询环境访问控制配置(域名来源)

最近更新时间:2026-11-19 02:46:12
我的收藏

1. 接口描述

接口请求域名: tcb.tencentcloudapi.com 。

查询云开发域名访问限制配置,返回指定环境下公网、VPC、办公网三种来源的当前访问策略
(1)可以通过控制台调用查询域名访问控制。响应 Current 返回各来源(PUBLIC/VPC/WOA)当前生效的配置
(2)不产生写副作用

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeEnvAccessControl。
Version 是 String 公共参数,本接口取值:2018-06-08。
Region 否 String 公共参数,本接口不需要传递此参数。
EnvId 是 String

环境id


示例值:c*iaen-gy*g3***

3. 输出参数

参数名称 类型 描述
Current Array of AccessSourceSetting

修改之后,当前的生效的配置

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询域名访问权限配置

查询域名访问权限配置

输入示例

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

{
    "EnvId": "c*****i**a*en*-*g*y*g**3*******"
}

输出示例

{
    "Response": {
        "Current": [
            {
                "Action": "OPEN",
                "AuthToken": "",
                "SourceType": "PUBLIC",
                "VPCWhiteList": {
                    "Action": "",
                    "VPCs": null
                },
                "WOAAuth": ""
            }
        ],
        "RequestId": "33694abb-0e1e-4708-bcdb-db4d8dfdefe8"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DecryptAuthToken 读取/解密 WOA AuthToken 失败
FailedOperation.QueryAccessControl 查询访问来源控制配置失败
InternalError 内部错误。
InvalidParameter 参数格式或类型错误,如 Uin、EnvId、Domain 缺失或非法。
MissingParameter.Param 缺少必要参数。
ResourceNotFound.UserNotExists 用户不存在。