Help Center/ CodeArts Deploy/ API Reference/ APIs/ Application Management/ Obtaining Application Details (Recommended)

Updated on 2023-11-28 GMT+08:00

View PDF

Obtaining Application Details (Recommended)

Function

This API is used to obtain application details of a specified ID.

URI

GET /v1/applications/{app_id}/info

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
app_id	Yes	String	Application ID.

Request Parameters

**Table 2** Request header 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. Minimum: 0 Maximum: 20000

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
result	AppDetailInfo object	Application details.
status	String	Request success or failure status.

**Table 4** AppDetailInfo
Parameter	Type	Description
id	String	Application ID.
name	String	Application name. Minimum: 3 Maximum: 128
region	String	Region to which the application belongs.
description	String	Description. Minimum: 0 Maximum: 1024
create_type	String	Algorithm type.
project_id	String	Project ID. For details, see Obtaining a Project ID.
project_name	String	Project name. Minimum: 3 Maximum: 128
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 followed the application.
can_modify	Boolean	Whether you have the edit permission.
can_delete	Boolean	Whether you have the deletion permission.
can_view	Boolean	Whether you have the view permission.
can_execute	Boolean	Whether you have the deployment permission.
can_copy	Boolean	Whether you have the copy permission.
can_manage	Boolean	Whether you have permission to edit the application permission matrix.
can_create_env	Boolean	Whether you have the the permission to create an environment.
owner_tenant_id	String	Tenant ID of the application owner.
create_user_id	String	Username of the application creator.
create_tenant_id	String	Tenant ID of the application creator.
create_time	String	Creation time.
update_time	String	Modification time.
permission_level	String	Permission level.
arrange_infos	Array of TaskV2Info objects	Deployment task information.

**Table 5** TaskV2Info
Parameter	Type	Description
id	String	Deployment task ID.
name	String	Task name. Minimum: 3 Maximum: 128
state	String	Deployment task status.
description	String	Description. Minimum: 0 Maximum: 1024
owner	String	Owner of the deployment task.
steps	Map<String,Step>	Deployment procedure.
project_id	String	Project ID. For details, see Obtaining a Project ID.
project_name	String	Project name. Minimum: 3 Maximum: 128
deploy_system	String	Deployment type. Options: deployTemplate, ansible, and shell.
create_time	String	Creation time.
update_time	String	Modification time.
role_id	Integer	Role ID.
is_defaut_permission	Boolean	Whether the role is a default one.
template_id	String	Template ID.
nick_name	String	Alias of the application creator. Minimum: 0 Maximum: 128
owner_id	String	User ID of the application creator.
tenant_id	String	Tenant ID of the application creator.
tenant_name	String	Tenant name of the application creator. Minimum: 0 Maximum: 128
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 followed the application.
can_modify	Boolean	Whether you have the edit permission.
can_delete	Boolean	Whether you have the deletion permission.
can_view	Boolean	Whether you have the view permission.
can_execute	Boolean	Whether you have the deployment permission.
can_copy	Boolean	Whether you have the copy permission.
can_manage	Boolean	Whether you have permission to edit the application permission matrix.
can_create_env	Boolean	Whether you have the the permission to create an environment.
app_component_list	Array of AppComponentDao objects	Application component list.
release_id	Integer	Deployment record sequence number.
app_id	String	Application ID to which the deployment task belongs.

**Table 6** Step
Parameter	Type	Description
id	String	id
name	String	Name.
params	Map<String,String>	Parameter.
enable	Boolean	Whether the application is in enabled status.

**Table 7** AppComponentDao
Parameter	Type	Description
task_id	String	Deployment task ID.
app_id	String	AOM application ID.
app_name	String	AOM application name.
comp_id	String	AOM application component ID.
comp_name	String	AOM application component name. Minimum: 0 Maximum: 128
domain_id	String	Tenant ID.
region	String	Site information. Minimum: 1 Maximum: 256
state	String	Whether the AOM application component takes effect. 0 indicates that the component is initialized. 1 indicates that the execution is successful and the component has taken effect. Minimum: 1 Maximum: 32

Example Requests

https://{endpoint}/v1/applications/d2dc947ec2424d8789bb3984bb3adf45/info

Example Responses

Status code: 200

OK: The request is successful.

{
  "result" : {
    "id" : "d9e0532073e2475dbed64b22e64f3b26",
    "name" : "deployenv202308211530723",
    "region" : "cn-north-7",
    "description" : "for_test",
    "create_type" : "template",
    "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde",
    "project_name" : "Test Item",
    "slave_cluster_id" : null,
    "is_care" : false,
    "can_modify" : true,
    "can_delete" : true,
    "can_view" : true,
    "can_execute" : true,
    "can_copy" : true,
    "can_manage" : true,
    "can_create_env" : true,
    "owner_tenant_id" : "208fbb09068e4820b9209ef9ff4da73d",
    "create_user_id" : "6baa7454109d47c192f22078fe6cda20",
    "create_tenant_id" : "26a680dd72e7482eb60d2ef5513588bb",
    "create_time" : "2023-08-21 15:30:51.0",
    "update_time" : "2023-08-21 15:30:51.0",
    "permission_level" : "instance",
    "arrange_infos" : [ {
      "id" : "685a6f3b80264e7d96f2ba308f8414e5",
      "name" : "deployenv202308211530723",
      "state" : "Draft",
      "description" : "for_test",
      "owner" : "devcloud_devcloud_l00490255_01",
      "steps" : {
        "step1" : {
          "id" : null,
          "name" : "Installing Go",
          "params" : { },
          "enable" : true
        },
        "step2" : {
          "id" : null,
          "name" : "Software Package Download",
          "params" : { },
          "enable" : true
        },
        "step3" : {
          "id" : null,
          "name" : "Stopping the Go Service",
          "params" : { },
          "enable" : true
        },
        "step4" : {
          "id" : null,
          "name" : "Starting the Go Service",
          "params" : { },
          "enable" : true
        },
        "step5" : {
          "id" : null,
          "name" : "Health Test",
          "params" : { },
          "enable" : true
        }
      },
      "project_id" : "1ff8aa6dda4643bd9cbdbb588fb24bde",
      "project_name" : "Test Item",
      "deploy_system" : "deployTemplate",
      "create_time" : "2023-08-21 15:30:51",
      "update_time" : "2023-08-21 15:30:51",
      "role_id" : 0,
      "is_defaut_permission" : false,
      "template_id" : "681bd91f9d6e42cdb4cb84d6718de9fe",
      "nick_name" : "User Alias",
      "owner_id" : "6baa7454109d47c192f22078fe6cda20",
      "tenant_id" : "26a680dd72e7482eb60d2ef5513588bb",
      "tenant_name" : "devcloud_devcloud_l00490255_01",
      "slave_cluster_id" : null,
      "is_care" : false,
      "can_modify" : true,
      "can_delete" : true,
      "can_view" : true,
      "can_execute" : true,
      "can_copy" : true,
      "can_manage" : true,
      "can_create_env" : false,
      "app_component_list" : [ ],
      "release_id" : 0,
      "app_id" : "d9e0532073e2475dbed64b22e64f3b26"
    } ]
  },
  "status" : "success"
}