GetNetwork API リファレンスとネットワークリソースの詳細 - DataWorks - Alibaba Cloud - DataWorks

ネットワークリソースの情報を照会します。

操作説明

この API オペレーションは、DataWorks のすべてのエディションで利用可能です。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Id	integer	必須	ネットワーク ID。	1000

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Success	boolean	リクエストが成功したかどうかを示します。	true
Network	object	ネットワークリソースの情報。
Id	integer	ネットワーク ID。	1000
ResourceGroupId	string	サーバーレスリソースグループの ID。	Serverless_res_group_524257424564736_6831777003XXXXX
VpcId	string	仮想プライベートクラウド (VPC) の ID。	vpc-m2et4f3oc8msfbccXXXXX
VswitchId	string	VSwitch ID。	vsw-uf8usrhs7hjd9amsXXXXX
SecurityGroupId	string	セキュリティグループ ID。	sg-2ze13vamugr7jenXXXXX
Status	string	ネットワークリソースのステータス。有効な値は以下のとおりです。 Pending：ネットワークリソースの作成待ちです。 Creating：ネットワークリソースが作成中です。 Running：ネットワークリソースが正常に実行中です。 Deleting：ネットワークリソースが削除中です。 Deleted：ネットワークリソースは削除済みです。	Running
CreateUser	string	ネットワークリソースを作成したユーザーの ID。	11075500042XXXXX
CreateTime	integer	ネットワークリソースの作成時刻。値は 64 ビットのタイムスタンプです。	1727055811000
RequestId	string	リクエスト ID。	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "Network": {
    "Id": 1000,
    "ResourceGroupId": "Serverless_res_group_524257424564736_6831777003XXXXX",
    "VpcId": "vpc-m2et4f3oc8msfbccXXXXX",
    "VswitchId": "vsw-uf8usrhs7hjd9amsXXXXX",
    "SecurityGroupId": "sg-2ze13vamugr7jenXXXXX",
    "Status": "Running",
    "CreateUser": "11075500042XXXXX",
    "CreateTime": 1727055811000
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

エラーコード

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

変更履歴

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