Obtaining an Application List (Recommended)
Function
This API is used to query an application list in a project.
Calling Method
For details, see Calling APIs.
URI
POST /v1/applications/list
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
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 forObtaining a User Token. Constraints: N/A. Value range: String. Max. 20,000 characters. Default value: N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Parameter description: Project ID. For details, see [Obtaining a Project ID] (CloudDeploy_api_0014.xml). 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:
Default value: N/A |
sort_by |
No |
String |
Parameter description: Sorting sequence. Constraints: N/A Value range:
Default value: N/A |
states |
No |
Array of strings |
Parameter description: Application status list. Constraints: N/A Value range:
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 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Parameter description: Total number of applications. Value range: N/A |
result |
Array of AppExecutionInfo objects |
Parameter description: Application list array. |
Parameter |
Type |
Description |
---|---|---|
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:
|
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:
|
can_modify |
Boolean |
Definition: Whether you have the edit permission. Value range:
|
can_delete |
Boolean |
Definition: Whether you have the delete permission. Value range:
|
can_view |
Boolean |
Definition: Whether you have the view permission. Value range:
|
can_execute |
Boolean |
Definition: Whether you have the deployment permission. Value range:
|
can_copy |
Boolean |
Definition: Whether you have the copy permission. Value range:
|
can_manage |
Boolean |
Definition: Whether you have permission to edit the application permission matrix. Value range:
|
can_create_env |
Boolean |
Definition: Whether you have permission to create an environment. Value range:
|
can_disable |
Boolean |
Definition: Whether you have permission to disable applications. Value range:
|
deploy_system |
String |
Parameter description: Deployment mode. Value range:
|
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:
|
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. |
Parameter |
Type |
Description |
---|---|---|
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:
|
deploy_system |
String |
Parameter description: Deployment mode. Value range:
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
Example Requests
This API is used to obtain an application list.
https://{endpoint}/v1/applications/list { "project_id" : "6039d4480efc4dddb178abff98719913", "page" : 1, "size" : 10 }
Example Responses
Status code: 200
OK: The request is successful.
{ "result" : [ { "id" : "cb439d016d8641c8a44c177a121fad15", "name" : "Test", "duration" : "00:00:17", "is_disable" : true, "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde", "project_name" : "Project 1", "is_care" : false, "can_modify" : true, "can_delete" : true, "can_view" : true, "can_execute" : true, "can_copy" : true, "can_manage" : false, "can_create_env" : false, "can_disable" : false, "create_user_id" : "04ec4661a8df4359b50980a9c958c86d", "create_tenant_id" : "208fbb09068e4820b9209ef9ff4da73d", "create_time" : "2023-07-05 20:34:40.0", "update_time" : "2023-08-02 14:20:30.0", "execution_time" : "2023-08-18 09:40:16", "end_time" : "2023-08-18 09:40:33", "execution_state" : "failed", "release_id" : 4, "executor_id" : "6baa7454109d47c192f22078fe6cda20", "executor_nick_name" : "Test Account", "arrange_infos" : [ { "id" : "e700f15965694253940502911220d76b", "state" : "Draft", "deploy_system" : "deployTemplate" } ] } ], "total_num" : 1 }
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." }
SDK Sample Code
The SDK sample code is as follows.
Java
This API is used to obtain an application list.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.codeartsdeploy.v2.region.CodeArtsDeployRegion; import com.huaweicloud.sdk.codeartsdeploy.v2.*; import com.huaweicloud.sdk.codeartsdeploy.v2.model.*; public class ListAllAppSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>")) .build(); ListAllAppRequest request = new ListAllAppRequest(); ListAllAppRequestBody body = new ListAllAppRequestBody(); body.withSize(10); body.withPage(1); body.withProjectId("6039d4480efc4dddb178abff98719913"); request.withBody(body); try { ListAllAppResponse response = client.listAllApp(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
This API is used to obtain an application list.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsdeploy.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = CodeArtsDeployClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAllAppRequest() request.body = ListAllAppRequestBody( size=10, page=1, project_id="6039d4480efc4dddb178abff98719913" ) response = client.list_all_app(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
This API is used to obtain an application list.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsdeploy.NewCodeArtsDeployClient( codeartsdeploy.CodeArtsDeployClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAllAppRequest{} request.Body = &model.ListAllAppRequestBody{ Size: int32(10), Page: int32(1), ProjectId: "6039d4480efc4dddb178abff98719913", } response, err := client.ListAllApp(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
OK: The request is successful. |
400 |
Bad Request |
403 |
Forbidden |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot