调用DescribeJob接口获取任务模板配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
sae:DescribeJob |
get |
*全部资源
|
无 | 无 |
请求语法
GET /pop/v1/sam/job/describeJob HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AppId |
string |
是 |
任务模板 ID。 |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| JobId |
string |
否 |
任务 ID。 |
event-b798157b-40a2-4388-b578-71fb897103**-** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| RequestId |
string |
请求 ID。 |
01CF26C7-00A3-4AA6-BA76-7E95F2A3**** |
| Message |
string |
调用结果的附加信息。 |
success |
| TraceId |
string |
调用链 ID,用于精确查询调用信息。 |
ac1a0b2215622246421415014e**** |
| Data |
object |
任务模板信息。 |
|
| VpcId |
string |
VPC ID。 |
vpc-2ze0i263cnn311nvj**** |
| ConfigMapMountDesc |
array<object> |
ConfigMap 信息。 |
|
|
object |
ConfigMap 信息。 |
||
| Key |
string |
ConfigMap 键值对。 |
k1 |
| ConfigMapName |
string |
ConfigMap 名称。 |
test |
| MountPath |
string |
容器挂载路径。 |
/tmp |
| ConfigMapId |
integer |
ConfigMap ID。 |
1 |
| SecurityGroupId |
string |
安全组 ID。 |
sg-wz969ngg2e49q5i4**** |
| Jdk |
string |
部署包依赖的 JDK 版本。支持版本如下:
当Package Type为 Image 时不支持。 |
Open JDK 8 |
| ImageUrl |
string |
镜像地址。当Package Type为 Image 时必填。 |
docker.io/library/nginx:1.14.2 |
| SlsConfigs |
string |
日志采集到 SLS 的配置。
参数说明如下:
多次部署时如果 SLS 采集配置没有变更,则不需要设置该参数(即请求中无需包含 SlsConfigs 字段);如果不再需要使用 SLS 采集功能,您需要在请求中将该字段的值设置为空字符串(即请求中 SlsConfigs 字段的值为"")。 |
[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}] |
| Tags |
array<object> |
标签信息。 |
|
|
object |
标签信息。 |
||
| Key |
string |
标签键。 |
k1 |
| Value |
string |
标签值。 |
v1 |
| PackageUrl |
string |
部署包地址。当Package Type为 FatJar 或 War 时必填。 |
https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war |
| PackageType |
string |
任务包类型。取值说明如下:
|
War |
| PreStop |
string |
容器停止前执行脚本。在容器被删除前触发执行一段脚本,格式如: |
{"exec":{"command":["cat","/etc/group"]}} |
| PackageVersion |
string |
部署包的版本号。当Package Type为 FatJar 或 War 时必填。 |
1.0 |
| JarStartArgs |
string |
JAR 包启动任务参数。任务默认启动命令: |
start |
| AppName |
string |
任务模板名称。 |
demo-app |
| AppId |
string |
任务模板 ID。 |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| JarStartOptions |
string |
JAR 包启动任务选项。任务默认启动命令: |
-Dtest=true |
| Replicas |
integer |
任务实例个数。 |
2 |
| Memory |
integer |
每个实例所需的内存,单位为 MB,不能为 0。与 CPU 为一一对应关系,目前仅支持以下固定规格:
|
2048 |
| PhpConfig |
string |
PHP 配置文件内容。 |
k1=v1 |
| PhpConfigLocation |
string |
PHP 任务启动配置挂载路径,需要您保证 PHP 服务器会使用这个配置文件启动。 |
/usr/local/etc/php/php.ini |
| PostStart |
string |
容器启动后执行脚本。在容器被创建后立刻触发执行一段脚本,格式如: |
{"exec":{"command":["cat","/etc/group"]}} |
| TerminationGracePeriodSeconds |
integer |
优雅下线超时时间,默认为 30,单位为秒。取值范围为 1~300。 |
10 |
| CommandArgs |
string |
镜像启动命令参数。启动命令 Command 所需参数。格式如下:
在 Command 参数的示例中, |
["a","b"] |
| NamespaceId |
string |
命名空间 ID。 |
cn-beijing:test |
| MountHost |
string |
NAS 在任务模板 VPC 内的挂载点。部署时如果配置没有变更,则不需要设置该参数(即请求中无需包含 MountHost 字段);如果需要清除 NAS 配置,您需要在请求中将该字段的值设置为空字符串(即请求中 MountHost 字段的值为"")。 |
example.com |
| TomcatConfig |
string |
Tomcat 文件配置,设置为""或"{}"表示删除配置:
|
{"port":8080,"contextPath":"/","maxThreads":400,"uriEncoding":"ISO-8859-1","useBodyEncodingForUri":true} |
| RegionId |
string |
地域 ID。 |
cn-beijing |
| VSwitchId |
string |
vSwitch ID。 |
vsw-2ze559r1z1bpwqxwp**** |
| Cpu |
integer |
每个实例所需的 CPU,单位为毫核,不能为 0。目前仅支持以下固定规格:
|
1000 |
| Envs |
string |
容器环境变量参数。支持自定义或引用配置项。如需引用配置项,请先创建 ConfigMap 实例。更多信息,请参见 CreateConfigMap 。取值说明如下:
|
[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}] |
| MountDesc |
array<object> |
挂载描述信息。 |
|
|
object |
挂载描述信息。 |
||
| MountPath |
string |
容器挂载路径。 |
/tmp |
| NasPath |
string |
NAS 相对文件目录。 |
/ |
| CustomHostAlias |
string |
容器内自定义 Host 映射。取值说明如下:
|
[{"hostName":"test.host.name","ip":"0.0.0.0"}] |
| WebContainer |
string |
部署包依赖的 Tomcat 版本。支持版本如下:
当Package Type为 Image 时不支持。 |
apache-tomcat-7.0.91 |
| Command |
string |
镜像启动命令。该命令必须为容器内存在的可执行的对象。示例如下:
根据上述示例,则 |
echo |
| WarStartOptions |
string |
WAR 包启动任务选项。任务默认启动命令: |
custom-option |
| NasId |
string |
NAS ID。 |
AKSN89** |
| OssAkId |
string |
OSS 读写的 AccessKey ID。 |
xxxxxx |
| OssAkSecret |
string |
OSS 读写的 AccessKey Secret。 |
xxxxxx |
| OssMountDescs |
array<object> |
OSS 挂载描述信息。 |
|
|
object |
OSS 挂载描述信息。 |
||
| bucketName |
string |
Bucket 名称。 |
oss-bucket |
| bucketPath |
string |
您在 OSS 创建的目录或 OSS 对象,如果 OSS 挂载目录不存在,会触发异常。 |
data/user.data |
| mountPath |
string |
您在 SAE 的容器路径。如果路径已存在,为覆盖关系;如果路径不存在,会新建。 |
/usr/data/user.data |
| readOnly |
boolean |
容器路径是否对挂载目录资源有可读权限,取值说明如下:
|
true |
| EdasContainerVersion |
string |
HSF 框架中任务运行环境版本,例如 Ali-Tomcat 容器。 |
3.5.3 |
| Timezone |
string |
时区,默认为Asia/Shanghai。 |
Asia/Shanghai |
| AppDescription |
string |
任务模板描述信息。 |
Sample application |
| AcrInstanceId |
string |
ACR 企业版实例 ID。 |
cri-xxxxxx |
| AcrAssumeRoleArn |
string |
跨账号拉取镜像时所需的 RAM 角色的 ARN。更多信息,请参见跨账号拉取阿里云镜像和通过 RAM 角色实现跨云账号授权。 |
acs:ram::123456789012****:role/adminrole |
| ImagePullSecrets |
string |
对应保密字典 ID。 |
10 |
| TriggerConfig |
string |
任务触发配置,根据任务类型进行配置。
|
{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"} |
| ConcurrencyPolicy |
string |
任务并发策略。取值说明如下:
|
Allow |
| Suspend |
boolean |
是否暂停任务模板。 |
false |
| Timeout |
integer |
任务超时时间,单位为秒。 |
3600 |
| BackoffLimit |
integer |
任务重试次数。 |
3 |
| Slice |
boolean |
启用任务分片。 |
true |
| SliceEnvs |
string |
任务分片参数。 |
SliceEnvs |
| RefAppId |
string |
引用的任务模板 ID。 |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| RefedAppIds |
array |
被引用的任务目标 ID 列表。 |
|
|
string |
任务模板 ID。 |
8621a6ca-d1cd-4928-8642-7d5cfe69**** |
|
| PublicWebHookUrls |
array |
一次性任务的公网请求 URL 列表。 |
|
|
string |
公网 URL。 |
http://***/webhook/putEvents?token=*** |
|
| VpcWebHookUrls |
array |
一次性任务的内网请求 URL 列表。 |
|
|
string |
内网 URL。 |
http://***/webhook/putEvents?token=*** |
|
| ProgrammingLanguage |
string |
创建任务模板的技术栈语言。取值说明如下:
|
java |
| NasConfigs |
string |
挂载 NAS 的配置。 |
[{"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 |
string |
Python 环境。支持 PYTHON 3.9.15。 |
PYTHON 3.9.15 |
| PythonModules |
string |
自定义安装模块依赖。默认安装根目录下 requirements.txt 定义的依赖项。如果未配置或自定义软件包,可以指定安装的依赖。 |
Flask==2.0 |
| BestEffortType |
string |
BestEffort 策略。 |
|
| ErrorCode |
string |
错误码。取值说明如下:
|
|
| Code |
string |
接口状态或 POP 错误码。取值说明如下:
|
200 |
| Success |
boolean |
获取任务模板配置信息是否成功。取值说明如下:
|
true |
示例
正常返回示例
JSON格式
{
"RequestId": "01CF26C7-00A3-4AA6-BA76-7E95F2A3****",
"Message": "success",
"TraceId": "ac1a0b2215622246421415014e****",
"Data": {
"VpcId": "vpc-2ze0i263cnn311nvj****",
"ConfigMapMountDesc": [
{
"Key": "k1",
"ConfigMapName": "test",
"MountPath": "/tmp",
"ConfigMapId": 1
}
],
"SecurityGroupId": "sg-wz969ngg2e49q5i4****",
"Jdk": "Open JDK 8",
"ImageUrl": "docker.io/library/nginx:1.14.2",
"SlsConfigs": "[{\"logDir\":\"\",\"logType\":\"stdout\"},{\"logDir\":\"/tmp/a.log\"}]",
"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,
"Memory": 2048,
"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": "/"
}
],
"CustomHostAlias": "[{\"hostName\":\"test.host.name\",\"ip\":\"0.0.0.0\"}]",
"WebContainer": "apache-tomcat-7.0.91",
"Command": "echo",
"WarStartOptions": "custom-option",
"NasId": "AKSN89**",
"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": "Sample application",
"AcrInstanceId": "cri-xxxxxx",
"AcrAssumeRoleArn": "acs:ram::123456789012****:role/adminrole",
"ImagePullSecrets": "10",
"TriggerConfig": "{\"type\":\"time\",\"config\":\"0 1 */1 * ?\",\"timezone\":\"GMT+8:00\"}",
"ConcurrencyPolicy": "Allow",
"Suspend": false,
"Timeout": 3600,
"BackoffLimit": 3,
"Slice": true,
"SliceEnvs": "SliceEnvs",
"RefAppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
"RefedAppIds": [
"8621a6ca-d1cd-4928-8642-7d5cfe69****"
],
"PublicWebHookUrls": [
"http://***/webhook/putEvents?token=***"
],
"VpcWebHookUrls": [
"http://***/webhook/putEvents?token=***"
],
"ProgrammingLanguage": "java",
"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",
"BestEffortType": ""
},
"ErrorCode": "",
"Code": "200",
"Success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | InvalidAppId.NotFound | The specified AppId does not exist. | 指定的AppId不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。