調用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不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。