diff options
Diffstat (limited to 'data/zh_cn/pai-dsw/2021-02-26')
| -rw-r--r-- | data/zh_cn/pai-dsw/2021-02-26/api-docs.php | 1553 |
1 files changed, 1553 insertions, 0 deletions
diff --git a/data/zh_cn/pai-dsw/2021-02-26/api-docs.php b/data/zh_cn/pai-dsw/2021-02-26/api-docs.php new file mode 100644 index 0000000..20f4c70 --- /dev/null +++ b/data/zh_cn/pai-dsw/2021-02-26/api-docs.php @@ -0,0 +1,1553 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'pai-dsw', + 'version' => '2021-02-26', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'GetInstance', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'Cluster' => [ + 'title' => 'A short description of struct', + 'description' => 'Cluster', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'title' => '集群id', + 'description' => '集群ID', + 'type' => 'string', + 'example' => 'c07f93axxxxxxxx', + ], + 'Owner' => [ + 'title' => '集群owner', + 'description' => '集群Owner', + 'type' => 'string', + 'example' => '134xxxxxxxx', + ], + 'VpcId' => [ + 'title' => '集群vpc', + 'description' => '虚拟网络ID', + 'type' => 'string', + 'example' => 'vpc-xxxxxxxx', + ], + 'VSwitchId' => [ + 'title' => '集群vSwitch', + 'description' => '虚拟交换机ID', + 'type' => 'string', + 'example' => 'vsw-xxxxxxxx', + ], + 'Name' => [ + 'title' => '集群名称', + 'description' => '名称', + 'type' => 'string', + 'example' => 'test-cluster', + ], + 'ClusterType' => [ + 'title' => '集群类型', + 'description' => '类型', + 'type' => 'string', + 'example' => 'ManagedKubernetes', + ], + 'State' => [ + 'title' => '集群状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'Running', + ], + 'Config' => [ + 'title' => '集群配置', + 'description' => '配置', + 'type' => 'string', + 'example' => 'k8sConfigFile', + ], + 'Nas' => [ + 'title' => 'nas文件id', + 'description' => '文件系统', + 'type' => 'string', + 'example' => '3157748031', + ], + 'PrivateNasPath' => [ + 'title' => '个人nas挂载路径', + 'description' => '私有文件系统路径', + 'type' => 'string', + 'example' => '/', + ], + 'PrivateContainerPath' => [ + 'title' => '个人nas挂载到容器路径', + 'description' => '私有挂载路径', + 'type' => 'string', + 'example' => '/home/admin/workspace', + ], + 'PublicNasPath' => [ + 'title' => '公共nas挂载路径', + 'description' => '公共文件系统路径', + 'type' => 'string', + 'example' => '/', + ], + 'PublicContainerPath' => [ + 'title' => '公共nas挂载到容器的路径', + 'description' => '公共文件系统挂载路径', + 'type' => 'string', + 'example' => '/home/admin/workspace/workgroup', + ], + ], + ], + 'Config' => [ + 'title' => 'A short description of struct', + 'description' => 'Config', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '配置名称', + 'description' => '配置名称', + 'type' => 'string', + 'example' => 'EnableCluster', + ], + 'Value' => [ + 'title' => '配置数值', + 'description' => '配置值', + 'type' => 'string', + 'example' => 'True', + ], + ], + ], + 'Dataset' => [ + 'title' => '数据集', + 'description' => 'Dataset', + 'type' => 'object', + 'properties' => [ + 'DatasetId' => [ + 'title' => '数据集id', + 'description' => '数据集ID', + 'type' => 'string', + 'example' => 'd-xxxxxxxx', + ], + 'DefaultMountPath' => [ + 'title' => '默认挂载路径', + 'description' => '默认挂载路径', + 'type' => 'string', + 'example' => '/mnt/data', + ], + 'Name' => [ + 'title' => '数据集名称', + 'description' => '名称', + 'type' => 'string', + 'example' => 'test-dataset', + ], + 'MountPath' => [ + 'title' => '挂载路径', + 'description' => '实际挂载路径', + 'type' => 'string', + 'example' => '/mnt/myData', + ], + 'NasPath' => [ + 'title' => '文件系统被挂载路径', + 'description' => '文件系统被挂载的路径', + 'type' => 'string', + 'example' => '/', + ], + 'FileSystemId' => [ + 'title' => '文件系统Id', + 'description' => '文件系统ID', + 'type' => 'string', + 'example' => '01bd34b09b', + ], + ], + ], + 'EcsSpec' => [ + 'title' => 'ecs规格', + 'description' => 'ecs规格', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'title' => '实例类型', + 'description' => '实例规格', + 'type' => 'string', + 'example' => 'ecs.gn6e-c12g1.3xlarge', + ], + 'Cpu' => [ + 'title' => 'cpu数量', + 'description' => 'CPU核心数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Gpu' => [ + 'title' => 'gpu卡数', + 'description' => 'GPU卡数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MemoryInGiB' => [ + 'title' => '内存(GiB)', + 'description' => '内存大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'SystemDiskCategory' => [ + 'title' => '磁盘类型', + 'description' => '系统盘类型', + 'type' => 'string', + 'example' => 'ssd', + ], + 'SystemDiskSizeInGiB' => [ + 'title' => '磁盘大小(GiB)', + 'description' => '系统盘大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'GpuType' => [ + 'title' => 'GPU卡类型', + 'description' => 'GPU卡型', + 'type' => 'string', + 'example' => 'v100', + ], + ], + ], + 'Image' => [ + 'title' => 'image', + 'description' => 'Image', + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'title' => '镜像ID', + 'description' => 'ID', + 'type' => 'string', + 'example' => 'img-d7adefa77718****', + ], + 'ImageName' => [ + 'title' => '镜像名称', + 'description' => '名称', + 'type' => 'string', + 'example' => 'test', + ], + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'dsw-d7adefa77718****', + ], + 'AcceleratorType' => [ + 'title' => '资源类型', + 'description' => '镜像资源类型(CPU,GPU)', + 'type' => 'string', + 'example' => 'cpu', + ], + 'Framework' => [ + 'title' => '算法框架', + 'description' => '深度学习框架(Tensorflow,Pytorch)', + 'type' => 'string', + 'example' => 'tensorflow', + ], + 'FrameworkVersion' => [ + 'title' => '算法框架版本', + 'description' => '框架版本', + 'type' => 'string', + 'example' => '2.0', + ], + 'OS' => [ + 'title' => '镜像操作系统分发版', + 'description' => '操作系统分发版(Ubuntu,Alios)', + 'type' => 'string', + 'example' => 'ubuntu', + ], + 'OSVersion' => [ + 'title' => '分发版版本', + 'description' => '操作系统分发版版本', + 'type' => 'string', + 'example' => '18.04', + ], + 'CudaVersion' => [ + 'title' => 'Cuda版本', + 'description' => 'CUDA框架版本', + 'type' => 'string', + 'example' => '10.0', + ], + 'Type' => [ + 'title' => '镜像类型', + 'description' => '镜像类型(official:官方,custom:自定义)', + 'type' => 'string', + 'example' => 'official', + ], + 'WorkspaceImageId' => [ + 'title' => '工作空间镜像id', + 'description' => '对应的工作空间镜像ID', + 'type' => 'string', + 'example' => 'img-xxxx', + ], + 'Repository' => [ + 'title' => '镜像仓库', + 'description' => '仓库', + 'type' => 'string', + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx', + ], + 'Namespace' => [ + 'title' => '镜像命名空间', + 'description' => '命名空间', + 'type' => 'string', + 'example' => 'dsw', + ], + 'Tag' => [ + 'title' => 'Tag', + 'description' => '标签', + 'type' => 'string', + 'example' => '1.5', + ], + 'GmtCreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-10-25T04:42:28Z', + ], + 'GmtModifiedTime' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2021-10-25T04:42:28Z', + ], + 'Author' => [ + 'title' => '镜像作者', + 'description' => '镜像创建者', + 'type' => 'string', + 'example' => '134xxxxxxxx', + ], + 'PythonVersion' => [ + 'title' => 'python版本', + 'description' => '镜像python版本', + 'type' => 'string', + 'example' => '3.6', + ], + 'Shared' => [ + 'title' => '镜像是否被其他实例共享', + 'description' => '镜像是否被其他人使用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型(1:CPU,2:GPU)', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RootImageId' => [ + 'title' => '镜像的根镜像', + 'description' => '根镜像ID', + 'type' => 'string', + 'example' => 'img-xxx', + ], + 'Description' => [ + 'title' => '镜像描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'xxx', + ], + 'Stage' => [ + 'title' => '镜像状态', + 'description' => '镜像状态', + 'type' => 'string', + 'example' => 'Saved', + ], + 'StageCode' => [ + 'title' => '镜像状态代码', + 'description' => '镜像状态编码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'FromImageId' => [ + 'title' => '镜像父镜像', + 'description' => '父镜像ID', + 'type' => 'string', + 'example' => 'img-xxx', + ], + 'FromImageName' => [ + 'title' => '镜像名称', + 'description' => '父镜像名称', + 'type' => 'string', + 'example' => 'pytorch1.5', + ], + 'SuggestedName' => [ + 'title' => '保存镜像建议的名称', + 'description' => '镜像建议名称', + 'type' => 'string', + 'example' => 'user_xxxxx', + ], + 'ImageUrl' => [ + 'title' => '镜像url', + 'description' => '镜像URL', + 'type' => 'string', + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/dsw/tensorflow:1.5', + ], + 'Region' => [ + 'title' => '地区', + 'description' => '地区', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'EcsImageKey' => [ + 'title' => 'Ecs镜像key', + 'description' => 'ecs镜像ID', + 'type' => 'string', + 'example' => 'e-xxxxxxx', + ], + 'ShortImageUrl' => [ + 'title' => '镜像短url', + 'description' => '镜像短URL', + 'type' => 'string', + 'example' => 'dsw/tensorflow:1.5', + ], + 'RepositoryPage' => [ + 'title' => '跳转的镜像站点页面', + 'description' => '镜像仓库aliyun页面', + 'type' => 'string', + 'example' => 'https://cr.console.aliyun.com/repository/cn-hangzhou/cloud-dsw/tensorflow/details', + ], + 'ShortRepository' => [ + 'title' => '镜像仓库短名称', + 'description' => '仓库短名称', + 'type' => 'string', + 'example' => 'dsw', + ], + ], + ], + 'ImageNamespace' => [ + 'title' => 'A short description of struct', + 'description' => '镜像管理命名空间', + 'type' => 'object', + 'properties' => [ + 'Namespace' => [ + 'title' => '命名空间名称', + 'description' => '命名空间', + 'type' => 'string', + 'example' => 'dsw', + ], + 'NamespaceStatus' => [ + 'title' => '命名空间状态', + 'description' => '命名空间状态', + 'type' => 'string', + 'example' => 'NORMAL', + ], + ], + ], + 'ImageRepository' => [ + 'title' => 'A short description of struct', + 'description' => '镜像管理镜像仓库', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'title' => '地区Id', + 'description' => '地区ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RepoNamespace' => [ + 'title' => '仓库命名空间', + 'description' => '命名空间', + 'type' => 'string', + 'example' => 'dsw', + ], + 'RepoName' => [ + 'title' => '仓库名称', + 'description' => '仓库', + 'type' => 'string', + 'example' => 'tensorflow', + ], + 'RepoStatus' => [ + 'title' => '仓库状态', + 'description' => '仓库状态', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'Repository' => [ + 'title' => '仓库地址', + 'description' => '仓库', + 'type' => 'string', + 'example' => '仓库地址', + ], + 'GmtCreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-08-26T06:56:38Z', + ], + 'GmtModifiedTime' => [ + 'title' => '修改时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2021-08-26T06:56:38Z', + ], + ], + ], + 'Instance' => [ + 'title' => 'A short description of struct', + 'description' => 'Instance', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'dsw-d7adefa77718****', + ], + 'InstanceName' => [ + 'title' => '实例名称', + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'EcsSpec' => [ + 'title' => 'ecs规格', + 'description' => '实例规格(可通过PAI-DSW的ListEcsSpecsAPI获取)。', + 'type' => 'string', + 'example' => 'ecs.g6.8xlarge', + ], + 'InstanceStatus' => [ + 'title' => '实例状态', + 'description' => '实例状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'JupyterlabUrl' => [ + 'title' => 'jupyter链接', + 'description' => 'jupyterlab(实验室)地址。', + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/lab/', + ], + 'WebIdeUrl' => [ + 'title' => 'webIde链接', + 'description' => 'web开发环境地址。', + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/ide/', + ], + 'TerminalUrl' => [ + 'title' => '命令行终端链接', + 'description' => '命令行地址。', + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/terminals/tty', + ], + 'AccumulativeRunningTimeInMinutes' => [ + 'title' => '累计运行时间(分钟)', + 'description' => '实例累计运行时间(分钟)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ImageId' => [ + 'title' => '镜像ID', + 'description' => '实例镜像ID。', + 'type' => 'string', + 'example' => 'img-d7adefa77718*****', + ], + 'ImageUrl' => [ + 'title' => '镜像链接', + 'description' => '实例镜像地址。', + 'type' => 'string', + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/image:pai-images-dsw-ubuntu18.04-py3.6-paitf1.15-build.****', + ], + 'GmtCreateTime' => [ + 'title' => '创建时间(GMT)', + 'description' => '实例创建时间。', + 'type' => 'string', + 'example' => '2021-04-01T00:00:00Z', + ], + 'GmtModifiedTime' => [ + 'title' => '修改时间(GMT)', + 'description' => '实例最后修改时间。', + 'type' => 'string', + 'example' => '2021-04-02T00:00:00Z', + ], + 'UserId' => [ + 'title' => '用户ID', + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '161228528250****', + ], + 'NasFileSystemId' => [ + 'title' => 'nas文件系统ID', + 'description' => 'nas文件系统ID。', + 'type' => 'string', + 'example' => '0051a4****', + ], + 'UserVpc' => [ + 'title' => '被打通VPC配置', + 'description' => '被打通VPC配置。', + '$ref' => '#/components/schemas/UserVpc', + ], + 'InstanceShutdownTimer' => [ + 'title' => '定时关机任务', + 'description' => '实例定时关机配置。', + '$ref' => '#/components/schemas/InstanceShutdownTimer', + ], + 'WorkspaceId' => [ + 'title' => '工作空间id', + 'description' => '工作空间编号。', + 'type' => 'string', + 'example' => '1234****', + ], + 'WorkspaceName' => [ + 'title' => '工作空间名称', + 'description' => '工作空间名称。', + 'type' => 'string', + 'example' => 'zx****', + ], + 'InstanceUrl' => [ + 'title' => 'dsw实例链接', + 'description' => '实例URL。', + 'type' => 'string', + 'example' => '//dsw-cn-beijing.data.aliyun.com/notebook.htm?instance=', + ], + 'Message' => [ + 'title' => '错误消息', + 'description' => '请求返回消息。', + 'type' => 'string', + 'example' => 'imagePullBackOff', + ], + 'ShutdownEnabled' => [ + 'title' => '是否支持定时关机', + 'description' => '是否支持定时关机', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AccumulativeRunningTimeInMillis' => [ + 'title' => '运行时间,毫秒数', + 'description' => '运行时间,毫秒数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000', + ], + 'ImageName' => [ + 'title' => '镜像名称', + 'description' => '镜像名称。', + 'type' => 'string', + ], + 'CreateUser' => [ + 'title' => '创建者', + 'description' => '创建者', + 'type' => 'string', + ], + 'ImageType' => [ + 'title' => '镜像类型', + 'description' => '镜像类型', + 'type' => 'string', + ], + 'PayType' => [ + 'title' => '付费类型代码', + 'description' => '付费类型代码', + 'type' => 'integer', + 'format' => 'int64', + ], + 'PayTypeName' => [ + 'title' => '付费类型名称', + 'description' => '付费类型名称', + 'type' => 'string', + ], + 'InstanceVersion' => [ + 'title' => '实例版本', + 'description' => '实例版本', + 'type' => 'string', + ], + 'IsPublic' => [ + 'title' => '是否他人可见', + 'description' => '是否他人可见', + 'type' => 'integer', + 'format' => 'int64', + ], + 'Resource' => [ + 'title' => '资源类型名称', + 'description' => '资源类型名称', + 'type' => 'string', + ], + 'ResourceType' => [ + 'title' => '资源类型代码', + 'description' => '资源类型代码', + 'type' => 'integer', + 'format' => 'int64', + ], + 'UserImageList' => [ + 'title' => '保存用户镜像列表', + 'description' => '保存用户镜像列表', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/Image', + ], + ], + 'DatasetList' => [ + 'title' => '数据集列表', + 'description' => '数据集列表', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + 'InstanceShutdownTimer' => [ + 'title' => 'A short description of struct', + 'description' => 'InstanceShutdownTimer', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'dsw-d7adefa77718****', + ], + 'ScheduleTime' => [ + 'title' => '定时关机时间', + 'description' => '关机时间', + 'type' => 'string', + 'example' => '2021-04-01T01:00:00Z', + ], + 'GmtModifiedTime' => [ + 'title' => '定时关机创建时间', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2021-04-01T00:00:00Z', + ], + 'GmtCreateTime' => [ + 'title' => '定时关机修改时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-04-01T00:00:00Z', + ], + 'TtlInMillis' => [ + 'title' => '多少毫秒后定时关机(如果设定可以覆盖ScheduleTime)', + 'description' => '距离关机剩余时间(毫秒)', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000000', + ], + ], + ], + 'InstanceSnapshot' => [ + 'title' => 'A short description of struct', + 'description' => 'InstanceSnapshot', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'dsw-d7adefa77718****', + ], + 'InstanceSnapshotId' => [ + 'title' => '实例快照ID', + 'description' => '实例快照ID', + 'type' => 'string', + 'example' => 'img-d7adefa77718****', + ], + 'InstanceSnapshotStatus' => [ + 'title' => '实例快照状态', + 'description' => '实例快照状态', + 'type' => 'string', + 'example' => 'Saved', + ], + 'InstanceSnapshotName' => [ + 'title' => '实例快照名称', + 'description' => '实例快照名称', + 'type' => 'string', + 'example' => 'testSnapshot', + ], + 'InstanceSnapshotTag' => [ + 'title' => '实例快照标签', + 'description' => '实例快照镜像标签', + 'type' => 'string', + 'example' => 'testSnapshot', + ], + 'InstanceSnapshotRepoUrl' => [ + 'title' => '实例快照存储地址', + 'description' => '实例快照镜像仓库URL', + 'type' => 'string', + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/image:pai-images-dsw-ubuntu18.04-py3.6-paitf1.15-build.****', + ], + 'GmtCreateTime' => [ + 'title' => '实例快照保存时间(GMT)', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-04-02T00:00:00Z', + ], + 'GmtModifiedTime' => [ + 'title' => '实例快照修改时间(GMT)', + 'description' => '修改时间', + 'type' => 'string', + 'example' => '2021-04-02T00:00:00Z', + ], + 'InstanceSnapshotDescription' => [ + 'title' => '实例快照描述', + 'description' => '实例快照描述', + 'type' => 'string', + 'example' => 'testSnapshot', + ], + ], + ], + 'InstanceStatus' => [ + 'title' => 'A short description of struct', + 'description' => '实例状态', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'dsw-d7adefa77718****', + ], + 'InstanceStatus' => [ + 'title' => '实例状态', + 'description' => '实例状态', + 'type' => 'string', + 'example' => 'Running', + ], + 'Msg' => [ + 'title' => '实例消息', + 'description' => '实例启停中错误消息', + 'type' => 'string', + 'example' => 'create timeout', + ], + 'Type' => [ + 'title' => '实例类型', + 'description' => '实例类型', + 'type' => 'string', + 'example' => 'V3', + ], + 'AccumulativeRunningTimeInMinutes' => [ + 'title' => '累计运行时间(分钟)', + 'description' => '实例总计运行时间(分钟)', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'InstanceShutdownTimer' => [ + 'description' => '实例定时关机任务', + '$ref' => '#/components/schemas/InstanceShutdownTimer', + ], + 'ShutdownEnabled' => [ + 'title' => '是否允许使用定时关机', + 'description' => '是否可以添加定时关机任务', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'InstanceType' => [ + 'title' => '实例规格类型', + 'description' => 'InstanceType', + 'type' => 'object', + 'properties' => [ + 'InstanceTypeId' => [ + 'title' => '实例类型Id', + 'description' => '实例规格', + 'type' => 'string', + 'example' => 'ecs.g6.2large', + ], + 'SystemDiskCategory' => [ + 'title' => '磁盘存储类型', + 'description' => '系统盘类别', + 'type' => 'string', + 'example' => 'ssd', + ], + 'SystemDiskSize' => [ + 'title' => '磁盘容量', + 'description' => '系统盘大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'PriceCNY' => [ + 'title' => '价格(人民币)', + 'description' => '价格(人民币)', + 'type' => 'number', + 'format' => 'float', + 'example' => '6.5', + ], + 'PriceUSD' => [ + 'title' => '价格(美元)', + 'description' => '价格(美元)', + 'type' => 'number', + 'format' => 'float', + 'example' => '1.6', + ], + 'DomesticPrice' => [ + 'title' => '内部价', + 'description' => '内部价', + 'type' => 'number', + 'format' => 'float', + 'example' => '6.5', + ], + 'Discount' => [ + 'title' => '折扣', + 'description' => '折扣', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型(1: CPU, 2: GPU)', + 'type' => 'string', + 'example' => 'GPU', + ], + 'International' => [ + 'title' => '是否国际站', + 'description' => '是否国际站用户', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CpuCoreCount' => [ + 'title' => 'CPU核数', + 'description' => 'CPU核心数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16', + ], + 'MemorySize' => [ + 'title' => '内存容量', + 'description' => '内存大小', + 'type' => 'number', + 'format' => 'float', + 'example' => '128', + ], + 'InstanceTypeFamily' => [ + 'title' => '实例规格族', + 'description' => '实例规格族', + 'type' => 'string', + 'example' => 'ecs.g6', + ], + 'LocalStorageCapacity' => [ + 'title' => '本地磁盘容量', + 'description' => '本地磁盘大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'GPUAmount' => [ + 'title' => 'GPU卡数', + 'description' => 'GPU卡数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'GPUSpec' => [ + 'title' => 'GPU规格', + 'description' => 'GPU卡规格', + 'type' => 'string', + 'example' => 'V100', + ], + 'Price' => [ + 'title' => '价格', + 'description' => '价格', + 'type' => 'number', + 'format' => 'float', + 'example' => '6.5', + ], + 'InstanceBandwidthRx' => [ + 'title' => '实例接收带宽', + 'description' => '实例接收带宽', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'InstanceBandwidthTx' => [ + 'title' => '实例发送带宽', + 'description' => '实例发送带宽', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'InstancePpsRx' => [ + 'title' => '实例每秒发包数量', + 'description' => '实例收包速率', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000', + ], + 'InstancePpsTx' => [ + 'title' => '实例每秒收包数量', + 'description' => '实例发包速率', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50000', + ], + ], + ], + 'Nas' => [ + 'title' => 'A short description of struct', + 'description' => 'Nas', + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'title' => 'Nas文件系统Id', + 'description' => '文件系统ID', + 'type' => 'string', + 'example' => '01bd34b09b', + ], + 'Status' => [ + 'title' => 'Nas盘状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'Running', + ], + 'Description' => [ + 'title' => 'Nas盘描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'for test', + ], + ], + ], + 'Region' => [ + 'title' => 'A short description of struct', + 'description' => 'Region', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'title' => 'id', + 'description' => 'ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RegionName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'example' => '华东2 (杭州)', + ], + 'RegionCity' => [ + 'title' => '城市', + 'description' => '城市', + 'type' => 'string', + 'example' => '杭州', + ], + 'RegionState' => [ + 'title' => '州省', + 'description' => '州', + 'type' => 'string', + 'example' => '华东2', + ], + 'ServiceUrl' => [ + 'title' => '服务地址', + 'description' => '服务URL', + 'type' => 'string', + 'example' => 'https://dsw-cn-hangzhou.data.aliyun.com', + ], + ], + ], + 'ResourceInfo' => [ + 'title' => 'A short description of struct', + 'description' => 'ResourceInfo', + 'type' => 'object', + 'properties' => [ + 'PayType' => [ + 'title' => '支付类型', + 'description' => '付费类型(0:后付费,1:预付费)', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型(1:CPU,2:GPU)', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Name' => [ + 'title' => '显卡类型', + 'description' => '资源名称', + 'type' => 'string', + 'example' => 'pai.medium.2xM40', + ], + ], + ], + 'SecurityGroup' => [ + 'title' => 'A short description of struct', + 'description' => 'SecurityGroup', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupId' => [ + 'title' => '安全组id', + 'description' => '安全组ID', + 'type' => 'string', + 'example' => 'sg-xxxxxxxx', + ], + 'VpcId' => [ + 'title' => 'vpc id', + 'description' => '虚拟网络ID', + 'type' => 'string', + 'example' => 'vpc-xxxxxxxx', + ], + 'SecurityGroupName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'example' => 'test-security-group', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'test security group', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-08-26T06:56:38Z', + ], + ], + ], + 'Status' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'dsw-d7adefa77718****', + ], + 'InstanceStatus' => [ + 'title' => '实例状态', + 'description' => '实例状态', + 'type' => 'string', + 'example' => 'Running', + ], + 'Msg' => [ + 'title' => '实例消息', + 'description' => '实例启动停止中错误消息', + 'type' => 'string', + 'example' => 'create timeout', + ], + 'Type' => [ + 'title' => '实例类型', + 'description' => '实例类型', + 'type' => 'string', + 'example' => 'V3', + ], + 'AccumulativeRunningTimeInMinutes' => [ + 'title' => '累计运行时间(分钟)', + 'description' => '总计运行时间(分钟)', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'InstanceShutdownTimer' => [ + 'description' => '实例定时关机配置', + '$ref' => '#/components/schemas/InstanceShutdownTimer', + ], + ], + ], + 'UserVpc' => [ + 'title' => 'A short description of struct', + 'description' => 'UserVpc', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => '虚拟网络ID', + 'description' => '虚拟网络ID', + 'type' => 'string', + 'example' => 'vpc-bp1i4x5wj2kgro93l****', + ], + 'VswitchId' => [ + 'title' => '虚拟交换机ID', + 'description' => '虚拟交换机ID', + 'type' => 'string', + 'example' => 'vsw-bp1irltu139f5qufw****', + ], + 'RoleArn' => [ + 'title' => '角色标识码', + 'description' => '角色字符串', + 'type' => 'string', + 'example' => 'acs:ram::123456789012****:role/appserverrole', + ], + 'SecurityGroupId' => [ + 'title' => '安全组ID', + 'description' => '安全组ID', + 'type' => 'string', + 'example' => 'sg-bp10mttdnsk58y5n****', + ], + ], + ], + 'VSwitch' => [ + 'title' => 'A short description of struct', + 'description' => 'VSwitch', + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'title' => 'VSwitch Id', + 'description' => '虚拟路由ID', + 'type' => 'string', + 'example' => 'vsw-xxxxxxxx', + ], + 'VpcId' => [ + 'title' => 'vpc id', + 'description' => '虚拟网络ID', + 'type' => 'string', + 'example' => 'vpc-xxxxxxxx', + ], + 'Status' => [ + 'title' => '状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'Available', + ], + 'CidrBlock' => [ + 'title' => '子网', + 'description' => '网段规划', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'ZoneId' => [ + 'title' => '可用区', + 'description' => '可用区ID', + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'AvailableIpAddressCount' => [ + 'title' => '可用ip数量', + 'description' => '可用地址数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '251', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'vswitch for test', + ], + 'VSwitchName' => [ + 'title' => '名称', + 'description' => '名称', + 'type' => 'string', + 'example' => 'test-vswitch', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-06-15T01:08:27Z', + ], + 'IsDefault' => [ + 'title' => '是否默认', + 'description' => '是否默认', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'Vpc' => [ + 'title' => 'A short description of struct', + 'description' => 'Vpc', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => 'vpc id', + 'description' => '虚拟网络ID', + 'type' => 'string', + 'example' => 'vpc-xxxxxxxx', + ], + 'Status' => [ + 'title' => 'vpc状态', + 'description' => '状态', + 'type' => 'string', + 'example' => 'Available', + ], + 'VpcName' => [ + 'title' => 'vpc名称', + 'description' => '名称', + 'type' => 'string', + 'example' => 'test-vpc', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2021-08-26T06:56:38Z', + ], + 'CidrBlock' => [ + 'title' => 'vpc子网', + 'description' => '网络规划', + 'type' => 'string', + 'example' => '2021-08-26T06:56:38Z', + ], + 'VRouterId' => [ + 'title' => '路由id', + 'description' => '虚拟路由ID', + 'type' => 'string', + 'example' => 'vrt-xxxxxxxx', + ], + 'Description' => [ + 'title' => 'vpc描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'vpc for test', + ], + 'IsDefault' => [ + 'title' => '是否默认', + 'description' => '是否默认', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'apis' => [ + 'GetInstance' => [ + 'summary' => '获取指定实例信息', + 'path' => '/api/v1/instances/{InstanceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => '实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-cac06e348ceb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'title' => '实例名称', + 'description' => '实例名称', + 'type' => 'string', + 'example' => 'predicting_price', + ], + 'InstanceId' => [ + 'title' => '实例ID', + 'description' => '实例ID', + 'type' => 'string', + 'example' => 'dsw-d7adefa77718bc8e', + 'readOnly' => true, + ], + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + 'EcsSpec' => [ + 'title' => 'ecs规格', + 'description' => 'ecs规格', + 'type' => 'string', + 'example' => 'ecs.c6.large', + ], + 'InstanceStatus' => [ + 'title' => '实例状态', + 'description' => '实例状态', + 'type' => 'string', + 'example' => 'Running', + ], + 'JupyterlabUrl' => [ + 'title' => 'jupyter链接', + 'description' => 'jupyterlab(实验室)地址', + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/lab/', + ], + 'WebIdeUrl' => [ + 'title' => 'web ide链接', + 'description' => 'web开发环境地址', + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/ide/', + ], + 'TerminalUrl' => [ + 'title' => '命令行终端链接', + 'description' => '命令行地址', + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/terminals/tty', + ], + 'AccumulativeRunningTimeInMinutes' => [ + 'title' => '累计运行时间(分钟)', + 'description' => '实例累计运行时间(分钟)', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'ImageId' => [ + 'title' => '镜像ID', + 'description' => '实例镜像ID', + 'type' => 'string', + 'example' => 'img-d7adefa77718bc8e', + ], + 'ImageUrl' => [ + 'title' => '镜像链接', + 'description' => '实例镜像地址', + 'type' => 'string', + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/image:pai-images-dsw-ubuntu18.04-py3.6-paitf1.15-build.avx512', + ], + 'GmtCreateTime' => [ + 'title' => '实例创建时间(GMT)', + 'description' => '实例创建时间', + 'type' => 'string', + 'example' => '2021-04-01T00:00:00Z', + ], + 'GmtModifiedTime' => [ + 'title' => '实例修改时间(GMT)', + 'description' => '实例最后修改时间', + 'type' => 'string', + 'example' => '2021-04-02T00:00:00Z', + ], + 'UserId' => [ + 'title' => '用户ID', + 'description' => '用户ID', + 'type' => 'string', + 'example' => '161228528250****', + ], + 'NasFileSystemId' => [ + 'title' => 'nas文件系统ID', + 'description' => 'nas文件系统ID', + 'type' => 'string', + 'example' => '0051a4bcca', + ], + 'UserVpc' => [ + 'title' => '被打通VPC配置', + 'description' => '被打通VPC配置', + '$ref' => '#/components/schemas/UserVpc', + ], + 'InstanceShutdownTimer' => [ + 'title' => '定时关机任务', + 'description' => '实例定时关机配置', + '$ref' => '#/components/schemas/InstanceShutdownTimer', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"InstanceName\\": \\"predicting_price\\",\\n \\"InstanceId\\": \\"dsw-d7adefa77718bc8e\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"EcsSpec\\": \\"ecs.c6.large\\",\\n \\"InstanceStatus\\": \\"Running\\",\\n \\"JupyterlabUrl\\": \\"https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/lab/\\",\\n \\"WebIdeUrl\\": \\"https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/ide/\\",\\n \\"TerminalUrl\\": \\"https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/terminals/tty\\",\\n \\"AccumulativeRunningTimeInMinutes\\": 10,\\n \\"ImageId\\": \\"img-d7adefa77718bc8e\\",\\n \\"ImageUrl\\": \\"registry.cn-shanghai.aliyuncs.com/pai_product/image:pai-images-dsw-ubuntu18.04-py3.6-paitf1.15-build.avx512\\",\\n \\"GmtCreateTime\\": \\"2021-04-01T00:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2021-04-02T00:00:00Z\\",\\n \\"UserId\\": \\"161228528250****\\",\\n \\"NasFileSystemId\\": \\"0051a4bcca\\",\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-bp1i4x5wj2kgro93l****\\",\\n \\"VswitchId\\": \\"vsw-bp1irltu139f5qufw****\\",\\n \\"RoleArn\\": \\"acs:ram::123456789012****:role/appserverrole\\",\\n \\"SecurityGroupId\\": \\"sg-bp10mttdnsk58y5n****\\"\\n },\\n \\"InstanceShutdownTimer\\": {\\n \\"InstanceId\\": \\"dsw-d7adefa77718****\\",\\n \\"ScheduleTime\\": \\"2021-04-01T01:00:00Z\\",\\n \\"GmtModifiedTime\\": \\"2021-04-01T00:00:00Z\\",\\n \\"GmtCreateTime\\": \\"2021-04-01T00:00:00Z\\",\\n \\"TtlInMillis\\": 1000000\\n }\\n}","errorExample":""},{"type":"xml","example":"<InstanceName>predicting_price</InstanceName>\\n<InstanceId>dsw-d7adefa77718bc8e</InstanceId>\\n<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n<EcsSpec>ecs.c6.large</EcsSpec>\\n<InstanceStatus>Running</InstanceStatus>\\n<JupyterlabUrl>https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/lab/</JupyterlabUrl>\\n<WebIdeUrl>https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/ide/</WebIdeUrl>\\n<TerminalUrl>https://dsw-gateway-cn-beijing.aliyun.com/dsw-****/terminals/tty</TerminalUrl>\\n<AccumulativeRunningTimeInMinutes>10</AccumulativeRunningTimeInMinutes>\\n<ImageId>img-d7adefa77718bc8e</ImageId>\\n<ImageUrl>registry.cn-shanghai.aliyuncs.com/pai_product/image:pai-images-dsw-ubuntu18.04-py3.6-paitf1.15-build.avx512</ImageUrl>\\n<GmtCreateTime>2021-04-01T00:00:00Z</GmtCreateTime>\\n<GmtModifiedTime>2021-04-02T00:00:00Z</GmtModifiedTime>\\n<UserId>161228528250****</UserId>\\n<NasFileSystemId>0051a4bcca</NasFileSystemId>\\n<UserVpc>\\n <VpcId>vpc-bp1i4x5wj2kgro93lj7z6</VpcId>\\n <VswitchId>vsw-bp1irltu139f5qufwxrl4</VswitchId>\\n <RoleArn>acs:ram::1234567890123456:role/appserverrole</RoleArn>\\n <SecurityGroupId>sg-bp10mttdnsk58y5nlxhh</SecurityGroupId>\\n</UserVpc>\\n<InstanceShutdownTimer>\\n <InstanceId>dsw-d7adefa77718bc8e</InstanceId>\\n <ScheduleTime>2021-04-01T01:00:00Z</ScheduleTime>\\n <GmtModifiedTime>2021-04-01T00:00:00Z</GmtModifiedTime>\\n <GmtCreateTime>2021-04-01T00:00:00Z</GmtCreateTime>\\n</InstanceShutdownTimer>","errorExample":""}]', + 'title' => '获取指定实例信息', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'pai-dsw.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'pai-dsw.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'pai-dsw.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'pai-dsw.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'pai-dsw.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'pai-dsw.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'pai-dsw.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'pai-dsw.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'pai-dsw.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'pai-dsw.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'pai-dsw.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'pai-dsw.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'pai-dsw.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'pai-dsw.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'pai-dsw.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'pai-dsw.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'pai-dsw.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'pai-dsw.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'pai-dsw.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'pai-dsw.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'pai-dsw.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'pai-dsw.cn-wulanchabu.aliyuncs.com', + ], + ], +]; |
