You can call this operation to query applications.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. You can use OpenAPI Explorer to search for APIs, call APIs, and dynamically generate SDK example code.

Request headers

This operation uses common request headers, instead of special request headers. For more information, see the "Common request headers" section in "Common request and response headers."

Request syntax

GET /pop/v1/wam/application HTTP/1.1

Request parameters

Parameter Type Required? Example Description
AppId String No wa-5d1af9c802470221ab7*****

The ID of the application whose information is to be queried.
AppName String No appTest

The name of the application whose information is to be queried.
AppSearch String No appSearch

The keyword used to query the names of applications. The application whose name contains the keyword is returned.

EnvSearch String No testEnv

The keyword used to query the names of deployment environments in applications. If the name of a deployment environment in an application contains the keyword, the application is returned.

PageNumber Integer No 1

The number of the page to return.
PageSize Integer No 10

The number of entries to return on each page.
StackSearch String No Java

The keyword used to query technology stack types.

Response parameters

Parameter Type Example Description
Applications

The list of the applications queried.
AppDescription String This is an application.

The description of the application.
AppId String wa-5d1af9c802470221ab7*****

The ID of the application.
AppName String appName

The name of the application.
CategoryName String Java

The platform type of the application.
CreateTime Long 1562226969419

The time when the application was created.
CreateUsername String webx-test

The name of the user who created the application.
RunningEnvs Integer 2

The number of running deployment environments in the application.
TerminatedEnvs Integer 0

The number of terminated deployment environments in the application.
TotalEnvs Integer 2

The total number of deployment environments in the application.
UpdateTime Long 1562226969419

The time when the application was last updated.
UpdateUsername String webx-test

The name of the user who last updated the application.
Code String OK

The response code. The value is OK if the request is successful.
Message String success

The response message. The value is success if the request is successful.
PageNumber Integer 1

The number of the page returned.
PageSize Integer 20

The number of entries returned on each page.
RequestId String 132BF104-A660-40C7-936B-F805967*****

The ID of the request.
TotalCount Integer 1

The total number of entries returned.

Examples

Sample request


http://webplus.cn-hangzhou.aliyuncs.com/pop/v1/wam/application? PageSize=20&EnvSearch=test?<Common request parameters>

Sample success response

XML format 

<DescribeApplicationsResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <Message>success</Message>
    <PageSize>20</PageSize>
    <RequestId>761C51B0-9026-4659-989C-7AFDFEE*****</RequestId>
    <Applications>
        <Application>
            <CategoryName>Java</CategoryName>
            <UpdateUsername>user1</UpdateUsername>
            <CreateUsername>user1</CreateUsername>
            <CreateTime>1562048968834</CreateTime>
            <AppId>wa-5d1af9c802470221ab7*****</AppId>
            <TotalEnvs>2</TotalEnvs>
            <UpdateTime>1562048968834</UpdateTime>
            <AppDescription></AppDescription>
            <AppName>test</AppName>
            <TerminatedEnvs>0</TerminatedEnvs>
            <RunningEnvs>2</RunningEnvs>
        </Application>
    </Applications>
    <Code>OK</Code>
</DescribeApplicationsResponse>

JSON format 

{
	"PageNumber":1,
	"TotalCount":1,
	"Message":"success",
	"PageSize":20,
	"RequestId":"00C3CEDB-9E1B-4872-985E-BB2B7D6*****",
	"Applications":{
		"Application":[
			{
				"CategoryName":"Java",
				"UpdateUsername":"user1",
				"CreateUsername":"user1",
				"CreateTime":1562048968834,
				"AppId":"wa-5d1af9c802470221ab7*****",
				"UpdateTime":1562048968834,
				"TotalEnvs":2,
				"AppDescription":"",
				"AppName":"test",
				"TerminatedEnvs":0,
				"RunningEnvs":2
			}
		]
	},
	"Code":"OK"
}

Error codes

For more information about error codes, see API Error Center.