GetApplication - Cloud Architect Design Tools - Alibaba Cloud Documentation Center

Retrieves the basic information, validation results, billing results, and deployment results of a specified application.

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:GetApplication

get

*Application

acs:bpstudio::{#accountId}:application/{#ApplicationId}

None

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	Yes	The application ID.	VVK605ZH00OA4MRT
ResourceGroupId	string	No	The resource group ID.	rg-acfmyjt3c5om3hi

Response elements

Element	Type	Description	Example
	object
Message	string	The reason why the request failed.	Success
RequestId	string	The request ID.	A07FFDF2-78FA-1B48-9E38-88E833A93187
Data	object	The application details.
Description	string	The description of the application.	remark
ImageURL	string	The URL of the image in the database.	https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png
ApplicationId	string	The application ID.	VVK605ZH00OA4MRT
Name	string	The application name.	CADT
TemplateId	string	The ID of the template that is associated with the application.	FYS9VZ535U20V7HT
CreateTime	string	The time when the application was created.	2021-08-09 14:37:16
ResourceGroupId	string	The ID of the resource group to which the application belongs.	rg-aekzhfgmw4e6fwq
PriceList	array<object>	The list of billing results.
	object
ResourceCode	string	The product code.	ecs
InstanceName	string	The instance name.	ecs
OriginalPrice	number	The original price.	3.570
OnePrice	number	The unit price.	0.01
Period	integer	The duration.	1
Count	integer	The quantity.	1
PriceUnit	string	The unit of the price. USD/hour	200/hour
Price	number	The total price.	0.01
ChargeType	string	The billing method.	PayAsYouGo
Region	string	The region.	cn-hangzhou
Specification	string	The instance specification. For example, for a VPC, a CIDR block such as "192.168.0.0/16" is returned. For an ECS instance, an instance type such as "ecs.g5.large" is returned. For an SLB instance, an instance type such as "slb.s1.small" is returned. If the instance does not have a specification property, an empty string is returned.	"slb.s1.small" "192.168.0.0/24" "ecs.c6.large" "normal" ""
Lifecycle	string	The resource tag.	Create
Remark	string	The error message that is returned when the price inquiry fails.	ecs Sold Out
type	string	The creation type. Valid values: 1: Create 2: Import	1
Checklist	array<object>	The list of validation results.
	object	The list of validation results.
ResourceCode	string	The product code.	vpc
ResourceName	string	The instance name.	vpc
Region	string	The region.	cn-hangzhou
Result	string	The validation result.	Finish
Remark	string	The reason for the failure.	Verification passed
Specification	string	The specification.	192.168.0.0/16
Lifecycle	string	The resource tag.	Create
Status	string	The application status.	Deployed_Success
ResourceList	array<object>	The list of resources.
	object	The list of resources.
Status	string	The deployment result of the resource.	Finish
ResourceCode	string	The product code.	ecs
ResourceName	string	The instance name.	ecs
ResourceId	string	The instance ID.	i-2zehnzxqixu1pywsfbx1
ChargeType	string	The billing method.	PayAsYouGo
ResourceType	string	The resource type.	ecs
Remark	string	The deployment result.	{"hostName":"iZ2zehnzxqixu1pywsfbx1Z","memory":32768.0,"creationTime":"2021-09-28T11:23:46Z","instanceName":"ecs","internetMaxBandwidthOut":0.0,"description":"","clusterId":"","private_ip":"192.168.0.247","instanceId":"i-2zehnzxqixu1pywsfbx1","requestId":"F1C64344-3723-51A0-855B-5F08B5634323","zoneId":"cn-beijing-b","ioOptimized":"optimized","id":"i-2zehnzxqixu1pywsfbx1","instanceNetworkType":"vpc","instanceChargeType":"PostPaid","imageId":"centos_8_4_x64_20G_alibase_20210824.vhd","serialNumber":"cee246c4-38f3-4bf3-950b-c17e88ff6527","vlanId":"","instanceType":"ecs.e3.large","cpu":4.0,"creditSpecification":"","internetMaxBandwidthIn":-1.0,"expiredTime":"2099-12-31T15:59Z","internetChargeType":"PayByTraffic","regionId":"cn-beijing","refId":"79224644_0","stoppedMode":"Not-applicable","status":"Running"}
Lifecycle	string	The resource tag.	Create
NodeLabel	string
Error	string	The reason for the failure.	Success
DeployPercent	number	The deployment progress.	0.8
ComplianceList	array<object>	The compliance check results.
	array<object>
Rules	array<object>	The check results.
	object
ruleId	string	The rule ID.	ecs-instances-in-vpc
ruleDetail	string	The rule name.
ResourceName	string	The resource name.	ecs
ResourceCode	string	The product code.	ecs
Code	string	The response code.	200

Application statuses:

Creating: The application is being created.
Modified: The application has been modified.
Verifying: The application is being validated.
Verified_Failure: Validation failed.
Verified_Success: Validation is successful.
Valuating: The price is being calculated.
Valuating_Failure: Price calculation failed.
Valuating_Success: Price calculation is successful.
Deploying: The application is being deployed.
Deployed_Failure: Deployment failed.
Partially_Deployed_Success: The application has been partially deployed.
Deployed_Success: The deployment is successful.
Destroying: The application is being released.
Delayed_Destroy: The application is scheduled to be released.
Destroyed_Failure: The release failed.
Partially_Destroyed_Success: The application has been partially released.
Destroyed_Success: The release is successful.
Revised: The architecture is being adjusted.
Verifying_In_Revision: Resource validation is in progress because of an architecture adjustment.
Verified_Failure_In_Revision: Resource validation failed because of an architecture adjustment.
Verified_Success_In_Revision: Resource validation is successful after an architecture adjustment.
Valuating_In_Revision: A price inquiry is in progress because of an architecture adjustment.
Valuating_Failure_In_Revision: The price inquiry failed because of an architecture adjustment.
Valuating_Success_In_Revision: The price inquiry is successful after an architecture adjustment.

Examples

Success response

JSON format

{
  "Message": "Success",
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Data": {
    "Description": "remark",
    "ImageURL": "https://cadt-studio-publish.oss-cn-hangzhou.aliyuncs.com/xxxxxxxxxxxxxxxxxxx/sr-8DWU4RUS49NIDII0.png",
    "ApplicationId": "VVK605ZH00OA4MRT",
    "Name": "CADT",
    "TemplateId": "FYS9VZ535U20V7HT",
    "CreateTime": "2021-08-09 14:37:16",
    "ResourceGroupId": "rg-aekzhfgmw4e6fwq",
    "PriceList": [
      {
        "ResourceCode": "ecs",
        "InstanceName": "ecs",
        "OriginalPrice": 3.57,
        "OnePrice": 0.01,
        "Period": 1,
        "Count": 1,
        "PriceUnit": "200/hour",
        "Price": 0.01,
        "ChargeType": "PayAsYouGo",
        "Region": "cn-hangzhou",
        "Specification": "\"slb.s1.small\"\n \"192.168.0.0/24\"\n\"ecs.c6.large\"\n\"normal\"\n \"\"",
        "Lifecycle": "Create",
        "Remark": "ecs Sold Out",
        "type": "1"
      }
    ],
    "Checklist": [
      {
        "ResourceCode": "vpc",
        "ResourceName": "vpc",
        "Region": "cn-hangzhou",
        "Result": "Finish",
        "Remark": "Verification passed",
        "Specification": "192.168.0.0/16",
        "Lifecycle": "Create"
      }
    ],
    "Status": "Deployed_Success",
    "ResourceList": [
      {
        "Status": "Finish",
        "ResourceCode": "ecs",
        "ResourceName": "ecs",
        "ResourceId": "i-2zehnzxqixu1pywsfbx1",
        "ChargeType": "PayAsYouGo",
        "ResourceType": "ecs",
        "Remark": "{\"hostName\":\"iZ2zehnzxqixu1pywsfbx1Z\",\"memory\":32768.0,\"creationTime\":\"2021-09-28T11:23:46Z\",\"instanceName\":\"ecs\",\"internetMaxBandwidthOut\":0.0,\"description\":\"\",\"clusterId\":\"\",\"private_ip\":\"192.168.0.247\",\"instanceId\":\"i-2zehnzxqixu1pywsfbx1\",\"requestId\":\"F1C64344-3723-51A0-855B-5F08B5634323\",\"zoneId\":\"cn-beijing-b\",\"ioOptimized\":\"optimized\",\"id\":\"i-2zehnzxqixu1pywsfbx1\",\"instanceNetworkType\":\"vpc\",\"instanceChargeType\":\"PostPaid\",\"imageId\":\"centos_8_4_x64_20G_alibase_20210824.vhd\",\"serialNumber\":\"cee246c4-38f3-4bf3-950b-c17e88ff6527\",\"vlanId\":\"\",\"instanceType\":\"ecs.e3.large\",\"cpu\":4.0,\"creditSpecification\":\"\",\"internetMaxBandwidthIn\":-1.0,\"expiredTime\":\"2099-12-31T15:59Z\",\"internetChargeType\":\"PayByTraffic\",\"regionId\":\"cn-beijing\",\"refId\":\"79224644_0\",\"stoppedMode\":\"Not-applicable\",\"status\":\"Running\"}",
        "Lifecycle": "Create",
        "NodeLabel": ""
      }
    ],
    "Error": "Success",
    "DeployPercent": 0.8,
    "ComplianceList": [
      {
        "Rules": [
          {
            "ruleId": "ecs-instances-in-vpc",
            "ruleDetail": ""
          }
        ],
        "ResourceName": "ecs",
        "ResourceCode": "ecs"
      }
    ]
  },
  "Code": "200"
}

Error codes

HTTP status code	Error code	Error message
400	bp.java.8004	No permissions.
400	bp.java.nopower	No permissions.
400	bp.java.nopowerContact	You do not have permission to use this function. Please contact the main account or permission administrator to authorize the relevant permissions.
400	bp.java.userNotExist	The user does not exist. The current user does not authenticate AliCloud with his real name.
400	ParameterEmpty	The request parameter cannot be empty.
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.