文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 用于判断请求是否从租户配置的内网vpcep过来
更新时间:2025-09-04 GMT+08:00
分享

用于判断请求是否从租户配置的内网vpcep过来

功能介绍

用于判断请求是否从租户配置的内网vpcep过来。

调用方法

请参见如何调用API

URI

GET /v1/vpcep-authorization

表1 Query参数

参数

是否必选

参数类型

描述

task_id

String

参数解释:

任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释:

结果状态。

取值范围:

ok:请求成功。

failed:请求失败。

data

VpcData object

参数解释:

判断请求是否从租户配置的内网vpcep过来的结果中的数据。

取值范围:

不涉及。

表4 VpcData

参数

参数类型

描述

enterprise_id

String

参数解释:

鉴权传入的租户id。

取值范围:

不涉及。

vpcep_id

String

参数解释:

鉴权传入的vpc终端节点的id。

取值范围:

不涉及。

result

String

参数解释:

请求结果。

取值范围:

Allow:允许。

Deny:拒绝。

config

Boolean

参数解释:

是否是配置。

取值范围:

"true":是配置

“false":不是配置。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

用于判断请求是否从租户配置的内网vpcep过来

GET https://{endpoint}/rest/v1/vpcep-authorization?task_id=fxxxx7ba3ae14a87a32b151bcbe20801

响应示例

状态码:200

Request succeeded!

{
  "status" : "ok",
  "data" : {
    "enterprise_id" : "389efb76b1354e4482eabeedxxxxxxxx",
    "vpcep_id" : "",
    "result" : "Allow",
    "config" : false
  }
}

状态码:400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙,请稍后再试"
}

状态码:401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档