GetInstance API参考-人工智能平台 PAI-阿里云-人工智能平台 PAI(PAI)-阿里云帮助中心

查询DSW实例详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

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	实例状态。枚举值： Creating : 创建中 SaveFailed : 镜像保存失败 Stopped : 已停止 Failed : 失败 ResourceAllocating : 资源分配中 Stopping : 停止中 Updating : 更新中 Saving : 镜像保存中 Queuing : 排队中 Recovering : 实例恢复中 Starting : 创建中 Running : 运行中 Saved : 镜像保存成功 Deleting : 删除中 EnvPreparing : 环境准备中	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	镜像地址。	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	用户名称。	测试用户
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 : RW RO : 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
UserVpc	object	User VPC 配置。
VpcId	string	VPC ID。	vpc-xxxxx
VSwitchId	string	交换机 ID。	vsw-xxxxx
SecurityGroupId	string	安全组 ID。	sg-xxxxxx
ExtendedCIDRs	array	扩展网段。当交换机 ID 为空时，此参数可以不提供，系统会自动获取 VPC 下的所有网段。当交换机 ID 不为空时，此参数必须提供，建议填写 VPC 下的所有网段。	["192.168.0.1/24", "192.168.1.1/24"]
	string	扩展网段。	"172.16.19.0/24","172.16.2.0/24","172.16.12.0/24"
DefaultRoute	string	Default Route	eth0 \| eth1
ForwardInfos	array	端口透出信息。
	ForwardInfoResponse	端口透出信息列表。
BandwidthLimit	BandwidthLimit
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：后付费。 Subscription：预付费。	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.aliyun.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	实例快照状态。枚举值： Committing : 提交中 Pushing : 推送中 Failed : 保存失败 Saved : 保存成功	Pushing
AcceleratorType	string	实例计算类型。枚举值： CPU : CPU GPU : GPU	CPU
Accessibility	string	工作空间内是否他人可见。可能值： PRIVATE：表示工作空间内自己及管理员可见。 PUBLIC：工作空间所有用户可见。枚举值： PUBLIC : 工作空间所有用户可见 PRIVATE : 工作空间内自己及管理员可见	PRIVATE
EnvironmentVariables	object	环境变量。	{userName: "Chris"}
	string	用户自定义的环境变量，将会在实例启动后，注入到容器内部。	app: MAAS
ResourceId	string	资源 ID。预付费时填写。	dsw-12345****
ResourceName	string	实例规格。预付费（subscription），是请求的 CPU 和内存大小。后付费（pay-as-you-go），是选择的 ECS 规格。	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 A100 T4 A10 P100	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，低于此值则认为实例当前处于闲置。	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.aliyun.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 false	true
Message	string	操作结果说明。执行成功时，返回结果为 null。执行失败时，描述失败原因。	null
Code	string	状态码，可能值： InternalError：内部错误（除了参数验证错误外的其他错误，目前都归类到内部错误）。 ValidationError：参数验证错误。	null
HttpStatusCode	integer	HTTP 状态码，可能值： 400 404	null
Driver	string	NVIDIA 驱动配置	535.54.03
NodeErrorRecovery	object	节点错误恢复配置。
hasNodeError	boolean	是否有节点错误。	false
enableAutoSwitchOnNodeError	boolean	当出现节点错误时，是否开启自动切换。	true
autoSwitchCountdownSeconds	integer	自动切换时等待秒数。	30
CredentialConfig	CredentialConfig	Credential 注入配置。
Affinity	object	亲和性配置。
CPU	object	CPU 亲和性配置。仅支持通用计算预付费实例。
Enable	boolean	是否开启 CPU 亲和性。 true：开启。 false：不开启。	true
ImageAuth	string	用户私有镜像的账号密码信息 base64 编码后的值，密码部分会被隐藏。	YWxpeXVuNjUzMzM5MjIwMzoqKioqKio=
Tags	array<object>	标签列表。
	object	资源标签。
TagKey	string	标签 Key。	tag1
TagValue	string	标签值。	value1
DynamicMount	DynamicMount	动态挂载配置。
ProxyPath	string	Proxy 的路径。	dsw-170197/proxy/
UserCommandId	string	自定义命令 ID。可根据此 ID 调用 GetUserCommand 接口获取自定义命令具体内容。	1900

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。