ListApplication - Cloud Architect Design Tools - Alibaba Cloud Documentation Center

This operation returns a list of all applications that belong to the current user. You can use the optional `keyword` parameter to filter the applications by name.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bpstudio:ListApplication

get

*BPStudioVirtual

acs:bpstudio::{#accountId}:bpstudiovirtual/{#BPStudioVirtualId}

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	integer	Yes	The page number for the returned results. The value must be an integer from 1 to 10000.	1
MaxResults	integer	Yes	The number of entries to return on each page. The value must be an integer from 1 to 50.	10
Keyword	string	No	The keyword to search for in application names.	test
OrderType	integer	No	The sorting order. Valid values:1: Sort by update time. 2: Sort by creation time.	1
Status	string	No	The status of the application.	If the input value is "success", the returned application list includes all applications in the Deployed_Success state of successful deployment. If the input value is release, the returned application list includes all applications in the release success (Destroyed_Success) and release failure (Destroyed_Failure) status. If this parameter is left blank, the returned app list includes apps in all states.
ResourceGroupId	string	No	The ID of the resource group.	default
ResourceId	string	No	The ID of the resource.	vsw-xxxxxxxxxxxx
TemplateId	string	No	The ID of the template.	0KSXXX6SJU03TXXX
ShowHide	boolean	No	Specifies whether to show hidden applications. Default value: `true`.- `true`: Shows hidden applications.- `false`: Does not show hidden applications.	true

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries returned.	123
Message	string	The message returned for the request.	Success
NextToken	integer	The page number of the returned page.	2
RequestId	string	The ID of the request.	BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C
Data	array<object>	The list of applications.
	object
ImageURL	string	The URL of the application's topology graph.	https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/sr-Y3KR7ZSQZR2F0YX3.png
Status	string	The status of the application.	Deployed_Success
ApplicationId	string	The ID of the application.	JIX9NEZUALGS46UI
Name	string	The name of the application.	cadt-appName
CreateTime	string	The time when the application was created.	2021-09-15 08:30:00
ResourceGroupId	string	The ID of the resource group to which the application belongs.	default
Code	string	The HTTP status code.	200

The following list describes the possible statuses of an application.

Creating: Creating the application.
Modified: The application has been modified.
Verifying: Verifying the application.
Verified_Failure: Verification failed.
Verified_Success: Verification successful.
Evaluating: Evaluating the application.
Evaluating_Failure: Evaluation failed.
Evaluating_Success: Evaluation successful.
Deploying: Deploying the application.
Deployed_Failure: Deployment failed.
Partially_Deployed_Success: Partial deployment successful.
Deployed_Success: Deployment successful.
Destroying: Destroying the application.
Delayed_Destroy: Delayed destruction.
Destroyed_Failure: Destruction failed.
Partially_Destroyed_Success: Partial destruction successful.
Destroyed_Success: Destruction successful.
Revised: Architecture revised.
Verifying_In_Revision: Verifying resources for the revised architecture.
Verified_Failure_In_Revision: Resource verification failed for the revised architecture.
Verified_Success_In_Revision: Resource verification successful for the revised architecture.
Evaluating_In_Revision: Evaluating the revised architecture.
Evaluating_Failure_In_Revision: Evaluation failed for the revised architecture.
Evaluating_Success_In_Revision: Evaluation successful for the revised architecture.

Examples

Success response

JSON format

{
  "TotalCount": 123,
  "Message": "Success",
  "NextToken": 2,
  "RequestId": "BFB7F5C8-FE7A-06CA-9F87-ABBF6B848F0C",
  "Data": [
    {
      "ImageURL": "https://bp-studio-daily.oss-cn-beijing.aliyuncs.com/1411182597819805/sr-Y3KR7ZSQZR2F0YX3.png",
      "Status": "Deployed_Success",
      "ApplicationId": "JIX9NEZUALGS46UI",
      "Name": "cadt-appName",
      "CreateTime": "2021-09-15  08:30:00",
      "ResourceGroupId": "default"
    }
  ],
  "Code": "200"
}

Error codes

HTTP status code	Error code	Error message	Description
200	Success	The transaction is successful.
400	ParameterEmpty	You must specify the request parameter.	You must specify request parameters.
500	ServiceError	A server error occurred. Please try again later.
404	EntityNotExist.ResourceGroup	The resource group does not exist.
404	EntityNotExist.ResourceId	The resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.