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

DataWorks:TestNetworkConnection

最終更新日:Mar 21, 2026

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

今すぐお試しください

この 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:*

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ProjectId

integer

必須

データソースが属する DataWorks ワークスペースの ID です。ID を照会するには、ListProjects 操作を呼び出してください。

100001

DatasourceName

string

必須

データソースの名称です。

mysql_name

EnvType

string

必須

データソースが存在する環境です。有効な値は以下のとおりです。

  • 0:開発環境

  • 1:本番環境

1

ResourceGroup

string

必須

リソースグループの識別子です。識別子を照会するには、ListResourceGroups 操作を呼び出してください。

S_res_group_2XXXX4_1619100XXXXX

レスポンスフィールド

フィールド

説明

object

Success

boolean

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

  • true

  • false

true

RequestId

string

リクエスト ID です。この ID を使用してログを特定し、問題をトラブルシューティングできます。

0000-ABCD-EFG

TaskList

object

接続性テストに関する情報です。

ConnectMessage

string

データソースとリソースグループが接続性テストに失敗した理由です。データソースとリソースグループが接続性テストに合格した場合は、このパラメーターは空になります。

Connectable

ConnectStatus

boolean

接続性テストの結果です。有効な値は以下のとおりです。

  • true:データソースとリソースグループが接続性テストに合格しました。

  • false:データソースとリソースグループが接続性テストに失敗しました。ConnectMessage パラメーターに基づいて問題をトラブルシューティングしてください。

true

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "0000-ABCD-EFG\t",
  "TaskList": {
    "ConnectMessage": "Connectable",
    "ConnectStatus": true
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Invalid.DI.Parameter The parameter is invalid.
500 InternalError.DI.Parameter A DI internal error occurred.
403 Forbidden.DI.NoPrivilege No access.

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

変更履歴

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