すべてのプロダクト
Search

このプロダクト

    Data Management:DescribeDLAService

    ドキュメントセンター

    Data Management:DescribeDLAService

    最終更新日:Jan 14, 2026

    バックアップスケジュールの Data Lake Analytics (DLA) サービスのステータスを照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dbs:DescribeDLAService

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupPlanId

    string

    必須

    バックアップスケジュールの ID。 DescribeBackupPlanList 操作を呼び出して、バックアップスケジュールの ID を取得できます。

    dbstooi01exXXXX
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。

    DBS

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    RequestId

    string

    リクエストの ID。

    4F1888AC-1138-4995-B9FE-D2734F61C058
    ErrCode

    string

    エラーコード。

    Param.NotFound
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true
    State

    string

    バックアップスケジュールの DLA サービスのステータス。 有効な値：

    • Running：DLA は実行中です。

    • Closing：DLA は無効化中です。

    • Closed：DLA は無効化されています。

    Running
    ErrMessage

    string

    エラーメッセージ。

    The specified parameter %s value is not valid.
    AutoAdd

    boolean

    増分データをデータレイクに自動的に追加する機能を有効にするかどうかを指定します。 この機能が有効になっている場合、DBS は新しく生成されたバックアップセットを、バックアップスケジュール用に作成されたデータレイクに追加します。 有効な値：

    • true：この機能を有効にします。

    • false：この機能を無効にします。

    true
    HaveJobFailed

    boolean

    返された結果に失敗した DLA タスクが存在するかどうかを示します。 有効な値：

    • true：失敗した DLA タスクが存在します。

    • false：失敗した DLA タスクはありません。

    false

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "State": "Running",
  "ErrMessage": "The specified parameter %s value is not valid.",
  "AutoAdd": true,
  "HaveJobFailed": false
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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