すべてのプロダクト
Search
ドキュメントセンター

Serverless App Engine:DescribeJob

最終更新日:Apr 22, 2026

DescribeJob API を呼び出して、ジョブテンプレートの設定を取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:DescribeJob

get

*All Resource

*

なし なし

リクエスト構文

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 バージョン。次のバージョンがサポートされています:

  • Open JDK 8

  • Open JDK 7

  • Dragonwell 11

  • Dragonwell 8

  • openjdk-8u191-jdk-alpine3.9

  • openjdk-7u201-jdk-alpine3.9

このパラメーターは、パッケージタイプイメージに設定されている場合は適用されません。

Open JDK 8

ImageUrl

string

イメージ URL。このパラメーターは、パッケージタイプイメージに設定されている場合に必要です。

docker.io/library/nginx:1.14.2

SlsConfigs

string

Log Service (SLS) にログを収集するための設定。

  • SAE が自動的に作成する SLS リソースを使用する: [{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]

  • カスタム SLS リソースを使用する: [{"projectName":"test-sls","logType":"stdout","logDir":"","logstoreName":"sae","logtailName":""},{"projectName":"test","logDir":"/tmp/a.log","logstoreName":"sae","logtailName":""}]

パラメーターは次のとおりです:

  • projectName:SLS プロジェクトの名前。

  • logDir:ログパス。

  • logType:ログタイプ。stdout はコンテナの標準出力ログを指定します。stdout タイプのログは 1 つしか指定できません。このパラメーターを省略すると、ファイルログが収集されます。

  • logstoreName:SLS の Logstore の名前。

  • logtailName:SLS の Logtail 設定の名前。このパラメーターを指定しない場合、新しい Logtail 設定が作成されます。

再デプロイ時に Log Service の設定が変更されない場合、このパラメーターは省略できます。ログ収集を無効にするには、このパラメーターを空の文字列 ("") に設定します。

[{"logDir":"","logType":"stdout"},{"logDir":"/tmp/a.log"}]

Tags

array<object>

ジョブテンプレートのタグ。

object

タグ情報。

Key

string

タグキー。

k1

Value

string

タグ値。

v1

PackageUrl

string

パッケージの URL。このパラメーターは、パッケージタイプFatJar または War に設定されている場合に必要です。

https://edas-bj.oss-cn-beijing.aliyuncs.com/apps/K8s_APP_ID/d4c97c37-aba3-403e-ae1e-6f7d8742****/hello-sae.war

PackageType

string

ジョブパッケージのタイプ。有効な値:

  • Java デプロイメントの場合、FatJarWar、および Image がサポートされています。

  • PHP デプロイメントの場合、次のパッケージタイプがサポートされています:
    • PhpZip

    • IMAGE_PHP_5_4

    • IMAGE_PHP_5_4_ALPINE

    • IMAGE_PHP_5_5

    • IMAGE_PHP_5_5_ALPINE

    • IMAGE_PHP_5_6

    • IMAGE_PHP_5_6_ALPINE

    • IMAGE_PHP_7_0

    • IMAGE_PHP_7_0_ALPINE

    • IMAGE_PHP_7_1

    • IMAGE_PHP_7_1_ALPINE

    • IMAGE_PHP_7_2

    • IMAGE_PHP_7_2_ALPINE

    • IMAGE_PHP_7_3

    • IMAGE_PHP_7_3_ALPINE

  • Python デプロイメントの場合、PythonZipImage がサポートされています。

War

PreStop

string

コンテナが停止する前に実行するスクリプト。このスクリプトは、システムがコンテナを削除する前に実行されます。例: {"exec":{"command":["cat","/etc/group"]}}

{"exec":{"command":["cat","/etc/group"]}}

PackageVersion

string

パッケージのバージョン。このパラメーターは、パッケージタイプFatJar または War に設定されている場合に必要です。

1.0

JarStartArgs

string

JAR パッケージの起動引数。デフォルトの起動コマンドは $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs です。

start

AppName

string

ジョブテンプレートの名前。

demo-app

AppId

string

ジョブテンプレートの ID。

7171a6ca-d1cd-4928-8642-7d5cfe69****

JarStartOptions

string

JAR パッケージの起動オプション。デフォルトの起動コマンドは $JAVA_HOME/bin/java $JarStartOptions -jar $CATALINA_OPTS "$package_path" $JarStartArgs です。

-Dtest=true

Replicas

integer

ジョブインスタンスの数。

2

Memory

integer

各インスタンスで必要なメモリ (MB)。この値を 0 にすることはできません。CPU とメモリリソースは固定比率で割り当てられます。次の組み合わせがサポートされています:

  • 1024:500 ミリコアと 1,000 ミリコアに対応します。

  • 2048:500、1,000、2,000 ミリコアに対応します。

  • 4096:1,000、2,000、4,000 ミリコアに対応します。

  • 8192:2,000、4,000、8,000 ミリコアに対応します。

  • 12288:12,000 ミリコアに対応します。

  • 16384:4,000、8,000、16,000 ミリコアに対応します。

  • 24576:12,000 ミリコアに対応します。

  • 32768:16,000 ミリコアに対応します。

  • 65536:8,000、16,000、32,000 ミリコアに対応します。

  • 131072:32,000 ミリコアに対応します。

2048

PhpConfig

string

PHP 設定ファイルの内容。

k1=v1

PhpConfigLocation

string

PHP ジョブ起動設定のマウントパス。PHP サーバーがこの設定を使用して起動することを確認してください。

/usr/local/etc/php/php.ini

PostStart

string

コンテナが起動した後に実行するスクリプト。このスクリプトは、システムがコンテナを作成した直後に実行されます。例: {"exec":{"command":["cat","/etc/group"]}}

{"exec":{"command":["cat","/etc/group"]}}

TerminationGracePeriodSeconds

integer

グレースフルストップのタイムアウト (秒)。デフォルト:30。有効な値:1~300。

10

CommandArgs

string

イメージ起動コマンドの引数。引数は Command パラメーターに渡されます。フォーマット:

["a","b"]

Command パラメーターの例では、CommandArgs=["abc", ">", "file0"] です。この場合、["abc", ">", "file0"] は JSON 配列形式の文字列に変換する必要があります。このパラメーターが指定されていない場合は、設定する必要はありません。

["a","b"]

NamespaceId

string

名前空間 ID。

cn-beijing:test

MountHost

string

ジョブテンプレートの VPC 内にある Apsara File Storage NAS ファイルシステムのマウントポイント。再デプロイ時に NAS 設定が変更されない場合、このパラメーターは省略できます。NAS 設定をクリアするには、このパラメーターを空の文字列 ("") に設定します。

example.com

TomcatConfig

string

Tomcat ファイル設定。設定を削除するには、このパラメーターを "" または "{}" に設定します。

  • port:ポート番号。有効な値:1024~65535。1024 未満のポートは予約されています。ポートを指定しない場合、デフォルト値は 8080 です。

  • contextPath:アクセスパス。デフォルト値:/。

  • maxThreads:接続プール内の最大接続数。デフォルト値:400。

  • uriEncoding:Tomcat の URI エンコーディングスキーム。有効な値:UTF-8ISO-8859-1GBKGB2312。このパラメーターを指定しない場合、デフォルト値の ISO-8859-1 が使用されます。

  • useBodyEncodingForUri:リクエストボディの文字コードを URI に使用するかどうかを指定します。デフォルト値:true

{"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 に設定することはできません。次の固定仕様のみがサポートされています:

  • 500

  • 1000

  • 2000

  • 4000

  • 8000

  • 16000

  • 32000

1000

Envs

string

コンテナの環境変数。カスタム変数を定義するか、ConfigMap を参照できます。ConfigMap を参照するには、まず ConfigMap を作成する必要があります。詳細については、「CreateConfigMap」をご参照ください。次のフォーマットがサポートされています:

  • カスタム変数の定義
    • name:環境変数の名前。

    • value:環境変数の値。

  • ConfigMap の参照
    • name:環境変数の名前。単一のキーまたはすべてのキーを参照できます。すべてのキーを参照するには、sae-sys-configmap-all-<ConfigMap 名> と入力します。例:sae-sys-configmap-all-test1

    • valueFrom:環境変数のソース。値を configMapRef に設定します。

    • configMapId:ConfigMap の ID。

    • key:キーと値のペアのキー。ConfigMap 内のすべてのキーを参照する場合、このパラメーターを指定する必要はありません。

[{"name":"TEST_ENV_KEY","value":"TEST_ENV_VAR"}]

MountDesc

array<object>

マウントの説明。

object

マウントの説明。

MountPath

string

コンテナのマウントパス。

/tmp

NasPath

string

Apsara File Storage NAS ファイルシステム内のディレクトリ。

/

CustomHostAlias

string

コンテナ内のカスタムホストマッピング。パラメーターは次のとおりです:

  • hostName:ドメイン名またはホスト名。

  • ip:IP アドレス。

[{"hostName":"test.host.name","ip":"0.0.0.0"}]

WebContainer

string

パッケージが依存する Tomcat コンテナのバージョン。次のバージョンがサポートされています:

  • apache-tomcat-7.0.91

  • apache-tomcat-8.5.42

このパラメーターは、パッケージタイプイメージに設定されている場合はサポートされません。

apache-tomcat-7.0.91

Command

string

イメージの起動コマンド。コマンドは、コンテナ内に存在する実行可能ファイルである必要があります。例:

command:
      - echo
      - abc
      - >
      - file0

この例では、Command="echo", CommandArgs=["abc", ">", "file0"] です。

echo

WarStartOptions

string

WAR パッケージの起動オプション。デフォルトの起動コマンドは java $JAVA_OPTS $CATALINA_OPTS -Options org.apache.catalina.startup.Bootstrap "$@" start です。

custom-option

NasId

string

Apsara File Storage NAS ファイルシステムの ID。

AKSN89**

OssAkId

string

Object Storage Service (OSS) バケットにアクセスするための AccessKey ID。

xxxxxx

OssAkSecret

string

OSS バケットにアクセスするための AccessKey Secret。

xxxxxx

OssMountDescs

array<object>

マウントされた OSS バケットの説明。

object

マウントされた OSS バケットの説明。

bucketName

string

バケット名。

oss-bucket

bucketPath

string

OSS バケットに作成したディレクトリまたはオブジェクト。指定したマウントディレクトリが存在しない場合、例外が返されます。

data/user.data

mountPath

string

SAE コンテナ内のパス。パスが存在する場合、上書きされます。パスが存在しない場合、新しいパスが作成されます。

/usr/data/user.data

readOnly

boolean

コンテナがマウントされたリソースに対して読み取り専用アクセス権を持つかどうかを指定します。有効な値:

  • true:パスは読み取り専用権限を持ちます。

  • false:パスは読み取りおよび書き込み権限を持ちます。

true

EdasContainerVersion

string

HSF フレームワークの実行環境のバージョン (Ali-Tomcat コンテナなど)。

3.5.3

Timezone

string

タイムゾーン。デフォルト値:Asia/Shanghai

Asia/Shanghai

AppDescription

string

ジョブテンプレートの説明。

Sample application

AcrInstanceId

string

Container Registry (ACR) Enterprise Edition インスタンスの ID。

cri-xxxxxx

AcrAssumeRoleArn

string

アカウント間でイメージをプルするために必要な RAM ロールの ARN。詳細については、「Alibaba Cloud アカウント間でのイメージのプル」および「RAM ロールを使用した Alibaba Cloud アカウント間での権限付与」をご参照ください。

acs:ram::123456789012****:role/adminrole

ImagePullSecrets

string

Secret の ID。

10

TriggerConfig

string

ジョブトリガー設定。設定はジョブタイプによって異なります。

  • スケジュールタスクtype を time に、config を Cron 式に、timezone を特定のタイムゾーンに設定します。 例: {"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}

  • ワンタイムタスクtype を http に設定し、config には HTTP トリガールールを指定します。詳細については、「SourceHttpEventParameters」をご参照ください。 例: {"type":"http","config":{"type":"HTTPS","method":["GET"],"ip":[],"referer":[],"securityConfig":"none"}}

{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}

ConcurrencyPolicy

string

ジョブの同時実行ポリシー。有効な値:

  • Forbid:同時実行を禁止します。前のジョブが完了していない場合、新しいジョブは作成されません。

  • Allow:同時実行を許可します。

  • Replace:前のジョブが完了していない場合、新しいジョブがそれを置き換えます。

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:Java

  • php:PHP

  • python:Python

  • other:その他の言語 (C++、Go、.NET、Node.js など)。

java

NasConfigs

string

Apsara File Storage 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

インストールする Python モジュールの依存関係。デフォルトでは、SAE はパッケージのルートディレクトリにある requirements.txt ファイルから依存関係をインストールします。requirements.txt ファイルが存在しない場合や、追加のモジュールを追加する場合にこのパラメーターを使用します。

Flask==2.0

BestEffortType

string

Best-Effort ポリシー。

ErrorCode

string

エラーコード。

  • ErrorCode パラメーターは、リクエストが失敗した場合にのみ返されます。

  • ErrorCode の値のリストについては、このトピックのエラーコードセクションをご参照ください。

Code

string

HTTP ステータスコードまたは POP エラーコード。有効な値:

  • 2xx:リクエストは成功しました。

  • 3xx:リクエストはリダイレクトされました。

  • 4xx:リクエストエラーが発生しました。

  • 5xx:サーバーエラーが発生しました。

200

Success

boolean

リクエストが成功したかどうかを示します。有効な値:

  • true:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

成功レスポンス

JSONJSON

{
  "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 ステータスコード

エラーコード

エラーメッセージ

説明

404 InvalidAppId.NotFound The specified AppId does not exist.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。