Help Center/ CodeArts Deploy/ API Reference/ APIs/ Deployment Job Management/ Querying Deployment Job Triggering Rule Settings
Updated on 2025-10-16 GMT+08:00

Querying Deployment Job Triggering Rule Settings

Function

This API is used to query the job triggering rule settings according to the deployment job ID.

Calling Method

For details, see Calling APIs.

URI

GET /v2/task/trigger/detail

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition:

Deployment job ID. Obtain the application details by calling the API forobtaining the application details. In the response body, result.arrange_infos[0].id is the desired application details.

Constraints:

N/A

Range:

32 characters, including letters and digits.

Default Value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API used forObtaining a User Token.

Constraints:

N/A.

Value range:

String. Max. 20,000 characters.

Default value:

N/A.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

trigger_source

String

Definition:

Scenario where a deployment job can be executed.

Range:

  • 0: All execution requests can be executed.

  • 1: Execution can be triggered only by pipeline.

artifact_source_system

String

Definition:

Pipeline source when a job can be executed only by the pipeline.

Range:

Artifact: The source information is from CodeArts Artifact.

artifact_type

String

Definition:

Artifact repository type when a job can be executed only by the pipeline.

Range:

  • generic: Release repository.

  • docker: Docker repository.

Example Requests

Query the job triggering rule settings according to the deployment job ID.

https://{endpoint}/v2/task/trigger/detail?task_id=f21d58b563e04d6c8a79d015fadeb73

Example Responses

Status code: 200

OK indicates that the query of the deployment job triggering rule settings is successful.

{
  "trigger_source" : 1,
  "artifact_source_system" : "Artifact",
  "artifact_type" : "generic"
}

Status Codes

Status Code

Description

200

OK indicates that the query of the deployment job triggering rule settings is successful.

Error Codes

See Error Codes.