You can call this operation to configure the basic information for an application.

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 headers

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

Request syntax

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

Request parameters

Parameter Type Required Example Description
AppId String Yes c627c157-560d-43ff-****-************

The ID of the application for which you want to configure the basic information.

AppName String No test

The name of the application for which you want to configure the basic information. The name can be up to 32 characters in length. This parameter can be left empty.

desc String No ""

The description of the application that you want to configure. The description can be up to 256 characters in length. This parameter can be left empty.

Response parameters

Parameter Type Example Description
Code Integer 200

The returned code.

Message String success

The returned message.

RequestId String D16979DC-4D42-**************
Application Struct

The basic information of application that was configured.

AppId String c627c157-560d-43ff-****-************

The ID of the application that was configured.

Name String ""

The name of the application that was configured.

RegionId String cn-shenzhen:******

The ID of the region where the application is located.

Description String Ol432236

The description of the application that was configured.

Owner String edas_com***_****@******-*****. ***

The ID of the user who created the application.

InstanceCount Integer 1

The total number of application instances for the application that was configured.

RunningInstanceCount Integer 0

The number of running instances where the application is deployed.

Port Integer 8080

The port number occupied by the application.

UserId String edas_com***_****@******-*****. ***

The ID of the primary account that was used to create the application.

SlbId String ""

The ID of the intranet Server Load Balancer (SLB) instance bound to the application.

SlbIp String ""

The IP address allocated to the intranet SLB instance bound to the application.

SlbPort Integer 0

The port occupied by the intranet SLB instance bound to the application.

ExtSlbId String ""

The ID of the Internet SLB instance bound to the application.

ExtSlbIp String ""

The IP address allocated to the Internet SLB instance bound to the application.

SlbName String ""

The name of the intranet SLB instance bound to the application.

ExtSlbName String ""

The name of the Internet SLB instance bound to the application.

ApplicationType String FatJar

The deployment type of the application. Valid values: War: indicates that the application is deployed through a web application archive (WAR) package. FatJar: indicates that the application is deployed through a Java archive (JAR) package. If this parameter is left empty, the application is not deployed.

ClusterType Integer 2

The type of the cluster where the application is located. Valid values: 0: Common cluster where Docker is installed. 1: Swarm cluster. 2: ECS cluster. 3: Kubernetes cluster.

ClusterId String 0d247b93-8d62-4e34-****-************

The ID of the cluster where the application is deployed.

Dockerize Boolean false

Indicates whether the application is a Docker application.

Cpu Integer 0

The number of CPUs in the instances where the application is deployed.

Memory Integer 0

The amount of memory for the instances where the application is deployed. Unit: MB

HealthCheckUrl String ""

The health check URL for the application that was configured.

BuildPackageId Long 0

The version of the container where the application is running.

CreateTime Long 1574249022930

The time when the application was created.

Examples

Sample requests

POST /pop/v5/app/update_app_info HTTP/1.1
Common request headers
{
  "AppId": ""
}

Sample success responses

JSON format

{
    "Message": "success",
    "Application": {
    "SlbPort": 0,
    "BuildPackageId": 0,
    "AppId": "c627c157-560d-43ff-****-************",
    "Memory": 0,
    "Cpu": 0,
    "Dockerize": false,
    "ApplicationType": "FatJar",
    "Owner": "edas_com***_****@******-*****. ***",
    "Description": "Ol432236",
    "RunningInstanceCount": 0,
    "UserId": "edas_com***_****@******-*****. ***",
    "InstanceCount": 1,
    "Name": "testpopapi1120",
    "Port": 8080,
    "ClusterId": "0d247b93-8d62-4e34-****-************",
    "RegionId": "cn-shenzhen:xuanye",
    "CreateTime": 1574249022930,
    "ClusterType": 2
},
    "Code": 200
}

XML format

<Message>success</Message>
<Application>
    <SlbPort>0</SlbPort>
    <BuildPackageId>0</BuildPackageId>
    <AppId>c627c157-560d-43ff-****-************</AppId>
    <Memory>0</Memory>
    <Cpu>0</Cpu>
    <Dockerize>false</Dockerize>
    <ApplicationType>FatJar</ApplicationType>
    <Owner>edas_com***_****@******-*****. ***</Owner>
    <Description>Ol432236</Description>
    <RunningInstanceCount>0</RunningInstanceCount>
    <UserId>edas_com***_****@******-*****. ***</UserId>
    <InstanceCount>1</InstanceCount>
    <Name>testpopapi1120</Name>
    <Port>8080</Port>
    <ClusterId>0d247b93-8d62-4e34-****-************</ClusterId>
    <RegionId>cn-shenzhen:xuanye</RegionId>
    <CreateTime>1574249022930</CreateTime>
    <ClusterType>2</ClusterType>
</Application>
<Code>200</Code>

Error codes

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