DSW インスタンスの詳細を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
paidsw:GetInstance |
get |
*すべてのリソース。
|
なし | なし |
リクエスト構文
GET /api/v2/instances/{InstanceId} HTTP/1.1
パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンスの ID。インスタンス ID を取得するには、 ListInstances を参照してください。 |
dsw-730xxxxxxxxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Token |
string |
任意 |
共有トークン情報。 |
WUzWCMr325LV0bH2JH4C4HoDaKIU6C4S |
| Fields |
string |
任意 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
インスタンスの詳細。 |
||
| WorkspaceId |
string |
ワークスペースの ID。 |
40823 |
| WorkspaceName |
string |
ワークスペースの名前。 |
training_data |
| InstanceId |
string |
インスタンスの ID。 |
dsw-730xxxxxxxxxx |
| InstanceName |
string |
インスタンス名。 |
training_data |
| EcsSpec |
string |
インスタンスの ECS スペック。 |
ecs.c6.large |
| Status |
string |
インスタンスステータス。 列挙値:
|
Running |
| InstanceUrl |
string |
インスタンスの URL。 |
https://dsw-cn-shanghai.data.aliyun.com/notebook.htm?instance=3****#/ |
| JupyterlabUrl |
string |
Jupyterlab の URL。 |
https://dsw-gateway-cn-shanghai.aliyun.com/dsw-3****/lab/ |
| WebIDEUrl |
string |
Web IDE の URL。 |
https://dsw-gateway-cn-shanghai.aliyun.com/dsw-3****/ide/ |
| TerminalUrl |
string |
ターミナルの URL。 |
https://dsw-gateway-cn-shanghai.aliyun.com/dsw-3****/tty/ |
| AccumulatedRunningTimeInMs |
integer |
累積実行時間 (ミリ秒単位)。 |
3600000 |
| ImageId |
string |
イメージの ID。 |
image-05cefd0be2exxxx |
| ImageUrl |
string |
イメージの URL。 |
registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu |
| ImageName |
string |
イメージの名前。 |
py36_cpu_tf1.12_ubuntu |
| GmtCreateTime |
string |
インスタンスの作成時間。 |
2021-01-12T14:36:01Z |
| GmtModifiedTime |
string |
インスタンスの変更時間。 |
2021-01-12T14:36:01Z |
| UserId |
string |
ユーザーの ID。 |
161228528250**** |
| UserName |
string |
ユーザー名。 |
Test user |
| Datasets |
array<object> |
データセットのコレクション。 |
|
|
object |
データセットオブジェクト。データセットは NAS または OSS タイプです。データセットオブジェクトのプロパティには、データセット ID およびコンテナ内のマウントパスが含まれます。 |
||
| DatasetId |
string |
データセットの ID。 |
d-vsqjvsjp4orp5l**** |
| DatasetVersion |
string |
データセットのバージョン。 |
v1 |
| Uri |
string |
指定されたデータセットの URI。 |
oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/ |
| MountPath |
string |
コンテナ内のマウントパス。 |
/mnt/data |
| MountAccess |
string |
読み書き権限。RW: 読み書き。RO: 読み取り専用。 列挙値:
|
RW |
| Options |
string |
指定されたデータセットのマウントプロパティ。 |
{ "fs.oss.download.thread.concurrency": "10", "fs.oss.upload.thread.concurrency": "10", "fs.jindo.args": "-oattr_timeout=3 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink" } |
| OptionType |
string |
指定されたデータセットのマウントタイプ (非推奨)。 |
FastReadWrite |
| Dynamic |
boolean |
動的マウントが有効かどうかを指定します。デフォルト値: false。 |
false |
| ActualMountAccess |
string |
||
| RoleArn |
string |
||
| UserVpc |
object |
ユーザー VPC の構成。 |
|
| VpcId |
string |
VPC ID。 |
vpc-xxxxx |
| VSwitchId |
string |
vSwitch の ID。 |
vsw-xxxxx |
| SecurityGroupId |
string |
セキュリティグループの ID。 |
sg-xxxxxx |
| ExtendedCIDRs |
array |
拡張 CIDR ブロック。
|
["192.168.0.1/24", "192.168.1.1/24"] |
|
string |
拡張 CIDR ブロック。 |
"172.16.19.0/24","172.16.2.0/24","172.16.12.0/24" |
|
| DefaultRoute |
string |
デフォルトルート。 |
eth0 | eth1 |
| ForwardInfos |
array |
ポート フォワーディング情報。 |
|
| ForwardInfoResponse |
ポート フォワーディング情報のリスト。 |
||
| BandwidthLimit |
BandwidthLimit |
インターネット帯域幅調整の構成。 |
|
| Ip |
string |
||
| InstanceShutdownTimer |
object |
スケジュールされたシャットダウンタスク。 |
|
| InstanceId |
string |
インスタンスの ID。 |
dsw-730xxxxxxxxxx |
| GmtCreateTime |
string |
作成時間。 |
2021-01-12T14:36:01Z |
| GmtModifiedTime |
string |
変更時間。 |
2021-01-12T14:36:01Z |
| DueTime |
string |
スケジュールされたシャットダウン時間。 |
2021-01-12T14:36:01Z |
| RemainingTimeInMs |
integer |
シャットダウンまでの残り時間 (ミリ秒単位)。 |
3600000 |
| ReasonCode |
string |
インスタンスのエラーコード。 |
Internal Error |
| ReasonMessage |
string |
インスタンスのエラー理由。 |
ImagePullBackOff |
| PaymentType |
string |
課金タイプ。有効な値:
|
PayAsYouGo |
| LatestSnapshot |
object |
最新保存済みのユーザーイメージ。 |
|
| ImageId |
string |
イメージの ID。 |
image-05cefd0be2exxxx |
| ImageName |
string |
イメージの名前。 |
py36_cpu_tf1.12_ubuntu |
| ImageUrl |
string |
イメージの URL。 |
registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu |
| RepositoryUrl |
string |
イメージリポジトリの URL。 |
https://cr.console.alibabacloud.com/repository/cn-hangzhou/zouxu/kf/images |
| GmtCreateTime |
string |
スナップショットの作成時間。 |
2021-01-12T14:36:01Z |
| GmtModifiedTime |
string |
スナップショットの変更時間。 |
2021-01-12T14:36:01Z |
| ReasonCode |
string |
インスタンススナップショットのエラーコード。 |
Internal Error |
| ReasonMessage |
string |
インスタンススナップショットのエラーメッセージ。 |
ImagePullBackOff |
| Status |
string |
インスタンススナップショットのステータス。 列挙値:
|
Pushing |
| AcceleratorType |
string |
インスタンスのコンピューティングタイプ。 列挙値:
|
CPU |
| Accessibility |
string |
インスタンスがワークスペース内の他のユーザーに表示されるかどうかを示します。有効な値:
列挙値:
|
PRIVATE |
| EnvironmentVariables |
object |
環境変数。 |
{userName: "Chris"} |
|
string |
インスタンス起動後にコンテナに注入されるユーザー定義の環境変数。 |
app: MAAS |
|
| ResourceId |
string |
リソースの ID。サブスクリプションインスタンスに必須です。 |
dsw-12345**** |
| ResourceName |
string |
インスタンスのスペック。
|
ecs.g7.xlarge |
| Priority |
integer |
優先度。優先度の高いインスタンスにリソースが先に割り当てられます。 |
1 |
| RequestedResource |
object |
サブスクリプションシナリオで使用されるリソース構成。 |
{"CPU":"4","Memory":"8Gi","SharedMemory":"4Gi","GPU":"1","GPUType":"Tesla-V100-16G"} |
| CPU |
string |
CPU コアの数。 |
32 |
| Memory |
string |
メモリサイズ (GB 単位)。 |
32 |
| SharedMemory |
string |
共有メモリサイズ (GB 単位)。 |
32 |
| GPU |
string |
GPU の数。 |
4 |
| GPUType |
string |
GPU タイプ。有効な値:
|
v100 |
| Labels |
array<object> |
ユーザー定義のラベル。 |
{'foo': 'bar'} |
|
object |
ユーザー定義のラベル。インスタンスにカスタムラベルを追加して、カスタムプロパティをマークできます。 |
||
| Key |
string |
ユーザー定義のラベルキー。 |
stsTokenOwner |
| Value |
string |
ユーザー定義のラベル値。 |
123xxxxxxxx |
| IdleInstanceCuller |
object |
アイドル状態のインスタンスに対する自動シャットダウン設定。 |
{"InstanceId":"dsw-05cefd0be2e5a278","CpuPercentThreshold":20,"GpuPercentThreshold":10,"MaxIdleTimeInMinutes":120,"IdleTimeInMinutes":30} |
| InstanceId |
string |
インスタンスの ID。 |
dsw-730xxxxxxxxxx |
| CpuPercentThreshold |
integer |
CPU 使用量のしきい値 (%)。有効な値: 1~100。CPU 使用量がこの値を下回ると、インスタンスはアイドル状態とみなされます。 |
20 |
| GpuPercentThreshold |
integer |
GPU 使用量のしきい値 (%)。有効な値: 1~100。このパラメーターは GPU インスタンスに対してのみ効果が適用されます。CPU および GPU の使用量がそれぞれのしきい値を下回ると、インスタンスはアイドル状態とみなされます。 |
10 |
| MaxIdleTimeInMinutes |
integer |
最大アイドル時間のしきい値 (分単位)。アイドル持続時間がこの最大値を超えると、DSW インスタンスは自動的に停止されます。 |
60 |
| IdleTimeInMinutes |
integer |
インスタンスの現在のアイドル持続時間 (分単位)。 |
30 |
| InstanceSnapshotList |
array<object> |
インスタンススナップショットのリスト。 |
[] |
|
object |
インスタンススナップショット。 |
||
| ImageId |
string |
イメージの ID。 |
image-05cefd0be2exxxx |
| ImageName |
string |
イメージの名前。 |
py36_cpu_tf1.12_ubuntu |
| ImageUrl |
string |
イメージの URL。 |
registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu |
| RepositoryUrl |
string |
イメージリポジトリの URL。 |
https://cr.console.alibabacloud.com/repository/cn-hangzhou/zouxu/kf/images |
| GmtCreateTime |
string |
スナップショットの作成時間。 |
2021-01-12T14:36:01Z |
| GmtModifiedTime |
string |
スナップショットの変更時間。 |
2021-01-12T14:36:01Z |
| ReasonCode |
string |
インスタンススナップショットのエラーコード。 |
Internal Error |
| ReasonMessage |
string |
インスタンススナップショットのエラーメッセージ。 |
ImagePullBackOff |
| Status |
string |
インスタンススナップショットのステータス。 |
Pushing |
| CloudDisks |
array<object> |
インスタンスのクラウドディスクリスト。 |
[] |
|
array<object> |
クラウドディスク情報。 |
||
| Capacity |
string |
クラウドディスク容量。 |
30Gi |
| SubType |
string |
クラウドディスクの使用率タイプ。rootfs: rootfs としてマウント。 |
rootfs |
| MountPath |
string |
コンテナ内のクラウドディスクのマウントパス。 |
/mmt/workspace |
| Path |
string |
クラウドディスク上のマウント済みディレクトリパス。 |
/workspace |
| Status |
object |
||
| Available |
integer |
||
| Usage |
integer |
||
| Capacity |
integer |
||
| WorkspaceSource |
string |
ワークスペースが指すストレージ。未指定の場合は、NAS、CloudDisk、ローカルディスクの順に使用されます。 |
d-123456789 |
| RequestId |
string |
リクエストの ID。 |
E7D55162-4489-1619-AAF5-3F97D5FC**** |
| Success |
boolean |
成功フラグ。有効な値:
|
true |
| Message |
string |
操作結果の説明。
|
null |
| Code |
string |
状態コード。有効な値:
|
null |
| HttpStatusCode |
integer |
HTTP 状態コード。有効な値:
|
null |
| Driver |
string |
NVIDIA ドライバーの構成。 |
535.54.03 |
| NodeErrorRecovery |
object |
ノードエラー復旧の構成。 |
|
| hasNodeError |
boolean |
ノードエラーが存在するかどうかを示します。 |
false |
| enableAutoSwitchOnNodeError |
boolean |
ノードエラー発生時に自動切り替えを有効にするかどうかを指定します。 |
true |
| autoSwitchCountdownSeconds |
integer |
自動切り替えまでの待機秒数。 |
30 |
| CredentialConfig | CredentialConfig |
認証情報注入の構成。 |
|
| Affinity |
object |
アフィニティ構成。 |
|
| CPU |
object |
CPU アフィニティ構成。汎用サブスクリプションインスタンスのみサポートされています。 |
|
| Enable |
boolean |
CPU アフィニティを有効にするかどうかを指定します。 true: 有効。false: 無効。 |
true |
| ImageAuth |
string |
Base64 エンコーディング後のユーザーの非公開イメージのアカウントおよびパスワード情報。パスワード部分は非表示になっています。 |
YWxpeXVuNjUzMzM5MjIwMzoqKioqKio= |
| Tags |
array<object> |
タグリスト。 |
|
|
object |
リソースタグ。 |
||
| TagKey |
string |
タグキー。 |
tag1 |
| TagValue |
string |
タグ値。 |
value1 |
| DynamicMount | DynamicMount |
動的マウント構成。 |
|
| ProxyPath |
string |
プロキシパス。 |
dsw-170197/proxy/ |
| UserCommandId |
string |
カスタムコマンド ID。この ID を使用して GetUserCommand 操作を呼び出し、カスタムコマンドの内容を取得できます。 |
1900 |
| ServiceConfig |
ServiceConfig |
||
| PodIps |
array |
||
| PodIp | |||
| MigrationOptions |
object |
||
| AccessRestrictionRules |
object |
||
|
string |
|||
| DockerConfig |
object |
||
| Enable |
boolean |
||
| ContainersLimit |
integer |
10 |
|
| MountAccessConfigPath |
string |
/etc/docker/dockerboard/mount_access.json |
|
| TenantId |
string |
||
| UserMetricsEndpoints |
array |
||
| UserMetricsEndpoint |
例
成功レスポンス
JSONJSON
{
"WorkspaceId": "40823",
"WorkspaceName": "training_data",
"InstanceId": "dsw-730xxxxxxxxxx",
"InstanceName": "training_data",
"EcsSpec": "ecs.c6.large",
"Status": "Running",
"InstanceUrl": "https://dsw-cn-shanghai.data.aliyun.com/notebook.htm?instance=3****#/",
"JupyterlabUrl": "https://dsw-gateway-cn-shanghai.aliyun.com/dsw-3****/lab/",
"WebIDEUrl": "https://dsw-gateway-cn-shanghai.aliyun.com/dsw-3****/ide/",
"TerminalUrl": "https://dsw-gateway-cn-shanghai.aliyun.com/dsw-3****/tty/",
"AccumulatedRunningTimeInMs": 3600000,
"ImageId": "image-05cefd0be2exxxx",
"ImageUrl": "registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu",
"ImageName": "py36_cpu_tf1.12_ubuntu",
"GmtCreateTime": "2021-01-12T14:36:01Z",
"GmtModifiedTime": "2021-01-12T14:36:01Z",
"UserId": "161228528250****",
"UserName": "Test user",
"Datasets": [
{
"DatasetId": "d-vsqjvsjp4orp5l****",
"DatasetVersion": "v1",
"Uri": "oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/",
"MountPath": "/mnt/data",
"MountAccess": "RW",
"Options": "{\n \"fs.oss.download.thread.concurrency\": \"10\",\n \"fs.oss.upload.thread.concurrency\": \"10\",\n \"fs.jindo.args\": \"-oattr_timeout=3 -oentry_timeout=0 -onegative_timeout=0 -oauto_cache -ono_symlink\"\n}",
"OptionType": "FastReadWrite",
"Dynamic": false,
"ActualMountAccess": "",
"RoleArn": ""
}
],
"UserVpc": {
"VpcId": "vpc-xxxxx",
"VSwitchId": "vsw-xxxxx",
"SecurityGroupId": "sg-xxxxxx",
"ExtendedCIDRs": [
"\"172.16.19.0/24\",\"172.16.2.0/24\",\"172.16.12.0/24\""
],
"DefaultRoute": "eth0 | eth1",
"ForwardInfos": [
{
"Enable": true,
"ContainerName": "dsw-notebook",
"ForwardPort": "22",
"NatGatewayId": "ngw-bp1uewa15k4iy5770****",
"EipAllocationId": "eip-25877c70gddh****",
"SSHPublicKey": "ssh-rsa AAAAB3****************************\n",
"ConnectInfo": {
"Phase": "Ready",
"Message": "DNAT and privateZone are both ready.",
"Intranet": {
"Endpoint": "dsw-notebook-22-urz3u6cnu0uts7ej9r.dsw-5cc6083084818f60.dsw.pai.alibaba.com",
"Port": "22"
},
"Internet": {
"Endpoint": "47.111.119.114",
"Port": "22"
}
},
"Name": "ssh",
"ExternalPort": "1024",
"AccessType": [
"intranet"
],
"NlbGatewayId": ""
}
],
"BandwidthLimit": {
"EgressWhitelists": [
""
],
"IngressRate": "",
"EgressRate": "",
"IngressWhitelists": [
""
]
},
"Ip": ""
},
"InstanceShutdownTimer": {
"InstanceId": "dsw-730xxxxxxxxxx",
"GmtCreateTime": "2021-01-12T14:36:01Z",
"GmtModifiedTime": "2021-01-12T14:36:01Z",
"DueTime": "2021-01-12T14:36:01Z",
"RemainingTimeInMs": 3600000
},
"ReasonCode": "Internal Error",
"ReasonMessage": "ImagePullBackOff",
"PaymentType": "PayAsYouGo",
"LatestSnapshot": {
"ImageId": "image-05cefd0be2exxxx",
"ImageName": "py36_cpu_tf1.12_ubuntu",
"ImageUrl": "registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu",
"RepositoryUrl": "https://cr.console.alibabacloud.com/repository/cn-hangzhou/zouxu/kf/images",
"GmtCreateTime": "2021-01-12T14:36:01Z",
"GmtModifiedTime": "2021-01-12T14:36:01Z",
"ReasonCode": "Internal Error",
"ReasonMessage": "ImagePullBackOff",
"Status": "Pushing"
},
"AcceleratorType": "CPU",
"Accessibility": "PRIVATE",
"EnvironmentVariables": {
"key": "app: MAAS"
},
"ResourceId": "dsw-12345****",
"ResourceName": "ecs.g7.xlarge",
"Priority": 1,
"RequestedResource": {
"CPU": "32",
"Memory": "32",
"SharedMemory": "32",
"GPU": "4",
"GPUType": "v100"
},
"Labels": [
{
"Key": "stsTokenOwner",
"Value": "123xxxxxxxx"
}
],
"IdleInstanceCuller": {
"InstanceId": "dsw-730xxxxxxxxxx",
"CpuPercentThreshold": 20,
"GpuPercentThreshold": 10,
"MaxIdleTimeInMinutes": 60,
"IdleTimeInMinutes": 30
},
"InstanceSnapshotList": [
{
"ImageId": "image-05cefd0be2exxxx",
"ImageName": "py36_cpu_tf1.12_ubuntu",
"ImageUrl": "registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu",
"RepositoryUrl": "https://cr.console.alibabacloud.com/repository/cn-hangzhou/zouxu/kf/images",
"GmtCreateTime": "2021-01-12T14:36:01Z",
"GmtModifiedTime": "2021-01-12T14:36:01Z",
"ReasonCode": "Internal Error",
"ReasonMessage": "ImagePullBackOff",
"Status": "Pushing"
}
],
"CloudDisks": [
{
"Capacity": "30Gi",
"SubType": "rootfs",
"MountPath": "/mmt/workspace",
"Path": "/workspace",
"Status": {
"Available": 0,
"Usage": 0,
"Capacity": 0
}
}
],
"WorkspaceSource": "d-123456789",
"RequestId": "E7D55162-4489-1619-AAF5-3F97D5FC****",
"Success": true,
"Message": "null",
"Code": "null",
"HttpStatusCode": 0,
"Driver": "535.54.03",
"NodeErrorRecovery": {
"hasNodeError": false,
"enableAutoSwitchOnNodeError": true,
"autoSwitchCountdownSeconds": 30
},
"CredentialConfig": {
"Enable": true,
"AliyunEnvRoleKey": "0",
"Configs": [
{
"Key": "0",
"Type": "Role",
"Roles": [
{
"RoleArn": "acs:ram::123******:role/****",
"RoleType": "service",
"AssumeRoleFor": "123******",
"Policy": "{}",
"UserInfo": {
"Id": "456******",
"Type": "S",
"AccessKeyId": "LT********",
"SecurityToken": "********"
}
}
]
}
]
},
"Affinity": {
"CPU": {
"Enable": true
}
},
"ImageAuth": "YWxpeXVuNjUzMzM5MjIwMzoqKioqKio=",
"Tags": [
{
"TagKey": "tag1",
"TagValue": "value1"
}
],
"DynamicMount": {
"Enable": true,
"MountPoints": [
{
"RootPath": "/mnt/dynamic/",
"Options": "{}"
}
]
},
"ProxyPath": "dsw-170197/proxy/",
"UserCommandId": "1900",
"ServiceConfig": {
"JupyterServerPassword": "",
"JupyterServerAuth": "",
"CodeServerPassword": "",
"CodeServerAuth": ""
},
"PodIps": [
{
"Type": "",
"Ip": "",
"InterfaceName": ""
}
],
"MigrationOptions": {
"test": "test",
"test2": 1
},
"AccessRestrictionRules": {
"key": ""
},
"DockerConfig": {
"Enable": false,
"ContainersLimit": 10,
"MountAccessConfigPath": "/etc/docker/dockerboard/mount_access.json"
},
"TenantId": "",
"UserMetricsEndpoints": [
{
"Port": 0,
"Path": ""
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。