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

指定された個人用開発環境インスタンスの詳細を照会します。

操作説明

指定された個人用開発環境 (ServerIDE) インスタンスの基本情報、実行中のステータス、イメージ、ネットワーク、データセット、および認証情報の構成を照会します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	個人用開発環境インスタンスの ID。ListServerIdeInstances を呼び出して ID を取得できます。	699573

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
RequestId	string	リクエスト ID。	E7D55162-4489-1619-AAF5-3F97D5FCA948
Instance	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 ロールの Amazon リソースネーム (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

例

成功レスポンス

JSONJSON

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Instance": {
    "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"
              }
            }
          ]
        }
      ]
    }
  }
}

エラーコード

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

変更履歴

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