1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
发起 VPC 集群防火墙预接入检查(仅支持自动接入模式)。入参与 ModifyClusterVpcFwSwitch 完全相同,传入相同的 CcnSwitch 配置 JSON 即可发起检查。检查为异步执行:接口立即返回 CheckItems 检查项清单,前端轮询 DescribeClusterVpcFwSwitchs 接口读取 CheckResult 获取各阶段的通过/失败状态。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CheckClusterVpcFwPreAccess。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| CcnSwitch.N | 是 | Array of CcnSwitchInfo | CCN 开关配置,长度为 1 的数组 JSON 字符串,结构与 ModifyClusterVpcFwSwitch 的 CcnSwitch 完全一致。SwitchMode 必须为 1(自动接入),RoutingMode 必须为 1(策略路由)。 |
| CheckMode | 是 | String | 预接入检查模式 枚举值:
示例值:open |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CheckItems | Array of ClusterFwPreAccessCheckItem | 检查项清单,按执行顺序返回。前端据此渲染检查项骨架,描述文案已按请求的 Language 返回对应语言(中文/英文)。检查通过轮询 DescribeClusterVpcFwSwitchs 接口读取 CheckResult 获取每个阶段的通过/失败状态。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 vpc 集群模式防火墙预接入检查
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckClusterVpcFwPreAccess
<公共请求参数>
{
"CcnSwitch": [
{
"CcnId": "ccn-c0qmm031",
"SwitchMode": 1,
"RoutingMode": 1,
"RegionCidrConfigs": [
{
"Region": "ap-shanghai",
"CidrMode": 2,
"CustomCidr": "10.100.1.0/26"
}
],
"InterconnectPairs": [
{
"GroupA": [
{
"InstanceId": "vpc-fj3e7nr8",
"InstanceType": "VPC",
"InstanceRegion": "ap-shanghai",
"AccessCidrMode": 1,
"AccessCidrList": [
"10.15.160.0/22"
]
}
],
"GroupB": [
{
"InstanceId": "vpc-fj3e7nr8",
"InstanceType": "VPC",
"InstanceRegion": "ap-shanghai",
"AccessCidrMode": 1,
"AccessCidrList": [
"10.15.160.0/22"
]
}
],
"InterconnectMode": "FullMesh"
}
],
"FwVpcCidr": ""
}
],
"CheckMode": "open"
}
输出示例
{
"Response": {
"CheckItems": [
{
"Description": "带宽配额检查",
"Stage": "vpc_bandwidth_check"
}
],
"RequestId": "90fa332b-8ec3-42bb-9ff3-558c9d9ba187"
}
}
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 | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |