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

DataWorks:ListRoutes

最終更新日:Sep 03, 2026

ネットワークリソースのルートリストを取得します。

操作説明

この特徴を使用するには、DataWorks Basic Edition 以上のエディションを購入する必要があります。

今すぐお試しください

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

list

*すべてのリソース。

*

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

ResourceGroupId

string

必須

汎用クォータの一意識別子。

Serverless_res_グループ_524257424564736_6831777003XXXXX

NetworkId

integer

任意

ネットワークリソースの ID。

1000

PageSize

integer

任意

1 ページあたりのエントリ数。

100

PageNumber

integer

任意

ページ番号。

1

SortBy

string

任意

ソートフィールドのリスト。スケジュール時刻や開始時刻などのフィールドがサポートされています。フォーマットは「ソートフィールド + ソート順 (Desc/Asc)」です (省略した場合のデフォルトは Asc)。有効な値:

  • Id (Desc/Asc): ルート ID

  • DestinationCidr (Desc/Asc): 送信先 CIDR

  • CreateTime (Desc/Asc): 作成時間

デフォルト値: CreateTime Asc。

CreateTime Asc

レスポンスフィールド

フィールド

型

説明

例

object

レスポンススキーマ。

Success

boolean

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

true

PagingInfo

object

ページング情報。

RouteList

array<object>

ネットワークリソースのルートリスト。

object

ルートの詳細。

Id

integer

ルート ID

1000

ResourceGroupId

string

所属するリソースグループの一意な識別子です。

Serverless_res_group_524257424564736_6831777003****

ResourceId

string

ネットワークリソースの一意な識別子です。

ns-679XXXXXX

DestinationCidr

string

ルートの宛先 CIDR ブロックです。

192.168.0.0/16

CreateTime

integer

作成時刻(64 ビットのタイムスタンプ)です。

1727055811000

NetworkId

integer

ネットワークリソース ID

1000

PageNumber

integer

ページ番号。

1

PageSize

integer

1 ページあたりのエントリ数。

100

TotalCount

integer

エントリの総数。

100

RequestId

string

ログの特定および問題のトラブルシューティングに使用されるリクエスト ID。

6A6CBE87-9F91-1323-B680-E7A7065XXXXX

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "PagingInfo": {
    "RouteList": [
      {
        "Id": 1000,
        "ResourceGroupId": "Serverless_res_group_524257424564736_6831777003****",
        "ResourceId": "ns-679XXXXXX",
        "DestinationCidr": "192.168.0.0/16",
        "CreateTime": 1727055811000,
        "NetworkId": 1000
      }
    ],
    "PageNumber": 1,
    "PageSize": 100,
    "TotalCount": 100
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

エラーコード

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

変更履歴

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