获取VPC防火墙预检查详情。
接口说明
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-cloudfirewall:DescribeVpcFirewallPrecheckDetail |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Lang |
string |
否 |
语言类型。取值：
|
zh |
| NetworkInstanceType |
string |
否 |
网络实例的类型。取值：
|
cen_firewall |
| VpcId |
string |
否 |
VPC 实例 ID。VpcId 与 TransitRouterId 至少须提供其一：查询基础 版防火墙时传 VpcId，查询转发路由器（TR）场景时传 TransitRouterId；两者均缺省时返回 ErrorParameters。 |
vpc-2zev8s8rxao33xt**** |
| Region |
string |
否 |
地域 ID。本接口实际上必填，缺失时返回 ErrorParameters。 |
cn-hangzhou |
| CenId |
string |
否 |
云企业网实例 ID。 |
cen-hxsqf2bv6di1a**** |
| TransitRouterId |
string |
否 |
转发路由器实例 ID。VpcId 与 TransitRouterId 至少须提供其一：查询基础 版防火墙时传 VpcId，查询转发路由器（TR）场景时传 TransitRouterId；两者均缺省时返回 ErrorParameters。 |
tr-2vcn4u2g86tm72**** |
| MemberUid |
string |
否 |
云防火墙成员账号的 UID。 |
134388541648**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| IsFound |
boolean |
是否存在任务。 |
false |
| PrecheckDetail |
object |
预检查的详细信息。 |
|
| NetworkInstanceId |
string |
网络实例 ID。 |
vpc-m5emh0w6v2e15**** |
| RegionNo |
string |
所在地域 ID。 |
cn-shanghai |
| FirewallId |
string |
防火墙实例 ID。 |
vfw-tr-7a9c8901ed394**** |
| PrecheckTimestamp |
string |
预检查时间戳。 |
1715136000 |
| PrecheckStatus |
string |
预检查状态。取值：
|
failed |
| PrecheckEntityGroups |
array<object> |
预检查环节的分组列表。 |
|
|
array<object> |
预检查环节的分组列表。 |
||
| Name |
string |
预检查实例名。 |
test |
| PrecheckEntities |
array<object> |
各预检查项的执行情况。 |
|
|
object |
各预检查项的执行情况。 |
||
| Name |
string |
预检查项目名称。 |
Precheck test |
| Status |
string |
各预检查项的状态。取值：
|
passed |
| Info |
string |
检查不通过的信息 |
VPC Firewall Quota Full |
| Suggestion |
string |
处理建议 |
The VPC firewall quota is full. We recommend that you increase the firewall quota |
| PrecheckEntityGroupStatus |
string |
预检查的状态。取值：
|
running |
| FailedCount |
integer |
预检查未通过的规则数量。 |
3 |
| RequestId |
string |
返回结果的请求 ID。 |
4FB718F0-CC04-5A12-B17B-188CFC3F**** |
示例
正常返回示例
JSON格式
{
"IsFound": false,
"PrecheckDetail": {
"NetworkInstanceId": "vpc-m5emh0w6v2e15****",
"RegionNo": "cn-shanghai",
"FirewallId": "vfw-tr-7a9c8901ed394****",
"PrecheckTimestamp": "1715136000",
"PrecheckStatus": "failed",
"PrecheckEntityGroups": [
{
"Name": "test",
"PrecheckEntities": [
{
"Name": "Precheck test",
"Status": "passed",
"Info": "VPC Firewall Quota Full",
"Suggestion": "The VPC firewall quota is full. We recommend that you increase the firewall quota"
}
],
"PrecheckEntityGroupStatus": "running",
"FailedCount": 3
}
]
},
"RequestId": "4FB718F0-CC04-5A12-B17B-188CFC3F****"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | ErrorAliUid | Aliuid invalid. | aliuid无效 |
| 400 | ErrorInvalidMemberUid | Member uid is invalid | 成员账号错误. |
| 400 | ErrorRegionNoError | Region is error, please reselect | 地域选择错误, 请重新输入 |
| 400 | ErrorParameters | A parameter error occurred. | 参数错误 |
| 400 | ErrorDBSelectError | A database select error occurred. | 内部错误：数据库查询错误 |
| 400 | ErrorPreCheckDoing | Pre-check in progress, please try again later. | |
| 400 | MissingParameter.VpcIdOrTransitRouterId | Either VpcId or TransitRouterId must be provided. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。