すべてのプロダクト
Search

このプロダクト

    DataWorks:TestDataSourceConnectivity

    ドキュメントセンター

    DataWorks:TestDataSourceConnectivity

    最終更新日:Mar 21, 2026

    リソースグループ上のデータソースのネットワーク接続性をテストします。

    操作説明

    1. 本機能を利用するには、DataWorks Basic Edition 以降のエディションをご購入いただく必要があります。

    2. DataWorks ワークスペースにおいて、以下のいずれかのロールを付与されている必要があります：
      テナント所有者、ワークスペース管理者、デプロイメント、開発者、プロジェクト所有者、または O&M。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dataworks:TestDataSourceConnectivity

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ResourceGroupId

    string

    必須

    リソースグループ ID。

    Serverless_res_group_524257424564736_6831777003XXXXX
    DataSourceId

    integer

    必須

    ネットワーク接続性をテストするデータソースの ID。

    144544
    ProjectId

    integer

    必須

    DataWorks ワークスペース ID。

    10001

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    RequestId

    string

    リクエスト ID。

    4CDF7B72-020B-542A-8465-21CFFA81****
    Connectivity

    object

    接続性テストの詳細情報。

    ConnectState

    string

    接続性テストの結果。有効な値：Connectable（ネットワークに接続可能）、ConfigError（ネットワークには接続可能だが構成が不適切）、Unreachable（ネットワークに到達不可）、Unsupport（その他の原因でエラーが発生。例：対象のリソースグループが初期化中である場合）。

    Connectable
    ConnectMessage

    string

    接続性テストが失敗した場合に返されるエラーメッセージ。接続性テストが成功した場合は、このメッセージは返されません。

    DetailLogs

    array<object>

    接続性テストにおける各ステップの詳細ログ。

    object

    StartTime

    integer

    ステップの開始時刻。

    1730217600001
    EndTime

    integer

    ステップの終了時刻。

    1730217604002
    Code

    string

    テスト項目のコード。

    validate_input_parameters
    Message

    string

    ステップの名称。

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "4CDF7B72-020B-542A-8465-21CFFA81****",
  "Connectivity": {
    "ConnectState": "Connectable",
    "ConnectMessage": "连接数据库失败",
    "DetailLogs": [
      {
        "StartTime": 1730217600001,
        "EndTime": 1730217604002,
        "Code": "validate_input_parameters",
        "Message": "校验输入参数"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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