ListServerIdeInstances - DataWorks - Alibaba Cloud ドキュメントセンター

個人開発環境インスタンスのページングリストを照会します。

操作説明

個人開発環境（ServerIDE）インスタンスのページングクエリリストを照会します。ワークスペース、リソースグループ、キーワード、オーナー、およびインスタンスの子クラスで結果をフィルターできます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	任意	DataWorks ワークスペースの ID。	10000
ResourceGroupId	string	任意	DataWorks リソースグループの識別子。数値のリソースグループ ID、または Serverless_res_group_{tenantId}_{resgId} フォーマットの完全な識別子を指定できます。	Serverless_res_group_123456789012345_9876543210****
Keyword	string	任意	インスタンス ID またはインスタンス名によるあいまい一致用のキーワード。	notebook_dev
RelatedUserId	string	任意	インスタンスを所有するユーザーのアカウント ID。オーナー別にインスタンスをフィルターするために使用します。	20933221576142****
SubType	string	任意	インスタンスのサブタイプ。有効な値: PERSONAL_DEV: 個人開発環境。 DATA_AGENT: Data Agent。	PERSONAL_DEV
PageNumber	integer	任意	ページ番号。最小値: 1。	1
PageSize	integer	任意	1 ページあたりのレコード数。	10
MaxResults	integer	任意	1 回のリクエストで返すレコードの最大値。	20
NextToken	string	任意	次のクエリ用のページネーショントークン。最初のリクエストではこのパラメーターを指定する必要はありません。	CAESG****

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
RequestId	string	リクエスト ID。	E7D55162-4489-1619-AAF5-3F97D5FCA948
PagingInfo	object	ページング情報のフォーマット。
PageNumber	integer	現在のページ番号。	1
PageSize	integer	1 ページあたりのレコード数。	10
TotalCount	integer	フィルター条件に一致するレコードの総数。	3
Instances	array<object>	個人用開発環境インスタンスのリスト。
	array<object>	個人用開発環境インスタンス情報のフォーマット。
InstanceId	string	個人用開発環境インスタンスの ID。	699573
InstanceName	string	個人用開発環境インスタンス名。	notebook_dev
Status	string	インスタンスステータス。有効な値: Creating、Starting、Running、Stopping、Stopped、Updating、Deleting、DELETED、Failed、Arrearage、Saving、SaveFailed、Saved。	Running
ResourceGroupId	integer	リソースグループの内部数値 ID。	9876543210
ResourceGroupName	string	リソースグループ名。	serverless_group
Cu	integer	インスタンスで使用されている CU 数。	10
ProjectId	integer	DataWorks ワークスペースの ID。	10000
ProjectName	string	DataWorks ワークスペース名。	example_project
ImageId	string	インスタンスで使用されているイメージの ID。	System_serveride_notebook_20240822
ImageName	string	イメージ名。	serveride_notebook
ImageUrl	string	イメージ URL。	registry.cn-hangzhou.aliyuncs.com/example/serveride:latest
OwnerId	string	インスタンスを所有するユーザーのアカウント ID。	20933221576142****
FailReason	string	インスタンスが失敗した状態になった理由。	ImagePullBackOff
CreateTime	integer	インスタンスが作成された時間。値はミリ秒単位の UNIX タイムスタンプです。	1756000000000
UpdateTime	integer	インスタンスが最後に更新された時間。値はミリ秒単位の UNIX タイムスタンプです。	1756003600000
UserVpc	object	インスタンスで使用されている VPC 構成。
SecurityGroupId	string	セキュリティグループ ID。	sg-bp1****
VSwitchId	string	vSwitch ID。	vsw-bp1****
VpcId	string	VPC ID。	vpc-bp1****
ForwardInfos	array<object>	ポートフォワーディング構成のリスト。
	object	ポートフォワーディング構成。
AccessType	array	アクセスタイプのリスト。
	string	アクセスタイプ。有効な値: intranet: 内部ネットワーク。 internet: パブリックネットワーク。	intranet
ContainerName	string	ターゲットコンテナの名前。	dsw-notebook
EipAllocationId	string	EIP のインスタンス ID。	eip-bp1****
Enable	boolean	ポートフォワーディング構成が有効かどうかを示します。
ExternalPort	string	マッピングされたパブリックポート。	1024
ForwardPort	string	インスタンスコンテナ内のターゲットポート。	22
Name	string	ポートフォワーディング構成の名前。	ssh
NatGatewayId	string	NAT Gateway の ID。	ngw-bp1****
SSHPublicKey	string	SSH アクセスに使用される公開鍵。	ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ****
Datasets	array<object>	インスタンスにマウントされているデータセットのリスト。
	object	データセットのマウント構成。
Identifier	string	データセット識別子。	d-vsqjvs****rp5l206u
Version	integer	データセットのバージョン番号。	1
MountPath	string	インスタンス内のデータセットのマウントパス。	/mnt/data
ReadOnly	boolean	データセットが読み取り専用モードでマウントされているかどうかを示します。
ExtOptions	string	データセットのカスタムマウントプロパティ。内容はマウントオプションとして渡されます。	{"fs.oss.download.thread.concurrency":"10"}
Uri	string	直接マウント用のストレージサービスディレクトリの URI。	oss://example-bucket/data/
CredentialConfig	object	インスタンスの認証情報注入構成。この特徴を有効にすると、デフォルトの RAM ロールチェーンを使用するか、カスタム RAM ロールを指定できます。
Enable	boolean	認証情報注入が有効かどうかを示します。
AliyunEnvRoleKey	string	環境変数ロールキー。	0
Configs	array<object>	認証情報構成のリスト。
	array<object>	認証情報構成。
Key	string	認証情報構成の識別子キー。	0
Type	string	認証情報構成タイプ。有効な値: Role: 単一ロールの引き受け。 RoleChain: ロールチェーンの引き受け。	RoleChain
Roles	array<object>	認証情報構成内のロールのリスト。
	array<object>	ロールの引き受け構成。
AssumeRoleFor	string	引き受けるロールを所有するエンティティの Alibaba Cloud アカウント ID。	123456789012****
Policy	string	ロールの権限をさらに制限するために使用されるポリシー。	{}
RoleArn	string	RAM ロールの Alibaba Cloud リソースネーム (ARN)。	acs:ram::123456789012****:role/DataWorksRole
RoleType	string	ロールの引き受けタイプ。有効な値: service: サービスによる引き受け。 user: ユーザーによる引き受け。	service
UserInfo	object	委任されたユーザーの情報のフォーマット。
AccessKeyId	string	認証情報注入に使用される一時的な AccessKey ID。	STS.N*********7
Id	string	委任されたユーザーのアカウント ID。	20933221576142****
SecurityToken	string	認証情報注入に使用される一時的なセキュリティトークン。	DFE32G*******
Type	string	ユーザータイプ。有効な値: customer: Alibaba Cloud アカウント。 sub: RAM ユーザー。 AssumedRoleUser: RAM ロール。	sub
MaxResults	integer	この応答で返されるレコードの最大値。	20
NextToken	string	次のページのページネーショントークン。空の値は、これ以上結果がないことを示します。	CAESG****

例

成功レスポンス

JSONJSON

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "PagingInfo": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 3,
    "Instances": [
      {
        "InstanceId": "699573",
        "InstanceName": "notebook_dev",
        "Status": "Running",
        "ResourceGroupId": 9876543210,
        "ResourceGroupName": "serverless_group",
        "Cu": 10,
        "ProjectId": 10000,
        "ProjectName": "example_project",
        "ImageId": "System_serveride_notebook_20240822",
        "ImageName": "serveride_notebook",
        "ImageUrl": "registry.cn-hangzhou.aliyuncs.com/example/serveride:latest",
        "OwnerId": "20933221576142****",
        "FailReason": "ImagePullBackOff",
        "CreateTime": 1756000000000,
        "UpdateTime": 1756003600000,
        "UserVpc": {
          "SecurityGroupId": "sg-bp1****",
          "VSwitchId": "vsw-bp1****",
          "VpcId": "vpc-bp1****",
          "ForwardInfos": [
            {
              "AccessType": [
                "intranet"
              ],
              "ContainerName": "dsw-notebook",
              "EipAllocationId": "eip-bp1****",
              "Enable": false,
              "ExternalPort": "1024",
              "ForwardPort": "22",
              "Name": "ssh",
              "NatGatewayId": "ngw-bp1****",
              "SSHPublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ****"
            }
          ]
        },
        "Datasets": [
          {
            "Identifier": "d-vsqjvs****rp5l206u",
            "Version": 1,
            "MountPath": "/mnt/data",
            "ReadOnly": false,
            "ExtOptions": "{\"fs.oss.download.thread.concurrency\":\"10\"}",
            "Uri": "oss://example-bucket/data/"
          }
        ],
        "CredentialConfig": {
          "Enable": false,
          "AliyunEnvRoleKey": "0",
          "Configs": [
            {
              "Key": "0",
              "Type": "RoleChain",
              "Roles": [
                {
                  "AssumeRoleFor": "123456789012****",
                  "Policy": "{}",
                  "RoleArn": "acs:ram::123456789012****:role/DataWorksRole",
                  "RoleType": "service",
                  "UserInfo": {
                    "AccessKeyId": "STS.N*********7",
                    "Id": "20933221576142****",
                    "SecurityToken": "DFE32G*******",
                    "Type": "sub"
                  }
                }
              ]
            }
          ]
        }
      }
    ]
  },
  "MaxResults": 20,
  "NextToken": "CAESG****"
}

エラーコード

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

変更履歴

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