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

AnalyticDB:StartApsJob

最終更新日:Mar 17, 2026

AnalyticDB Pipeline Service (APS) のジョブを開始します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

adb:StartApsJob

none

*DBClusterLakeVersion

acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

リージョン ID

cn-hangzhou

ApsJobId

string

必須

ジョブ ID。

aps-******

レスポンスフィールド

フィールド

説明

object

レスポンスパラメーター。

HttpStatusCode

integer

レスポンスコード。状態コード 200 は、リクエストが成功したことを示します。

200

ApsJobId

string

ジョブ ID。

aps-******

RequestId

string

リクエスト ID。

******-3EEC-******-9F06-******

Success

boolean

リクエストが成功したかどうかを示します。有効な値は次のとおりです。

  • true

  • false

True

ErrCode

string

リクエストが失敗した場合に返されるエラーコード。

0

ErrMessage

string

リクエストが失敗した場合に返されるエラーメッセージ。

OK

Code

string

HTTP ステータスコードまたはエラーコード。

200

Message

string

返されるメッセージ。有効な値は次のとおりです。

  • リクエストが成功した場合、成功メッセージが返されます。****

  • リクエストが失敗した場合、エラーメッセージが返されます。

OK

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "ApsJobId": "aps-******",
  "RequestId": "******-3EEC-******-9F06-******",
  "Success": true,
  "ErrCode": "0",
  "ErrMessage": "OK",
  "Code": "200",
  "Message": "OK"
}

エラーコード

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

変更履歴

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