GetApplication - API Reference| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request header

This operation only uses common request headers. For more information, see the Common request parameters topic.

Request syntax

POST /pop/v5/app/app_info HTTPS|HTTP

Request parameters


Parameter	Type	Required	Example	Description
AppId	String	Yes	29f0******************	The ID of the application by which the services are consumed.

Response parameters


Parameter	Type	Example	Description
Application	Struct		The information about the application that was queried.
AppId	String	sdfsdf	The ID of the application where the consumed service is published.
ApplicationType	String	War	The deployment type of the application, which can be War (WAR package deployment) or FatJar (JAR package deployment). If this parameter is set to null, the application is not deployed.
BuildPackageId	Long	38	The version of the container where the application is running.
ClusterId	String	5ffc5895**-b03a-c223c6c3*	The ID of the cluster from which you want to delete an ECS instance.
ClusterType	Integer	2	The environment type of the application cluster. Valid values: 0 (common docker cluster), 1 (Swarm cluster), 2 (ECS cluster), 3 (Kubernetes cluster), and 4 (Pandora).
Cpu	Integer	0	The number of CPUs in the instances where the application is deployed.
CreateTime	Long	151200000	The time when the VSwitch was created.
Description	String	""	Application Description
Dockerize	Boolean	false	Indicates whether the application where the service is published is a Docker application.
Email	String	XXXXXXXX@qq.com	The email address of the account that you want to edit.
ExtSlbId	String	""	The ID of the Internet SLB instance that was bound to the application.
ExtSlbIp	String	""	The IP address allocated to the Internet SLB instance that was bound to the application.
ExtSlbName	String	testapp	The name of the Internet SLB instance that was bound to the application.
HealthCheckUrl	String	http://127.0.0.1:8080/xyz.html	The health check URL for the application that was queried.
InstanceCount	Integer	0	The total number of application instances for the application that was queried.
Memory	Integer	0	The configured memory size of the application instance. Unit: MB.
Name	String	""	The name of the application that ingests the stream.
NameSpace	String	doc-test	Namespace
Owner	String	test****	The ID of the user who created the application that was queried.
Port	Integer	8080	The port number occupied by the application.
RegionId	String	cn-beijing	The ID of the region where the application is located.
RunningInstanceCount	Integer	0	The number of running instances where the application is deployed.
SlbId	String	""	The ID of the intranet Server Load Balancer (SLB) instance that was bound to the application.
SlbInfo	String	test	SLB information
SlbIp	String	192.168.0.100	The IP address allocated to the intranet SLB instance that was bound to the application.
SlbName	String	test	The name of the intranet SLB instance that was bound to the application.
SlbPort	Integer	800	The port occupied by the intranet SLB instance that was bound to the application.
UserId	String	test@dd******	The ID of the primary account corresponding to the role returned.
Code	Integer	200	The returned code.
Message	String	success	The returned message.
RequestId	String	F8DFGED-K98****	The ID of the request.

Examples

Sample requests

POST /pop/v5/app/app_info HTTP/1.1
Common request header
{
  "AppId": "f4ccf3-****-****-****"
}

Sample success responses

XML format

<Message>success</Message>
<Application>
    <Owner>test</Owner>
    <Description/>
    <Email>XXXXXXXX@qq.com</Email>
    <HealthCheckUrl/>
    <Memory>0</Memory>
    <Port>8080</Port>
    <Cpu>0</Cpu>
    <SlbName/>
    <Name>doc-test</Name>
    <SlbPort>0</SlbPort>
    <Dockerize>false</Dockerize>
    <BuildPackageId>58</BuildPackageId>
    <ClusterId>5ffc5895-****-b03a-c223c6c3****</ClusterId>
    <CreateTime>1577259573911</CreateTime>
    <ClusterType>2</ClusterType>
    <InstanceCount>1</InstanceCount>
    <ExtSlbName/>
    <ApplicationType>War</ApplicationType>
    <AppId>30e5f902-****-450f-b018-4e183258****</AppId>
    <UserId>test</UserId>
    <RegionId>cn-beijing:docTest</RegionId>
    <RunningInstanceCount>0</RunningInstanceCount>
</Application>
<Code>200</Code>

JSON format

{
    "Message": "success",
    "Application": {
        "Owner": "test",
        "Description": "",
        "Email": "XXXXXXXX@qq.com",
        "HealthCheckUrl": "",
        "Memory": 0,
        "Port": 8080,
        "Cpu": 0,
        "SlbName": "",
        "Name": "doc-test",
        "SlbPort": 0,
        "Dockerize": false,
        "BuildPackageId": 58,
        "ClusterId": "5ffc5895-****-b03a-c223c6c3****",
        "CreateTime": 1577259573911,
        "ClusterType": 2,
        "InstanceCount": 1,
        "ExtSlbName": "",
        "ApplicationType": "War",
        "AppId": "30e5f902-****-450f-b018-4e183258****",
        "UserId": "test",
        "RegionId": "cn-beijing:docTest",
        "RunningInstanceCount": 0
    },
    "Code": 200
}

Error codes

For a list of error codes, visit the API Error Center.