Obtaining the Details of an Application
Function
This API is used to obtain application details by deployment task ID. This API will not be maintained after September 30, 2024. You can use the ShowAppDetailById API instead.
Calling Method
For details, see Calling APIs.
URI
GET /v2/tasks/{task_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
task_id |
Yes |
String |
Deployment task ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Deployment task ID |
name |
String |
Application name |
project_id |
String |
Project ID. For details, see Obtaining a Project ID. |
project_name |
String |
Project name |
deploy_system |
String |
Deployment type. Options: deployTemplate, ansible, and shell. |
create_time |
String |
Creation time |
update_time |
String |
Modification time |
state |
String |
Application status: Draft and Available. |
execution_time |
String |
Last deployment time |
description |
String |
Description |
is_defaut_permission |
Boolean |
Whether to use the default permission matrix |
template_id |
String |
Template ID |
owner |
String |
Username of the application creator |
nick_name |
String |
Alias of the application creator |
owner_id |
String |
ID of the application creator |
tenant_id |
String |
Tenant ID of the application creator |
tenant_name |
String |
Tenant name of the application creator |
slave_cluster_id |
String |
Slave cluster ID. If the value is null, the default slave cluster is used. If slave is user-defined, the slave cluster ID is used. |
is_care |
Boolean |
Whether you have favorited the application |
can_modify |
Boolean |
Whether you have the edit permission |
can_delete |
Boolean |
Whether you have the delete permission |
can_view |
Boolean |
Whether you have the view permission |
can_execute |
Boolean |
Whether you have the deploy permission |
can_copy |
Boolean |
Whether you have the clone permission |
can_manage |
Boolean |
Whether you have permission to edit the application permission matrix |
can_disable |
Boolean |
Whether you have permission to disable applications |
app_component_list |
Array of AppComponentDao objects |
Mapping between applications and AOM application components |
role_id |
Integer |
Role ID. 0: Application creator. -1: Project creator. 3: Project manager. 4: Developer. 5: Test manager. 6: Tester. 7: Participant. 8: Viewer. |
id |
String |
Deployment task ID |
release_id |
Integer |
Deployment record sequence number |
is_disable |
Boolean |
Whether the application is disabled |
duration |
String |
Deployment time |
execution_state |
String |
Deployment status |
executor_id |
String |
Deployer ID |
executor_nick_name |
String |
Deployer name |
steps |
Map<String,Step> |
Deployment procedure |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Parameter description: Deployment application ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
app_id |
String |
Parameter description: AOM application ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
app_name |
String |
Parameter description: AOM application name. Value range: The value consists of letters and digits. |
comp_id |
String |
Parameter description: AOM application component ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
comp_name |
String |
Parameter description: AOM application component name. Value range: The value consists of 0 to 128 characters. |
domain_id |
String |
Parameter description: Tenant ID. Value range: The value consists of 32 characters. Letters and digits are allowed. |
region |
String |
Parameter description: Region information. Value range: The value consists of 1 to 256 characters. |
state |
String |
Parameter description: Whether the AOM application component takes effect. Value range:
|
Parameter |
Type |
Description |
---|---|---|
id |
String |
Parameter description: Action ID. Value range: N/A |
name |
String |
Parameter description: Action name. Value range: N/A |
params |
Map<String,String> |
Parameter description: Action parameter. Value range: N/A |
enable |
Boolean |
Parameter description: Whether an action is enabled. Value range:
|
Example Requests
https://{endpoint}/v2/tasks/d2dc947ec2424d8789bb3984bb3adf45
Example Responses
Status code: 200
OK: The request is successful.
{ "task_id" : "d2dc947ec2424d8789bb3984bb3adf45", "name" : "wyktest111", "state" : "Available", "description" : "111222", "owner" : "devcloud_devcloud_l00490255_01", "steps" : { "step1" : { "id" : "1583", "name" : "Select a deployment source", "params" : { }, "enable" : true }, "step2" : { "id" : "1293", "name" : "Health Test via URLs", "params" : { }, "enable" : true } }, "project_id" : "6039d4480efc4dddb178abff98719913", "project_name" : "wyk_test", "deploy_system" : "deployTemplate", "create_time" : "2021-04-01 17:07:49", "update_time" : "2021-05-17 11:26:58", "role_id" : 0, "is_defaut_permission" : false, "template_id" : "242ea879b3444b8391c3feb2e9c073de", "nick_name" : "A/B Side Account", "owner_id" : "6baa7454109d47c192f22078fe6cda20", "tenant_id" : "26a680dd72e7482eb60d2ef5513588bb", "tenant_name" : "devcloud_devcloud_l00490255_01", "slave_cluster_id" : "", "is_care" : false, "can_modify" : true, "can_delete" : true, "can_view" : true, "can_execute" : true, "can_copy" : true, "can_manage" : true, "can_disable" : false, "app_component_list" : [ ], "is_disable" : true }
SDK Sample Code
The SDK sample code is as follows.
Java
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 |
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 ShowDeployTaskDetailSolution { 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(); ShowDeployTaskDetailRequest request = new ShowDeployTaskDetailRequest(); request.withTaskId("{task_id}"); try { ShowDeployTaskDetailResponse response = client.showDeployTaskDetail(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
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 |
# 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 = ShowDeployTaskDetailRequest() request.task_id = "{task_id}" response = client.show_deploy_task_detail(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
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 |
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.ShowDeployTaskDetailRequest{} request.TaskId = "{task_id}" response, err := client.ShowDeployTaskDetail(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. |
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