指定されたワークスペースと名前空間から、指定された名前のデプロイメントを取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
stream:GetDeploymentsByName |
get |
*All Resource
|
なし | なし |
リクエスト構文
GET /api/v2/namespaces/{namespace}/deployments/name/{deploymentName} HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| namespace |
string |
必須 |
名前空間の名前。 |
default-namespace |
| deploymentName |
string |
必須 |
デプロイされたジョブの名前。 |
test |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| workspace |
string |
必須 |
ワークスペースの ID。 |
a14bd5d90a**** |
| ignoreJobSummary |
boolean |
任意 |
jobName やステータスなどのジョブサマリー情報をレスポンスから除外するかどうかを指定します。これを true に設定すると、JobId のみが返され、パフォーマンスが向上します。 |
true |
| ignoreResourceSetting |
boolean |
任意 |
並列度や CU 数などのリソース設定情報をレスポンスから除外するかどうかを指定します。これによりレスポンスサイズを削減できます。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスデータ。 |
||
| requestId |
string |
リクエスト ID。 |
CBC799F0-AS7S-1D30-8A4F-882ED4DD**** |
| success |
boolean |
リクエストが成功したかどうかを示します。 |
true |
| httpCode |
integer |
HTTP ステータスコード。値として 200 が返されます。リクエストが成功したかどうかを判断するには、success パラメーターを使用してください。 |
200 |
| errorCode |
string |
エラーコード。リクエストが失敗した場合にのみ返されます。 |
"" |
| errorMessage |
string |
エラーメッセージ。リクエストが失敗した場合にのみ返されます。 |
"" |
| data |
array |
レスポンスデータ。 |
|
| Deployment |
ジョブインスタンスの詳細。 |
deploymentName はユーザー定義の論理識別子であり、一意であることは保証されません。この API は、指定された名前に一致するすべてのデプロイメントのリストを返します。結果は作成時刻の降順でソートされます。これにより、最新のデプロイメントを簡単に表示したり、履歴バージョンと比較したりできます。
例
成功レスポンス
JSONJSON
{
"requestId": "CBC799F0-AS7S-1D30-8A4F-882ED4DD****",
"success": true,
"httpCode": 200,
"errorCode": "\"\"",
"errorMessage": "\"\"",
"data": [
{
"deploymentId": "00000000-0000-0000-0000-0000012312****",
"namespace": "default-namespace",
"name": "deploymentName",
"engineVersion": "vvr-6.0.0-flink-1.15",
"description": "this is a deployment description",
"creator": "27846363877456****",
"creatorName": "****@streamcompute.onaliyun.com",
"modifier": "27846363877456****",
"modifierName": "****@streamcompute.onaliyun.com",
"deploymentHasChanged": true,
"artifact": {
"sqlArtifact": {
"sqlScript": "CREATE TEMPORARY TABLE datagen_source( name VARCHAR ) WITH ( 'connector' = 'datagen' ); CREATE TEMPORARY TABLE blackhole_sink( name VARCHAR ) with ( 'connector' = 'blackhole' ); INSERT INTO blackhole_sink SELECT name from datagen_source;",
"additionalDependencies": [
"https://oss/bucket/addition.jar"
]
},
"jarArtifact": {
"jarUri": "https://oss/bucket/test.jar",
"entryClass": "org.apapche.flink.test",
"mainArgs": "start from main",
"additionalDependencies": [
"https://oss/bucket/addition.jar"
]
},
"pythonArtifact": {
"pythonArtifactUri": "https://oss/bucket/test.py",
"mainArgs": "start from main",
"entryModule": "test.py",
"additionalDependencies": [
"https://oss/bucket/addition.py"
],
"additionalPythonLibraries": [
"https://oss/bucket/additionlib.py"
],
"additionalPythonArchives": [
"https://oss/bucket/additionArchives.zip"
]
},
"cdcYamlArtifact": {
"cdcYaml": "",
"additionalDependencies": [
""
]
},
"kind": "SQLSCRIPT"
},
"flinkConf": {
"taskmanager.numberOfTaskSlots": "1"
},
"logging": {
"loggingProfile": "default",
"log4j2ConfigurationTemplate": "xml格式文本",
"log4jLoggers": [
{
"loggerName": "StdOutErrConsoleAppender",
"loggerLevel": "ERROR"
}
],
"logReservePolicy": {
"openHistory": true,
"expirationDays": 7
}
},
"jobSummary": {
"starting": 1,
"running": 2,
"cancelling": 0,
"cancelled": 5,
"finished": 4,
"failed": 6
},
"deploymentTarget": {
"mode": "PER_JOB",
"name": "default-queue\t"
},
"executionMode": "STREAMING",
"streamingResourceSetting": {
"resourceSettingMode": "EXPERT",
"expertResourceSetting": {
"jobmanagerResourceSettingSpec": {
"cpu": 2,
"memory": "4 GiB"
},
"resourcePlan": "{\\\"ssgProfiles\\\":[{\\\"name\\\":\\\"default\\\",\\\"cpu\\\":1.13,\\\"heap\\\":\\\"1 gb\\\",\\\"offHeap\\\":\\\"32 mb\\\",\\\"managed\\\":{},\\\"extended\\\":{}}],\\\"nodes\\\":[{\\\"id\\\":1,\\\"type\\\":\\\"StreamExecTableSourceScan\\\",\\\"desc\\\":\\\"Source: datagen_source[78]\\\",\\\"profile\\\":{\\\"group\\\":\\\"default\\\",\\\"parallelism\\\":1,\\\"maxParallelism\\\":32768,\\\"minParallelism\\\":1}},{\\\"id\\\":2,\\\"type\\\":\\\"StreamExecSink\\\",\\\"desc\\\":\\\"Sink: blackhole_sink[79]\\\",\\\"profile\\\":{\\\"group\\\":\\\"default\\\",\\\"parallelism\\\":1,\\\"maxParallelism\\\":32768,\\\"minParallelism\\\":1}}],\\\"edges\\\":[{\\\"source\\\":1,\\\"target\\\":2,\\\"mode\\\":\\\"PIPELINED\\\",\\\"strategy\\\":\\\"FORWARD\\\"}],\\\"vertices\\\":{\\\"717c7b8afebbfb7137f6f0f99beb2a94\\\":[1,2]}}"
},
"basicResourceSetting": {
"parallelism": 4,
"jobmanagerResourceSettingSpec": {
"cpu": 2,
"memory": "4 GiB"
},
"taskmanagerResourceSettingSpec": {
"cpu": 2,
"memory": "4 GiB"
}
}
},
"batchResourceSetting": {
"maxSlot": 10,
"basicResourceSetting": {
"parallelism": 4
}
},
"labels": {
"test": "test",
"test2": 1
},
"localVariables": [
{
"name": "test",
"value": "datagen"
}
],
"workspace": "edcef******b4f",
"createdAt": "1714058507\n",
"modifiedAt": "1714058843",
"referencedDeploymentDraftId": "00000000-0000-0000-0000-000000000003"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。