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

修改环境访问控制配置(域名来源)

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

1. 接口描述

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

云开发域名访问限制配置
(1)影响指定环境下域名来源访问策略,包含公网与 VPC 白名单
(2)关闭公网访问后,云开发提供的默认域名在公网访问场景下返回403
(3)可以通过配置 VPC 白名单指定放通特定 VPC 来源的请求
(4)可以通过云开发控制台调用修改访问配置,修改后可通过查询接口核对生效配置

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

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

2. 输入参数

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

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

环境id


示例值:colei-get**dfee49
Sources.N 是 Array of AccessSourceSetting

本次要设置的来源集合

入参限制:SourceType = PUBLIC 时,标识操作公网开关
SourceType = VPC 时,通过配置 VPCWhiteList,开启/关闭 VPC 白名单
SourceType = WOA 时,通过配置 WOAAuth,开启/关闭鉴权校验,开启鉴权时,AuthToken 字段为填

3. 输出参数

参数名称 类型 描述
AffectedRows Integer

本次请求影响的权限数量


示例值:2
Current Array of AccessSourceSetting

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

SourceType = PUBLIC 表示公网链路访问配置
SourceType = VPC 表示 VPC 链路访问配置
SourceType = WOA 表示办公网链路访问配置

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

4. 示例

示例1 关闭 VPC 白名单

关闭 VPC 白名单

输入示例

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

{
    "EnvId": "co*le*i*-*ge*t***********dfee49",
    "Sources": [
        {
            "SourceType": "VPC",
            "Action": "OPEN",
            "VPCWhiteList": {
                "Action": "CLOSE"
            }
        }
    ]
}

输出示例

{
    "Response": {
        "AffectedRows": 0,
        "Current": [
            {
                "Action": "OPEN",
                "AuthToken": "",
                "SourceType": "PUBLIC",
                "VPCWhiteList": {
                    "Action": "",
                    "VPCs": null
                },
                "WOAAuth": ""
            }
        ],
        "RequestId": "a57000c9-4d54-4626-9012-819801270a6b"
    }
}

示例2 关闭公网访问

关闭公网访问

输入示例

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

{
    "EnvId": "****e******ent-7gtyygbr36dfee49",
    "Sources": [
        {
            "SourceType": "PUBLIC",
            "Action": "CLOSE"
        }
    ]
}

输出示例

{
    "Response": {
        "AffectedRows": 2,
        "Current": [
            {
                "Action": "CLOSE",
                "AuthToken": "",
                "SourceType": "PUBLIC",
                "VPCWhiteList": {
                    "Action": "",
                    "VPCs": null
                },
                "WOAAuth": ""
            }
        ],
        "RequestId": "f44ad4d2-72c9-46a6-8cec-d951b2998159"
    }
}

示例3 配置 VPC 白名单

配置 VPC 白名单

输入示例

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

{
    "EnvId": "***********ent-7gtyygbr36dfee49",
    "Sources": [
        {
            "SourceType": "VPC",
            "Action": "OPEN",
            "VPCWhiteList": {
                "Action": "OPEN",
                "VPCs": [
                    {
                        "UniqVpcId": "vpc-********",
                        "Region": "ap-shanghai"
                    }
                ]
            }
        }
    ]
}

输出示例

{
    "Response": {
        "AffectedRows": 0,
        "Current": [
            {
                "Action": "OPEN",
                "AuthToken": "",
                "SourceType": "PUBLIC",
                "VPCWhiteList": {
                    "Action": "",
                    "VPCs": null
                },
                "WOAAuth": ""
            }
        ],
        "RequestId": "92285e0b-e1db-4a40-b8bc-6bc32cd01362"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CheckFeaturePermission 套餐功能权限校验调用失败
FailedOperation.QueryVPC 查询 VPC 信息失败(地域/账号信息/vpcoss 异常)
FailedOperation.SaveAuthToken 保存 WOA AuthToken 失败(含加密失败)
FailedOperation.SaveVPCWhiteList 保存 VPC 白名单失败
FailedOperation.UpdateAccessControl 更新访问来源控制开关失败
InternalError 内部错误。
InvalidParameter 参数格式或类型错误,如 Uin、EnvId、Domain 缺失或非法。
InvalidParameter.AccessSource 来源配置不合法:Sources 为空/超限、SourceType 非法或重复、Action 非法
InvalidParameter.AuthToken WOA 鉴权配置不合法:WOAAuth 非法、强制鉴权缺少 AuthToken、AuthToken 超长
InvalidParameter.VPCWhiteList VPC 白名单不合法:Action/UniqVpcId/Region 非法、条数超限、非 vpc 来源携带白名单
MissingParameter.Param 缺少必要参数。
OperationDenied.FreePackageDenied 免费套餐拒绝此操作
ResourceNotFound.UserNotExists 用户不存在。
ResourceNotFound.VPC VPC 在指定地域下不存在
UnauthorizedOperation.VPCNotOwned VPC 不属于当前账号