Obtaining an Application List (Recommended)

Content-Type

Yes

String

Definition:

Type (or format) of the message body.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

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.

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Value range:

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

Default value:

N/A

page

Yes

Integer

Parameter description:

Page number, which means the query starts from this page.

Constraints:

N/A

Value range:

1-99,999

Default value:

N/A

size

Yes

Integer

Parameter description:

Number of items displayed on each page.

Constraints:

N/A

Value range:

1-100

Default value:

N/A

sort_name

No

String

Parameter description:

Sort field name.

Constraints:

N/A

Value range:

• name: Application name.

• startTime: Start time.

Default value:

N/A

sort_by

No

String

Parameter description:

Sorting sequence.

Constraints:

N/A

Value range:

• ASC: Ascending

• asc: Ascending

• DESC: Descending

• desc: Descending

Default value:

N/A

states

No

Array of strings

Parameter description:

Application status list.

Constraints:

N/A

Value range:

• abort: Deployment suspended

• failed: Deployment failed

• not_started: Execution canceled

• pending: Queuing

• running: Deployment in progress

• succeeded: Deployment succeeded

• timeout: Deployment times out

• not_executed: Deployment not executed

Default value:

N/A

group_id

No

String

Parameter description:

Application group ID. Enter no_grouped to query ungrouped applications.

Constraints:

N/A

Value range:

The value consists of 32 characters. Only letters and digits are allowed or the no_grouped value is transferred.

Default value:

N/A

total_num

Integer

Parameter description:

Total number of applications.

Value range:

N/A

result

Array of AppExecutionInfo objects

Parameter description:

Application list array.

id

String

Parameter description:

Application ID.

Value range:

The value consists of 32 characters. Letters and digits are allowed.

name

String

Parameter description:

Application name.

Value range:

The value consists of 3-128 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

duration

String

Definition:

Last deployment duration. Format: HH:mm:ss.

Value range:

N/A.

is_disable

Boolean

Parameter description:

Whether the application is disabled.

Value range:

• true: Disabled

• false: Not disabled

project_id

String

Parameter description:

Project ID.

Value range:

The value consists of 32 characters. Letters and digits are allowed.

project_name

String

Parameter description:

Project name.

Value range:

The value consists of 3 to 128 characters.

is_care

Boolean

Definition:

Whether you have favorited the application.

Value range:

• true: Yes.

• false: No.

can_modify

Boolean

Definition:

Whether you have the edit permission.

Value range:

• true: Yes.

• false: No.

can_delete

Boolean

Definition:

Whether you have the delete permission.

Value range:

• true: Yes.

• false: No.

can_view

Boolean

Definition:

Whether you have the view permission.

Value range:

• true: Yes.

• false: No.

can_execute

Boolean

Definition:

Whether you have the deployment permission.

Value range:

• true: Yes.

• false: No.

can_copy

Boolean

Definition:

Whether you have the copy permission.

Value range:

• true: Yes.

• false: No.

can_manage

Boolean

Definition:

Whether you have permission to edit the application permission matrix.

Value range:

• true: Yes.

• false: No.

can_create_env

Boolean

Definition:

Whether you have permission to create an environment.

Value range:

• true: Yes.

• false: No.

can_disable

Boolean

Definition:

Whether you have permission to disable applications.

Value range:

• true: Yes.

• false: No.

deploy_system

String

Parameter description:

Deployment mode.

Value range:

• deployTemplate: Deployment template

create_user_id

String

Parameter description:

ID of the application creator.

Value range:

The value consists of 1-32 characters. Letters and digits are allowed.

create_tenant_id

String

Parameter description:

Tenant ID of the application creator.

Value range:

The value consists of 1-32 characters. Letters and digits are allowed.

create_time

String

Parameter description:

Creation time. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27.

Value range:

N/A

update_time

String

Parameter description:

Modification time. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27.

Value range:

N/A

execution_time

String

Parameter description:

Last deployment time. The value format is yyyy-MM-dd HH:mm:ss. For example, 2021-02-25 10:37:27.

Value range:

N/A

end_time

String

Definition:

End time of the last deployment. Format: yyyy-MM-dd HH:mm:ss. Example: 2021-02-25 10:37:27.

Value range:

N/A.

execution_state

String

Definition:

Deployment status.

Value range:

• abort: Deployment stopped.

• failed: Deployment failed.

• not_started: Execution canceled.

• pending: Queuing.

• running: Deployment in progress.

• succeeded: Deployment succeeded.

release_id

Integer

Parameter description:

Deployment record sequence number.

Value range:

N/A

executor_id

String

Definition:

ID of the last deployer.

Value range:

1 to 32 characters, including letters and digits.

executor_nick_name

String

Definition:

Nickname of the last deployer.

Value range:

N/A.

arrange_infos

Array of TaskBaseResponseBody objects

Parameter description:

Deployment task information.

id

String

Parameter description:

Deployment application ID.

Value range:

The value consists of 32 characters. Letters and digits are allowed.

state

String

Definition:

Deployment application status.

Value range:

• Available: Executable status.

• Draft: Draft status.

• initialized: Initialization status.

deploy_system

String

Parameter description:

Deployment mode.

Value range:

• deployTemplate: Deployment template

error_code

String

Error code

error_msg

String

Error description

error_code

String

Error code

error_msg

String

Error description

200

OK: The request is successful.

400

Bad Request

403

Forbidden