Help Center/ CodeArts Deploy/ API Reference (Ally Region)/ APIs/ Managing Applications/ Querying the Execution Parameters of a Deployment Record
Updated on 2026-01-08 GMT+08:00
Online Debugging
CLI Examples
Share

Querying the Execution Parameters of a Deployment Record

Function

This API is used to query the execution parameters of a deployment record.

Calling Method

For details, see Calling APIs.

URI

GET /v2/history/tasks/{task_id}/params

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Parameter description:

Deployment application ID.

Constraints:

N/A

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

record_id

No

String

Parameter description:

Execution record ID.

Constraints:

N/A

Value range:

The value consists of 32 characters. Only letters and digits are allowed.

Default value:

N/A

Request Parameters

Table 3 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 for.

Constraints:

N/A.

Value range:

String. Max. 20,000 characters.

Default value:

N/A.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array of ConfigInfo objects

Definition:

Response body for querying deployment record execution parameters
Table 5 ConfigInfo

Parameter

Type

Description

name

String

Parameter description:

Parameter name.

Value range:

N/A

type

String

Definition:

Parameter type.

Value range:

  • text: String.

  • host_group: Environment.

  • enum: Enumeration.

  • encrypt: Private parameter.

value

String

Parameter description:

Parameter value.

Value range:

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

https://{endpoint}/v1/history/tasks/8e1eb7f010d4442ca150e3a1a5d96d94/params?record_id=8bcfde0419bf4d62b4676de99bcc7403

Example Responses

Status code: 200

OK: The request is successful.

[ {
  "name" : "service_port",
  "type" : "text",
  "value" : 8080
}, {
  "name" : "pwd",
  "type" : "encrypt",
  "value" : ""
}, {
  "name" : "env",
  "type" : "host_group",
  "value" : "4ed5be8d76f84f8bacdba9c8bd57ec92"
}, {
  "name" : "test_enum",
  "type" : "enum",
  "value" : "value1"
} ]

Status code: 400

Bad Request

{
  "error_code" : "Deploy.00015002",
  "error_msg" : "Invalid request parameter."
}

Status code: 403

Forbidden

{
  "error_code" : "Deploy.00011154",
  "error_msg" : "You do not have permissions to perform this operation."
}

Status Codes

Status Code

Description

200

OK: The request is successful.

400

Bad Request

403

Forbidden

Error Codes

See Error Codes.

Parent topic: Managing Applications