调用DescribeApplicationConfig接口获取应用配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
sae:DescribeApplicationConfig | get |
|
| 无 |
请求语法
GET /pop/v1/sam/app/describeApplicationConfig
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 应用 ID。 | 7171a6ca-d1cd-4928-8642-7d5cfe69**** |
VersionId | string | 否 | 版本 ID。 | 0026ff7f-2b57-4127-bdd0-9bf202bb**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3****",
"Message": "success",
"TraceId": "ac1a0b2215622246421415014e****",
"Data": {
"VpcId": "vpc-2ze0i263cnn311nvj****",
"Readiness": "{\"exec\":{\"command\":[\"curl http://localhost:8080\"]},\"initialDelaySeconds\":20,\"timeoutSeconds\":5}",
"ConfigMapMountDesc": [
{
"Key": "k1",
"ConfigMapName": "test",
"MountPath": "/tmp",
"ConfigMapId": 1
}
],
"SecurityGroupId": "sg-wz969ngg2e49q5i4****",
"BatchWaitTime": 10,
"Jdk": "Open JDK 8",
"ImageUrl": "docker.io/library/nginx:1.14.2",
"SlsConfigs": "[{\"logDir\":\"\",\"logType\":\"stdout\"},{\"logDir\":\"/tmp/a.log\"}]",
"Liveness": "{\"exec\":{\"command\":[\"curl http://localhost:8080\"]},\"initialDelaySeconds\":20,\"timeoutSeconds\":3}",
"Tags": [
{
"Key": "k1",
"Value": "v1"
}
],
"PackageUrl": "https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war",
"PackageType": "War",
"PreStop": "{\"exec\":{\"command\":[\"cat\",\"/etc/group\"]}}",
"PackageVersion": "1.0",
"JarStartArgs": "start",
"AppName": "demo-app",
"AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
"JarStartOptions": "-Dtest=true",
"Replicas": 2,
"UpdateStrategy": "{\"type\":\"GrayBatchUpdate\",\"batchUpdate\":{\"batch\":2,\"releaseType\":\"auto\",\"batchWaitTime\":1},\"grayUpdate\":{\"gray\":1}}",
"MinReadyInstances": 1,
"MinReadyInstanceRatio": -1,
"Memory": 2048,
"Php": "PHP-FPM 7.0",
"PhpConfig": "k1=v1",
"PhpConfigLocation": "/usr/local/etc/php/php.ini",
"PostStart": "{\"exec\":{\"command\":[\"cat\",\"/etc/group\"]}}",
"TerminationGracePeriodSeconds": 10,
"CommandArgs": "[\"a\",\"b\"]",
"NamespaceId": "cn-beijing:test",
"MountHost": "example.com",
"TomcatConfig": "{\"port\":8080,\"contextPath\":\"/\",\"maxThreads\":400,\"uriEncoding\":\"ISO-8859-1\",\"useBodyEncodingForUri\":true}",
"RegionId": "cn-beijing",
"VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
"Cpu": 1000,
"Envs": "[{\"name\":\"TEST_ENV_KEY\",\"value\":\"TEST_ENV_VAR\"}]",
"MountDesc": [
{
"MountPath": "/tmp",
"NasPath": "/"
}
],
"EnableAhas": "true",
"CustomHostAlias": "[{\"hostName\":\"test.host.name\",\"ip\":\"0.0.0.0\"}]",
"WebContainer": "apache-tomcat-7.0.91",
"Command": "echo",
"WarStartOptions": "custom-option",
"PhpArmsConfigLocation": "/usr/local/etc/php/conf.d/arms.ini",
"NasId": "AKSN****",
"OssAkId": "xxxxxx",
"OssAkSecret": "xxxxxx",
"OssMountDescs": [
{
"bucketName": "oss-bucket",
"bucketPath": "data/user.data",
"mountPath": "/usr/data/user.data",
"readOnly": true
}
],
"EdasContainerVersion": "3.5.3",
"Timezone": "Asia/Shanghai",
"AppDescription": "示例应用",
"EnableGreyTagRoute": false,
"MseApplicationId": "xxxxxxx@xxxxx",
"AcrInstanceId": "cri-xxxxxx",
"AcrAssumeRoleArn": "acs:ram::123456789012****:role/adminrole",
"ImagePullSecrets": "10",
"AssociateEip": true,
"KafkaConfigs": "{\"kafkaEndpoint\":\"10.0.X.XXX:XXXX,10.0.X.XXX:XXXX,10.0.X.XXX:XXXX\",\"kafkaInstanceId\":\"alikafka_pre-cn-7pp2l8kr****\",\"kafkaConfigs\":[{\"logType\":\"file_log\",\"logDir\":\"/tmp/a.log\",\"kafkaTopic\":\"test2\"},{\"logType\":\"stdout\",\"logDir\":\"\",\"kafkaTopic\":\"test\"}]}",
"ProgrammingLanguage": "java",
"PvtzDiscovery": "{ \"serviceName\": \"bwm-poc-sc-gateway-cn-beijing-front\", \"namespaceId\": \"cn-beijing:front\", \"portAndProtocol\": { \"18012\": \"TCP\" }, \"portProtocols\": [ { \"port\": \"18012\", \"protocol\": \"TCP\" } ], \"enable\": true }",
"MicroRegistration": "\"0\"",
"NasConfigs": "[{\"mountPath\":\"/test1\",\"readOnly\":false,\"nasId\":\"nasId1\",\"mountDomain\":\"nasId1.cn-shenzhen.nas.aliyuncs.com\",\"nasPath\":\"/test1\"},{\"nasId\":\"nasId2\",\"mountDomain\":\"nasId2.cn-shenzhen.nas.aliyuncs.com\",\"readOnly\":false,\"nasPath\":\"/test2\",\"mountPath\":\"/test2\"}]",
"Python": "PYTHON 3.9.15",
"PythonModules": "Flask==2.0",
"Dotnet": "",
"MseApplicationName": "cn-shenzhen-alb-demo-5c****",
"AppSource": "micro_service",
"ServiceTags": {
"key": "tag1"
},
"MicroRegistrationConfig": "",
"EnableIdle": true,
"EnableNewArms": true
},
"ErrorCode": "空",
"Code": "200",
"Success": true
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidApplication.NotFound | The current application does not exist. | 找不到当前应用。 |
404 | InvalidAppId.NotFound | The specified AppId does not exist. | 指定的AppId不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-28 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-08-12 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-05-21 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-01-22 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-10-24 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-09-25 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-06-07 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |