接口功能介绍

查询应用详情信息。

接口约束

无

URI

GET /v1/cae/application/query

路径参数 无

Query参数

请求参数

请求头header参数

请求体body参数 无

响应参数

表 returnObj

表 CodeOssInfo

表 ConfigMapMountDescData

表 EnvData

表 EnvVarSource

表 ConfigMapRefSourceData

表 SecretRefSourceData

表 ServiceData

表 PortProtocol

表 ImageConfig

表 NacosConfig

表 SecretMountDescData

表 SfsConfig

表 SidecarContainersConfigDesc

表 EmptyDirConfig

表 ZosConfig

表 AppUpdateStrategy

表 BatchUpdateConfig

表 GrayUpdateConfig

枚举参数

无

请求示例

请求url

GET /v1/cae/application/query

请求头header

regionId:20000000***1852

请求体body

无

响应示例

{
	"statusCode": 800,
	"message": "success",
	"description": "成功",
	"returnObj": {
		"appDescription": "测试应用",
		"appID": "09db72fa-xxxx-xxxx-a1d8-24a420181216",
		"appName": "app1",
		"appSource": "app_center_es",
		"appType": "deployment",
		"autoConfig": true,
		"baseAppID": "09db72fa-xxxx-xxxx-a1d8-24a420181216",
		"codeOssInfo": {
			"codeUrl": "https://oss.example.com/apps/app-1.0.0.jar",
			"codeZipFileName": "app-1.0.0.jar",
			"ossBucketName": "cae-bucket",
			"ossObjectName": "apps/app-1.0.0.jar",
			"zipFile": ""
		},
		"command": "/bin/sh",
		"commandArgs": "-c start.sh",
		"configmapMountDesc": [
			{
				"configmapID": "09db72fa-xxxx-xxxx-a1d8-24a420181216",
				"configmapName": "my-config",
				"key": "config-key",
				"mountPath": "/mnt/config"
			}
		],
		"cpu": 500,
		"cpuBurstEnable": false,
		"createTime": 1634544000000,
		"customHostAlias": "127.0.0.1 my-host",
		"envs": [
			{
				"name": "APP_ENV",
				"value": "production",
				"valueFrom": {
					"configmapRef": {
						"configmapID": "09db72fa-xxxx-xxxx-a1d8-24a420181216",
						"configmapName": "my-config",
						"key": "config-key"
					},
					"secretRef": {
						"key": "secret-key",
						"secretID": "09db72fa-xxxx-xxxx-a1d8-24a420181216",
						"secretName": "my-secret"
					}
				}
			}
		],
		"governanceEnable": 1,
		"headlessPvtzDiscoverySvc": {
			"enable": true,
			"hosts": [
				"[\"app.example.com\"]"
			],
			"portProtocols": [
				{
					"port": 80,
					"protocol": "TCP",
					"targetPort": 8080
				}
			],
			"serviceName": "my-service"
		},
		"imageConfig": {
			"instanceId": "crs-instance-xxxx",
			"repositoryId": "repo-xxxx",
			"repositoryName": "my-repo"
		},
		"imagePullSecretId": "secret-xxxx",
		"imageType": "custom",
		"imageUrl": "nginx:latest",
		"instances": 2,
		"liveness": "",
		"logConfig": "",
		"logEnable": 1,
		"memory": 1024,
		"minReadyInstance": 1,
		"minReadyInstanceRatio": 1,
		"mseEnable": 1,
		"nacosConfig": {
			"enable": true,
			"type": 1
		},
		"namespaceID": "0b7b7988-xxxx-xxxx-af7d-244e82424221",
		"packageType": "jar",
		"packageVersion": "1.0.0",
		"postStartCommand": "/bin/sh",
		"postStartCommandArgs": "-c start.sh",
		"preStopCommand": "/bin/sh",
		"preStopCommandArgs": "-c stop.sh",
		"programmingLanguage": "java",
		"pvtzDiscoverySvc": null,
		"readiness": "",
		"regionID": "cn-east-3",
		"replicas": 2,
		"runningInstances": 2,
		"runtimeKey": "java8",
		"runtimeType": {},
		"secretMountDesc": [
			{
				"key": "secret-key",
				"mountPath": "/mnt/secret",
				"secretID": "09db72fa-xxxx-xxxx-a1d8-24a420181216",
				"secretName": "my-secret"
			}
		],
		"securityGroupID": "sg-xxxx",
		"serviceEnable": true,
		"serviceTags": "gray-tag",
		"sfsConfig": [
			{
				"localMountPath": "/tmp/sfs",
				"remoteSfsPath": "/data",
				"sfsId": "sfs-123456",
				"sfsName": "my-sfs",
				"sharePath": "192.168.1.1:/share"
			}
		],
		"sidecarContainersConfig": [
			{
				"command": "/bin/sh",
				"commandArgs": "-c start.sh",
				"configmapMountDesc": null,
				"cpu": 2,
				"emptyDirDesc": [
					{
						"mountPath": "/mnt/empty-dir",
						"name": "my-empty-dir"
					}
				],
				"envs": null,
				"imageUrl": "nginx:latest",
				"memory": 2048,
				"name": "my-sidecar",
				"postStartCommand": "postStartCommand",
				"postStartCommandArgs": "postStartCommandArgs",
				"preStopCommand": "preStopCommand",
				"preStopCommandArgs": "preStopCommandArgs",
				"sfsConfig": null,
				"zosConfig": [
					{
						"accessUrl": "https://zos.example.com/bucket",
						"bucketID": "zos-123455",
						"bucketName": "my-zos",
						"bucketPath": "/tmp/sfs",
						"mountDir": "/local/sfs",
						"readOnly": true
					}
				]
			}
		],
		"startupProbe": "",
		"status": "Running",
		"subnetID": "subnet-xxxx",
		"tempStorage": 20,
		"terminationGracePeriodSeconds": 30,
		"updateStrategy": {
			"batchUpdate": {
				"batchCount": 2,
				"batchWaitTime": 5,
				"releaseType": "auto"
			},
			"grayUpdate": {
				"enableGreyRule": false,
				"grayNum": 1
			},
			"type": "RollingUpdate"
		},
		"updateTime": 1634544300000,
		"vpcID": "vpc-tsge****asd",
		"zosConfig": null,
		"requestID": "5fd3e6f7-9229-4fb4-a352-0f91bfd638b1"
	}
}

状态码

请参考 状态码

错误码

请参考 错误码