Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Determining Whether the Request Is Sent from the Internal VPCEP Configured by the Tenant
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Determining Whether the Request Is Sent from the Internal VPCEP Configured by the Tenant

Function

This API is used to query whether the internal VPCEP security access is configured for the tenant to which the task belongs based on the task ID.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartscheck:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v1/vpcep-authorization

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

1 to 32 characters.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition :

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints:

N/A

Value range:

1–100,000 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition:

Result status.

Range:

ok: The request is successful.

failed: The request fails.

data

VpcData object

Definition:

Result data of determining whether the request is sent from the internal VPCEP configured by the tenant.

Range:

N/A
Table 4 VpcData

Parameter

Type

Description

enterprise_id

String

Definition:

Tenant ID for authentication.

Value range:

N/A

vpcep_id

String

Definition:

VPC endpoint ID for authentication.

Value range:

N/A

result

String

Definition:

Request result.

Value range:

Allow: The request is allowed.

Deny: The request is rejected.

config

Boolean

Definition:

Whether secure access via VPC Endpoint is configured.

Value range:

  • true: configured.

  • false: not configured.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

This API is used to determine whether the request is sent from the internal VPCEP configured by the tenant.

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

Example Responses

Status code: 200

Request succeeded!

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

Status code: 400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Task Management