diff options
Diffstat (limited to 'data/en_us/pai-dsw/2022-01-01')
| -rw-r--r-- | data/en_us/pai-dsw/2022-01-01/api-docs.php | 8353 |
1 files changed, 8353 insertions, 0 deletions
diff --git a/data/en_us/pai-dsw/2022-01-01/api-docs.php b/data/en_us/pai-dsw/2022-01-01/api-docs.php new file mode 100644 index 0000000..e33e102 --- /dev/null +++ b/data/en_us/pai-dsw/2022-01-01/api-docs.php @@ -0,0 +1,8353 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'pai-dsw', + 'version' => '2022-01-01', + ], + 'directories' => [ + [ + 'id' => 313771, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateInstance', + 'DeleteInstance', + 'UpdateInstance', + 'StartInstance', + 'StopInstance', + 'GetInstance', + 'ListInstances', + 'GetInstanceEvents', + 'UpdateInstanceLabels', + 'DeleteInstanceLabels', + 'DeleteInstances', + 'StopInstances', + ], + ], + [ + 'id' => 313784, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetLifecycle', + ], + ], + [ + 'id' => 313786, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetInstanceMetrics', + ], + ], + [ + 'id' => 313788, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateInstanceSnapshot', + 'DeleteInstanceSnapshot', + 'GetInstanceSnapshot', + 'ListInstanceSnapshot', + ], + ], + [ + 'id' => 313793, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetResourceGroupStatistics', + 'ListInstanceStatistics', + ], + ], + [ + 'id' => 313796, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateInstanceShutdownTimer', + 'DeleteInstanceShutdownTimer', + 'GetInstanceShutdownTimer', + ], + ], + [ + 'id' => 313800, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateIdleInstanceCuller', + 'DeleteIdleInstanceCuller', + 'GetIdleInstanceCuller', + ], + ], + [ + 'id' => 313804, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListEcsSpecs', + ], + ], + [ + 'id' => 313806, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetUserConfig', + ], + ], + [ + 'id' => 313808, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDiagnosis', + 'GetToken', + 'GetMetrics', + 'GetUserCommand', + 'ListSystemLogs', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'GetSanityCheckTask', + 'CreateSanityCheckTask', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'CredentialConfig' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'Enable', + ], + 'AliyunEnvRoleKey' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'backendName' => 'AliyunEnvRoleKey', + ], + 'Configs' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => '0', + 'backendName' => 'Key', + ], + 'Type' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'Role', + 'backendName' => 'Type', + ], + 'Roles' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'RoleArn' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:ram::123******:role/****', + 'backendName' => 'RoleArn', + ], + 'RoleType' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'service', + 'backendName' => 'RoleType', + ], + 'AssumeRoleFor' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '123******', + 'backendName' => 'AssumeRoleFor', + ], + 'Policy' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{}', + 'backendName' => 'Policy', + ], + 'UserInfo' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '456******', + 'backendName' => 'Id', + ], + 'Type' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'S', + 'backendName' => 'Type', + ], + 'AccessKeyId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'LT********', + 'backendName' => 'AccessKeyId', + ], + 'SecurityToken' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '********', + 'backendName' => 'SecurityToken', + ], + ], + 'backendName' => 'UserInfo', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Roles', + 'itemName' => 'Roles', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'Configs', + 'itemName' => 'Configs', + ], + ], + ], + 'DemoCategory' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'SubCategories' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/DemoCategory', + ], + 'backendName' => 'SubCategories', + ], + 'CategoryName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'SDK Usage', + 'backendName' => 'CategoryName', + ], + 'CategoryCode' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => 'sdk', + 'backendName' => 'CategoryCode', + ], + 'Order' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + 'backendName' => 'Order', + ], + ], + ], + 'DynamicMount' => [ + 'title' => 'Dynamic Mount Config', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => 'Is dynamic mount enabled.', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'Enable', + ], + 'MountPoints' => [ + 'title' => 'Mount points of dynaimc config.', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/DynamicMountPoint', + ], + 'backendName' => 'MountPoints', + ], + ], + ], + 'DynamicMountPoint' => [ + 'title' => 'Dynamic Mount Point', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'RootPath' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => '/mnt/dynamic/', + 'backendName' => 'RootPath', + ], + 'Options' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{}', + 'backendName' => 'Options', + ], + ], + ], + 'ForwardInfo' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'Enable', + ], + 'ContainerName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'dsw-notebook', + 'backendName' => 'ContainerName', + ], + 'ForwardPort' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '22', + 'backendName' => 'ForwardPort', + ], + 'NatGatewayId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ngw-bp1uewa15k4iy5770****', + 'backendName' => 'NatGatewayId', + ], + 'EipAllocationId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'eip-25877c70gddh****', + 'backendName' => 'EipAllocationId', + ], + 'SSHPublicKey' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ssh-rsa AAAAB3****************************', + 'backendName' => 'SSHPublicKey', + ], + 'Name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ssh', + 'backendName' => 'Name', + ], + 'ExternalPort' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '10086', + 'backendName' => 'ExternalPort', + ], + 'AccessType' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'intranet', + 'extendType' => 'true', + ], + 'backendName' => 'AccessType', + ], + ], + ], + 'ForwardInfoResponse' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'Enable', + ], + 'ContainerName' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'dsw-notebook', + 'backendName' => 'ContainerName', + ], + 'ForwardPort' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '22', + 'backendName' => 'ForwardPort', + ], + 'NatGatewayId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ngw-bp1uewa15k4iy5770****', + 'backendName' => 'NatGatewayId', + ], + 'EipAllocationId' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'eip-25877c70gddh****', + 'backendName' => 'EipAllocationId', + ], + 'SSHPublicKey' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ssh-rsa AAAAB3****************************'."\n", + 'backendName' => 'SSHPublicKey', + ], + 'ConnectInfo' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Phase' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Ready', + 'backendName' => 'Phase', + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'DNAT and privateZone are both ready.', + 'backendName' => 'Message', + ], + 'Intranet' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Endpoint' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'dsw-notebook-22-urz3u6cnu0uts7ej9r.dsw-5cc6083084818f60.dsw.pai.alibaba.com', + 'backendName' => 'Endpoint', + ], + 'Port' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '22', + 'backendName' => 'Port', + ], + ], + 'backendName' => 'Intranet', + ], + 'Internet' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Endpoint' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '47.111.119.114', + 'backendName' => 'Endpoint', + ], + 'Port' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '22', + 'backendName' => 'Port', + ], + ], + 'backendName' => 'Internet', + ], + ], + 'backendName' => 'ConnectInfo', + ], + 'Name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'ssh', + 'backendName' => 'Name', + ], + 'ExternalPort' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '1024', + 'backendName' => 'ExternalPort', + ], + 'AccessType' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'intranet', + 'extendType' => 'true', + ], + 'backendName' => 'AccessType', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateInstance' => [ + 'summary' => 'Creates a Data Science Workshop (DSW) instance.', + 'path' => '/api/v2/instances', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '118631', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '实例属性', + 'description' => 'The instance properties.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'title' => '工作空间Id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '40823', + ], + 'InstanceName' => [ + 'title' => '实例名称', + 'description' => 'The instance name. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain only letters, digits, and underscores (\\_).'."\n" + .'* The name can be up to 27 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'training_data', + ], + 'EcsSpec' => [ + 'title' => '实例对应的Ecs规格', + 'description' => 'The ECS instance type of the instance. You can call [ListEcsSpecs](~~470423~~) to obtain the ECS instance type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c6.large', + ], + 'ImageId' => [ + 'title' => '镜像Id', + 'description' => 'The image ID. You can call [ListImages](~~449118~~) to obtain the image ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'image-05cefd0be2exxxx', + ], + 'ImageUrl' => [ + 'title' => '镜像地址', + 'description' => 'The image address. You can call [ListImages](~~449118~~) to obtain the image address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu', + ], + 'Datasets' => [ + 'title' => '数据集集合', + 'description' => 'The datasets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dataset.'."\n", + 'type' => 'object', + 'properties' => [ + 'DatasetId' => [ + 'title' => '数据集Id', + 'description' => 'The dataset ID. If the dataset is read-only, you cannot change the dataset permission from read-only to read and write by using MountAccess.'."\n" + ."\n" + .'You can call [ListDatasets](~~457222~~) to obtain the dataset ID. If you configure the dataset ID, you cannot configure the dataset URI.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'd-vsqjvsjp4orp5l206u', + ], + 'DatasetVersion' => [ + 'title' => '数据集版本，不填默认为v1', + 'description' => 'The dataset version. You must also configure DatasetId. If you leave this parameter empty, the value v1 is used by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + 'Uri' => [ + 'title' => '数据Uri，支持oss、nas、cpfs。', + 'description' => 'The URI of the storage service directory, which can be directly mounted. This parameter is mutually exclusive with DatasetId.'."\n" + ."\n" + .'URI formats of different types of storage:'."\n" + ."\n" + .'* OSS: oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/'."\n" + .'* NAS: nas://29\\*\\*d-b12\\*\\*\\*\\*446.cn-hangzhou.nas.aliyuncs.com/data/path/'."\n" + .'* Extreme NAS: nas://29\\*\\*\\*\\*123-y\\*\\*r.cn-hangzhou.extreme.nas.aliyuncs.com/data/path/'."\n" + .'* CPFS: cpfs://cpfs-213\\*\\*\\*\\*87.cn-wulanchabu/ptc-292\\*\\*\\*\\*\\*cbb/exp-290\\*\\*\\*\\*\\*\\*\\*\\*03e/data/path/'."\n" + .'* Lingjun CPFS: bmcpfs://cpfs-290\\*\\*\\*\\*\\*\\*foflh-vpc-x\\*\\*\\*\\*8r.cn-wulanchabu.cpfs.aliyuncs.com/data/path/'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/', + ], + 'MountPath' => [ + 'title' => '容器内挂载路径', + 'description' => 'The mount path of the dataset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/mnt/data', + ], + 'MountAccess' => [ + 'title' => '读写权限，RW：读写，RO：只读。', + 'description' => 'The read and write permissions of the dataset. If the dataset is read-only, it cannot be changed to read and write.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'RW' => '', + 'RO' => '', + ], + 'example' => 'RW', + 'enum' => [ + 'RW', + 'RO', + ], + ], + 'Options' => [ + 'title' => '数据挂载Options', + 'description' => 'The custom dataset mount options. Only OSS is supported. You cannot specify OptionType at the same time. For more information, see [DSW mount configurations](https://www.alibabacloud.com/help/en/pai/user-guide/read-and-write-dataset-data).', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\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" + .'}'."\n", + ], + 'OptionType' => [ + 'description' => 'The mount type. You cannot specify Options at the same time. This is deprecated, and you can use Options instead.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'ReadOnly', + ], + 'Dynamic' => [ + 'description' => 'Specifies whether to enable dynamic mounting. Default value: false.'."\n" + ."\n" + .'* Currently, only instances using general-purpose computing resources are supported.'."\n" + .'* Currently, only OSS datasets are supported. The mounted datasets are read-only.'."\n" + .'* The mount path of the dynamically mounted dataset must be a subpath of the root path. Example: /mnt/dynamic/data1/'."\n" + .'* A dynamically mounted dataset must be after non-dynamic datasets.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'UserVpc' => [ + 'title' => 'user vpc配置', + 'description' => 'The virtual private cloud (VPC) configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => 'Vpc Id', + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-xxxxx', + ], + 'VSwitchId' => [ + 'title' => 'VSwitch Id', + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-xxxxx', + ], + 'SecurityGroupId' => [ + 'title' => 'Security Group Id', + 'description' => 'The security group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-xxxxxx', + ], + 'ExtendedCIDRs' => [ + 'description' => 'The extended CIDR blocks.'."\n" + ."\n" + .'* If you leave the SwitchId and ExtendedCIDRs parameters empty, the system automatically obtains all CIDR blocks in a VPC.'."\n" + .'* If you configure the SwitchId and ExtendedCIDRs parameters, we recommend that you specify all CIDR blocks in a VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The extended CIDR block.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"172.16.19.0/24","172.16.2.0/24","172.16.12.0/24"', + ], + 'required' => false, + 'example' => '["192.168.0.1/24", "192.168.1.1/24"]', + ], + 'DefaultRoute' => [ + 'title' => 'Default Route', + 'description' => 'The default route. Valid values:'."\n" + ."\n" + .'* eth0: The default network interface is used to access the Internet through the public gateway.'."\n" + .'* eth1: The user\'s elastic network interface (ENI) is used to access the Internet through the private gateway. For more information about the configuration method, see [Enable Internet access for a DSW instance by using a private Internet NAT gateway](~~2525343~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eth0', + ], + 'ForwardInfos' => [ + 'title' => 'Forward Infos', + 'description' => 'The forward information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The forward information. You can configure parameters such as the mapped port, gateway ID, and SSH public key.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ForwardInfo', + ], + 'required' => false, + ], + 'BandwidthLimit' => [ + 'required' => false, + '$ref' => '#/components/schemas/BandwidthLimit', + ], + ], + 'required' => false, + ], + 'Accessibility' => [ + 'title' => '工作空间内是否他人可见', + 'description' => 'The instance accessibility.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PUBLIC: The instances are accessible to all members in the workspace.'."\n" + .'* PRIVATE: The instances are accessible only to you and the administrator of the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PUBLIC' => '', + 'PRIVATE' => '', + ], + 'example' => 'PRIVATE', + ], + 'EnvironmentVariables' => [ + 'title' => '环境变量', + 'description' => 'The environment variables.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The specific environment variable. After a DSW instance is started, the specific environment variable is injected into the container.'."\n", + 'example' => 'MAAS', + ], + 'example' => '{userName: "Chris"}', + ], + 'ResourceId' => [ + 'title' => '资源Id,预付费时填写', + 'description' => 'The ID of the resource group. This parameter is configured during prepayment. For information about how to create a dedicated resource group, see [Create a dedicated resource group and purchase general computing resources](~~202827~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dsw-123456789', + ], + 'Priority' => [ + 'title' => '优先级，在分配资源给实例时，优先级越高的实例越优先', + 'description' => 'The priority based on which resources are allocated to instances. Valid values: 1 to 9.'."\n" + ."\n" + .'* 1: the lowest priority.'."\n" + .'* 9: the highest priority.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'RequestedResource' => [ + 'title' => '资源配置，弹内或者轻量化时使用', + 'description' => 'The resource configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'CPU' => [ + 'title' => 'cpu核数', + 'description' => 'The number of CPU cores.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + 'Memory' => [ + 'title' => 'memory大小', + 'description' => 'The memory size. Unit: GB.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + 'SharedMemory' => [ + 'title' => 'shared memory大小', + 'description' => 'The size of the shared memory. Unit: GB.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + 'GPU' => [ + 'title' => 'gpu数量', + 'description' => 'The number of GPUs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + 'GPUType' => [ + 'title' => 'gpu显卡类型', + 'description' => 'The GPU memory type. Valid values:'."\n" + ."\n" + .'* V100'."\n" + .'* A100'."\n" + .'* T4'."\n" + .'* A10'."\n" + .'* P100'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v100', + ], + ], + 'required' => false, + 'example' => '{"CPU":"4","Memory":"8Gi","SharedMemory":"4Gi","GPU":"1","GPUType":"Tesla-V100-16G"}', + ], + 'Labels' => [ + 'title' => '用户自定义标签', + 'description' => 'The custom labels.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The custom label.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '用户定义标签键', + 'description' => 'The custom label key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'stsTokenOwner', + ], + 'Value' => [ + 'title' => '用户定义标签值', + 'description' => 'The custom label value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123xxxxxxxx', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '{\'foo\': \'bar\'}', + ], + 'CloudDisks' => [ + 'title' => '云盘列表', + 'description' => 'The cloud disks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cloud disk.'."\n", + 'type' => 'object', + 'properties' => [ + 'Capacity' => [ + 'title' => '云盘容量', + 'description' => 'If **Resource Type** is **Public Resource** or if **Resource Quota** is subscription-based general-purpose computing resources (CPU cores ≥ 2 and memory ≥ 4 GB, or configured with GPU):'."\n" + ."\n" + .'Each instance has a free system disk of 100 GiB for persistent storage. **If the DSW instance is stopped and not launched for more than 15 days, the disk is cleared**. The disk can be expanded. For specific pricing, refer to the console.'."\n" + ."\n" + .'**'."\n" + ."\n" + .'**Warning**'."\n" + ."\n" + .'* After the expansion, you cannot reduce the storage space. Proceed with caution.'."\n" + ."\n" + .'* After the expansion, the disk is not cleared if the instance is stopped for more than 15 days. However, it will continue to incur fees.'."\n" + ."\n" + .'* If you delete the instance, the system disk is also released and the data stored in the disk is deleted. Make sure that you have backed up your data before you delete the instance.'."\n" + ."\n" + .'If you need persistent storage, you can **mount a dataset** or add the OSS, NAS, or CPFS path to the **storage path**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '100Gi', + ], + 'SubType' => [ + 'title' => '云盘使用方式, rootfs 挂载为rootfs', + 'description' => 'The cloud disk type.'."\n" + ."\n" + .'* rootfs: Mounts the disk as a system disk. The system environment is stored on the disk.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rootfs', + ], + 'MountPath' => [ + 'title' => '容器内挂载云盘路径', + 'description' => 'The mount path of the cloud disk.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/mnt/systemDisk', + ], + 'Path' => [ + 'title' => '云盘内被挂载目录路径', + 'description' => 'The subpath of the cloud disk that is mounted to the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workspace', + ], + 'Status' => [ + 'title' => '云盘状态', + 'description' => 'The disk or snapshot usage.'."\n", + 'type' => 'object', + 'properties' => [ + 'Available' => [ + 'description' => 'The available capacity. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '31841058816', + ], + 'Usage' => [ + 'description' => 'The used capacity. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '371195904', + ], + 'Capacity' => [ + 'description' => 'The capacity. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '32212254720', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '[]', + ], + 'WorkspaceSource' => [ + 'title' => '工作空间指向的存储，如果不指定，则依次使用NAS，CloudDisk或者本地磁盘', + 'description' => 'The storage corresponding to the working directory. You can mount disks or datasets to /mnt/workspace at the same time. OSS datasets and dynamically mounted datasets are not supported.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* rootfsCloudDisk: Mount the disk to the working directory.'."\n" + .'* Mount path of the dataset, such as /mnt/data: Datasets in URI format only support this method.'."\n" + .'* Dataset ID, such as d-vsqjvs\\*\\*\\*\\*rp5l206u: If a single dataset is mounted to multiple paths, the first path is selected. We recommend that you do not use this method, use the mount path instead.'."\n" + ."\n" + .'If you leave this parameter empty:'."\n" + ."\n" + .'* If the instance uses cloud disks, cloud disks are selected by default.'."\n" + .'* if no cloud disks are available, the first NAS or CPFS dataset is selected as the working directory.'."\n" + .'* If no cloud disks, and NAS or CPFS datasets are available, the host space is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rootfsCloudDisk', + ], + 'UserId' => [ + 'title' => '实例的使用者，可能是子账号或者主账号', + 'description' => 'The ID of the instance owner. Valid values: Alibaba Cloud account and RAM user.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '161228528250****', + ], + 'Driver' => [ + 'title' => 'Driver for accelerator', + 'description' => 'The NVIDIA driver configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '535.54.03', + ], + 'CredentialConfig' => [ + 'description' => 'The credential configuration.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + 'Affinity' => [ + 'description' => 'The affinity configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'CPU' => [ + 'description' => 'The CPU affinity configuration. Only subscription instances that use general-purpose computing resources support CPU affinity configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'description' => 'Specifies whether to enable the CPU affinity feature.'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'ImageAuth' => [ + 'title' => "\0".'用户私有镜像的账号密码信息，如果镜像地址是公共镜像或者归属当前账号的 ACR 镜像，则不需要填写。生成方法： ${username}:${password} base64编码后的值。', + 'description' => 'The Base64-encoded account and password for the user\'s private image. The password will be hidden.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + 'DynamicMount' => [ + 'description' => 'The dynamic mount configuration.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/DynamicMount', + ], + 'Tag' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'UserCommand' => [ + 'type' => 'object', + 'properties' => [ + 'OnStart' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'OversoldType' => [ + 'title' => '闲时资源的类型：'."\n" + .'ForceQuotaOverSold：只使用闲时资源'."\n" + .'AcceptQuotaOverSold：可接受闲时资源'."\n" + .'ForbiddenQuotaOverSold：使用保障资源', + 'type' => 'string', + ], + 'AssignNodeSpec' => [ + 'title' => '指定节点调度配置', + 'type' => 'object', + 'properties' => [ + 'NodeNames' => [ + 'title' => '指定调度的节点:"node-a,node-b"', + 'type' => 'string', + 'example' => 'node-a', + ], + 'AntiAffinityNodeNames' => [ + 'title' => '排除调度的节点:"node-a,node-b"', + 'type' => 'string', + 'example' => 'node-b', + ], + ], + ], + 'SpotSpec' => [ + 'title' => '抢占实例配置', + 'type' => 'object', + 'properties' => [ + 'SpotStrategy' => [ + 'title' => '抢占策略：'."\n" + .'SpotWithPriceLimit：自定义设置抢占实例价格上限。'."\n" + .'SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。', + 'type' => 'string', + 'example' => 'SpotWithPriceLimit', + ], + 'SpotPriceLimit' => [ + 'title' => '抢占式实例的每小时价格上限，最多支持精确到小数点后三位，抢占策略是SpotWithPriceLimit的时候必填', + 'type' => 'string', + 'example' => '0.12', + ], + 'SpotDuration' => [ + 'title' => '抢占式实例的保护期。默认为1，可设置为0，表示无保护期。灵骏规格无效。', + 'type' => 'string', + 'example' => '0', + ], + 'SpotDiscountLimit' => [ + 'title' => '抢占式实例的每小时折扣上限，灵骏规格必填。', + 'type' => 'string', + 'example' => '0.1', + ], + ], + ], + 'MigrationOptions' => [ + 'title' => '实例迁移选项，只支持启用了持久化存储的灵骏实例设置此参数。当前支持：'."\n" + .'● EnableProcessesPreservation ：是否保留实例运行中的进程。可选值：true , false。启用此能力，需要实例预留进程迁移需要的存储空间。', + 'type' => 'object', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '执行结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The response message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* 400'."\n" + .'* 404'."\n" + .'* 200'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 200,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'CreateInstance', + ], + 'DeleteInstance' => [ + 'summary' => 'Deletes a specific instance.', + 'path' => '/api/v2/instances/{InstanceId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '118633', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例Id', + 'description' => 'The instance ID. You can call [ListInstances](~~470439~~) to obtain the instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '执行结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The response message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* 400'."\n" + .'* 404'."\n" + .'* 200'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"ValidationError\\",\\n \\"HttpStatusCode\\": 200,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'DeleteInstance', + ], + 'UpdateInstance' => [ + 'summary' => 'Updates the properties of a DSW instance.', + 'path' => '/api/v2/instances/{InstanceId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '118636', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例Id', + 'description' => 'The instance ID. You can call [ListInstances](~~470439~~) to obtain the instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '需要更新的实例属性', + 'description' => 'The instance properties to be updated.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'title' => '实例名称', + 'description' => 'The instance name. Format requirements:'."\n" + ."\n" + .'* The name can contain only letters, digits, and underscores (\\_).'."\n" + .'* The name can be up to 27 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'training_data', + ], + 'EcsSpec' => [ + 'title' => '实例对应的Ecs规格', + 'description' => 'The ECS instance type of the instance. You can call [ListEcsSpecs](~~470423~~) to obtain the ECS instance type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c6.large', + ], + 'ImageId' => [ + 'title' => '镜像Id', + 'description' => 'The image ID. You can call [ListImages](~~449118~~) to obtain the image ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'image-05cefd0be2exxxx', + ], + 'ImageUrl' => [ + 'title' => '镜像地址', + 'description' => 'The image address. You can call [ListImages](~~449118~~) to obtain the image address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu', + ], + 'UserVpc' => [ + 'title' => 'user vpc配置', + 'description' => 'The virtual private cloud (VPC) configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => 'Vpc Id', + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-xxxxx', + ], + 'VSwitchId' => [ + 'title' => 'VSwitch Id', + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-xxxxx', + ], + 'SecurityGroupId' => [ + 'title' => 'Security Group Id', + 'description' => 'The security group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-xxxxxx', + ], + 'ExtendedCIDRs' => [ + 'description' => 'The extended CIDR blocks.'."\n" + ."\n" + .'* If you leave VSwitchId empty, this parameter is not required and the system automatically obtains all CIDR blocks in the VPC.'."\n" + .'* If VSwitchId is not empty, this parameter is required. Specify all CIDR blocks in the VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The extended CIDR blocks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"172.16.19.0/24","172.16.2.0/24","172.16.12.0/24"', + ], + 'required' => false, + 'example' => '["192.168.0.1/24", "192.168.1.1/24"]', + ], + 'DefaultRoute' => [ + 'title' => 'Default Route', + 'description' => 'The default route. Valid values:'."\n" + ."\n" + .'* eth0: The default network interface is used to access the Internet through the public gateway.'."\n" + .'* eth1: The user\'s Elastic Network Interface is used to access the Internet through the private gateway.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eth0', + ], + 'ForwardInfos' => [ + 'title' => 'Forward Infos', + 'description' => 'The forward configuration of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The forward information.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/ForwardInfo', + ], + 'required' => false, + ], + 'BandwidthLimit' => [ + 'required' => false, + '$ref' => '#/components/schemas/BandwidthLimit', + ], + ], + 'required' => false, + ], + 'Accessibility' => [ + 'title' => '工作空间内是否他人可见', + 'description' => 'The visibility of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PUBLIC: Accessible to all members in the workspace.'."\n" + .'* PRIVATE: Accessible only to you and the administrator of the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PUBLIC' => '', + 'PRIVATE' => '', + ], + 'example' => 'PRIVATE', + ], + 'Datasets' => [ + 'title' => '数据集集合', + 'description' => 'The datasets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dataset.'."\n", + 'type' => 'object', + 'properties' => [ + 'DatasetId' => [ + 'title' => '数据集Id', + 'description' => 'The dataset ID. If the dataset is read-only, you cannot change the dataset pemission from read-only to read and write by using MountAccess.'."\n" + ."\n" + .'You can call [ListDatasets](~~457222~~) to obtain the dataset ID. If you configure the dataset ID, you cannot configure the dataset URI.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'd-vsqjvsjp4orp5l206u', + ], + 'DatasetVersion' => [ + 'title' => '数据集版本，默认为v1', + 'description' => 'The dataset version. You must also configure DatasetId. If you leave this parameter empty, the value v1 is used by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v1', + ], + 'Uri' => [ + 'title' => '数据Uri，支持oss、nas、cpfs。', + 'description' => 'The URI of the storage service directory, which can be directly mounted. This parameter is mutually exclusive with DatasetId.'."\n" + ."\n" + .'URI formats of different types of storage:'."\n" + ."\n" + .'* OSS: oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/'."\n" + .'* NAS: nas://29\\*\\*d-b12\\*\\*\\*\\*446.cn-hangzhou.nas.aliyuncs.com/data/path/'."\n" + .'* Extreme NAS: nas://29\\*\\*\\*\\*123-y\\*\\*r.cn-hangzhou.extreme.nas.aliyuncs.com/data/path/'."\n" + .'* CPFS: cpfs://cpfs-213\\*\\*\\*\\*87.cn-wulanchabu/ptc-292\\*\\*\\*\\*\\*cbb/exp-290\\*\\*\\*\\*\\*\\*\\*\\*03e/data/path/'."\n" + .'* Lingjun CPFS: bmcpfs://cpfs-290\\*\\*\\*\\*\\*\\*foflh-vpc-x\\*\\*\\*\\*8r.cn-wulanchabu.cpfs.aliyuncs.com/data/path/'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/', + ], + 'MountPath' => [ + 'title' => '容器内挂载路径', + 'description' => 'The mount path of the dataset.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/mnt/data', + ], + 'MountAccess' => [ + 'title' => '读写权限，RW：读写，RO：只读。', + 'description' => 'The read and write permissions of the dataset. If the dataset is read-only, it cannot be changed to read and write.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'RW' => '', + 'RO' => '', + ], + 'example' => 'RW', + 'enum' => [ + 'RW', + 'RO', + ], + ], + 'Options' => [ + 'title' => '数据挂载配置项', + 'description' => 'The custom dataset mount options. Only OSS is supported. You cannot specify OptionType at the same time. For more information, see [DSW mount configurations](https://www.alibabacloud.com/help/en/pai/user-guide/read-and-write-dataset-data).', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\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' => [ + 'description' => 'The mount type. You cannot specify Options at the same time. This is deprecated, you can use Options instead.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'ReadOnly', + ], + 'Dynamic' => [ + 'description' => 'Specifies whether dynamic mounting is enabled. Default value: false.'."\n" + ."\n" + .'* Currently, only instances using general-purpose computing resources are supported.'."\n" + .'* Currently, only OSS datasets are supported. The mounted datasets are read-only.'."\n" + .'* The MountPath of the dynamically mounted dataset must be a subpath of the root path. Example: /mnt/dynamic/data1/'."\n" + .'* A dynamically mounted dataset must be after non-dynamic datasets.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'DisassociateDatasets' => [ + 'title' => '是否删除关联数据集', + 'description' => 'Specifies whether to delete the associated datasets.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'DisassociateVpc' => [ + 'title' => '是否删除关联用户vpc', + 'description' => 'Specifies whether to delete the associated user VPC.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'DisassociateForwardInfos' => [ + 'title' => '是否删除关联端口透出信息', + 'description' => 'Specifies whether to delete the associated forward information.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'RequestedResource' => [ + 'title' => '资源配置，弹内或者轻量化时使用', + 'description' => 'The resource configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'CPU' => [ + 'title' => 'cpu核数', + 'description' => 'The number of vCPU cores.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + 'Memory' => [ + 'title' => 'memory大小', + 'description' => 'The memory size. Unit: GB.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + 'SharedMemory' => [ + 'title' => 'shared memory大小', + 'description' => 'The shared memory size. Unit: GB.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32', + ], + 'GPU' => [ + 'title' => 'gpu数量', + 'description' => 'The number of GPUs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + 'GPUType' => [ + 'title' => 'gpu显卡类型', + 'description' => 'The GPU type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'v100', + ], + ], + 'required' => false, + 'example' => '{"CPU":"4","Memory":"8Gi","SharedMemory":"4Gi","GPU":"1","GPUType":"Tesla-V100-16G"}', + ], + 'WorkspaceSource' => [ + 'title' => '工作空间指向的存储，如果不指定，则依次使用NAS，CloudDisk或者本地磁盘', + 'description' => 'Specifies the storage corresponding to the working directory. You can mount disks or datasets to /mnt/workspace at the same time. OSS datasets and dynamically mounted datasets are not supported.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* rootfsCloudDisk: Mount disk to the working directory.'."\n" + .'* Mount path of the dataset, such as /mnt/data: Datasets in URI format only support this method.'."\n" + .'* Dataset ID, such as d-vsqjvs\\*\\*\\*\\*rp5l206u: If a single dataset is mounted to multiple paths, the first path is selected. We recommend that you do not use this method, use the mount path instead.'."\n" + ."\n" + .'If you leave this parameter empty:'."\n" + ."\n" + .'* If the instance uses cloud disks, cloud disks are selected by default.'."\n" + .'* if no disks are available, the first NAS or CPFS dataset is selected as the working directory.'."\n" + .'* If no disk, NAS, or CPFS datasets is available, the host space is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/mnt/data', + ], + 'UserId' => [ + 'title' => '实例的使用者，可能是子账号或者主账号', + 'description' => 'the User ID of the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '16122**********', + ], + 'CloudDisks' => [ + 'title' => '云盘列表', + 'description' => 'The cloud disks.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Capacity' => [ + 'title' => '云盘容量', + 'description' => 'If **Resource Type** is **Public Resource** or if **Resource Quota** is subscription-based general-purpose computing resources (CPU cores ≥ 2 and memory ≥ 4 GB, or configured with GPU):'."\n" + ."\n" + .'Each instance has a free system disk quota of 100 GiB for persistent storage. **If the DSW instance is stopped and not launched for more than 15 days, the disk is cleared**. The disk can be expanded. For specific pricing, refer to the console.'."\n" + ."\n" + .'**'."\n" + ."\n" + .'**Warning**'."\n" + ."\n" + .'* After the expansion, you cannot reduce the storage space. Proceed with caution.'."\n" + ."\n" + .'* After the expansion, the disk is not cleared if the instance is stopped for more than 15 days. However, it will continue to incur fees.'."\n" + ."\n" + .'* If you delete the instance, the system disk is also released and the data stored in the disk is deleted. Make sure that you have backed up your data before you delete the instance.'."\n" + ."\n" + .'If you need persistent storage, you can **mount a dataset** or add the OSS, NAS, or CPFS path to the **storage path**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '100Gi', + ], + 'SubType' => [ + 'title' => '云盘类型, rootfs 挂载为rootfs', + 'description' => 'Disk type:'."\n" + ."\n" + .'* rootfs: Mounts the disk as a system disk. The system environment is stored on the disk.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rootfs', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'example' => '[]', + ], + 'Priority' => [ + 'title' => '实例排队优先级', + 'description' => 'The priority based on which resources are allocated to instances. Valid values: 1 to 9.'."\n" + ."\n" + .'* 1: the lowest priority.'."\n" + .'* 9 is the highest priority.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Driver' => [ + 'title' => 'Driver for accelerator', + 'description' => 'The NVIDIA driver configuration.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '535.54.03', + ], + 'DisassociateDriver' => [ + 'title' => '是否删除关联端口透出信息', + 'description' => 'Specifies whether to delete the NVIDIA driver configuration.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'CredentialConfig' => [ + 'title' => 'credential注入配置。', + 'description' => 'The credential configuration.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/CredentialConfig', + ], + 'DisassociateCredential' => [ + 'title' => '是否删除credential注入信息。', + 'description' => 'Specifies whether to delete the credential injection information.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'Affinity' => [ + 'description' => 'The affinity configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'CPU' => [ + 'description' => 'The CPU affinity configuration. Only subscription instances that use general-purpose computing resources support CPU affinity configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'description' => 'Specifies whether CPU affinity is enabled.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'ImageAuth' => [ + 'title' => '用户私有镜像的账号密码信息，如果镜像地址是公共镜像或者归属当前账号的 ACR 镜像，则不需要填写。生成方法： ${username}:${password} base64编码后的值。', + 'description' => 'The Base64-encoded account and password for the user‘s private image. The password will be hidden.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + 'DynamicMount' => [ + 'description' => 'The dynamic mount configuration.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/DynamicMount', + ], + 'EnvironmentVariables' => [ + 'type' => 'object', + ], + 'DisassociateEnvironmentVariables' => [ + 'type' => 'boolean', + ], + 'UserCommand' => [ + 'type' => 'object', + 'properties' => [ + 'OnStart' => [ + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'DisassociateUserCommand' => [ + 'type' => 'boolean', + ], + 'OversoldType' => [ + 'title' => '闲时资源的类型：'."\n" + .'ForceQuotaOverSold：只使用闲时资源'."\n" + .'AcceptQuotaOverSold：可接受闲时资源'."\n" + .'ForbiddenQuotaOverSold：使用保障资源', + 'type' => 'string', + ], + 'DisassociateSpot' => [ + 'title' => '是否关闭竞价配置', + 'type' => 'boolean', + ], + 'SpotSpec' => [ + 'title' => '抢占实例配置', + 'type' => 'object', + 'properties' => [ + 'SpotStrategy' => [ + 'title' => '抢占策略：'."\n" + .'SpotWithPriceLimit：自定义设置抢占实例价格上限。'."\n" + .'SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。', + 'type' => 'string', + 'example' => 'SpotWithPriceLimit', + ], + 'SpotPriceLimit' => [ + 'title' => '抢占式实例的每小时价格上限，最多支持精确到小数点后三位，抢占策略是SpotWithPriceLimit的时候必填', + 'type' => 'string', + 'example' => '0.12', + ], + 'SpotDuration' => [ + 'title' => '抢占式实例的保护期。默认为1，可设置为0，表示无保护期。灵骏规格无效。', + 'type' => 'string', + 'example' => '0', + ], + 'SpotDiscountLimit' => [ + 'title' => '抢占式实例的每小时折扣上限，灵骏规格必填。', + 'type' => 'string', + 'example' => '0.1', + ], + ], + ], + 'DisassociateAssignNode' => [ + 'title' => '是否关闭指定节点调度', + 'type' => 'boolean', + ], + 'AssignNodeSpec' => [ + 'title' => '指定节点调度配置', + 'type' => 'object', + 'properties' => [ + 'NodeNames' => [ + 'title' => '指定调度的节点:"node-a,node-b"', + 'type' => 'string', + 'example' => 'node-a', + ], + 'AntiAffinityNodeNames' => [ + 'title' => '排除调度的节点:"node-a,node-b"', + 'type' => 'string', + 'example' => 'node-b', + ], + ], + ], + 'StartInstance' => [ + 'type' => 'boolean', + ], + 'MigrationOptions' => [ + 'title' => '实例迁移选项，只支持启用了持久化存储的灵骏实例设置此参数。当前支持：'."\n" + .'● EnableProcessesPreservation ：是否保留实例运行中的进程。可选值：true , false。启用此能力，需要实例预留进程迁移需要的存储空间。', + 'type' => 'object', + ], + 'DisassociateMigrationOptions' => [ + 'title' => '是否删除迁移选项', + 'type' => 'boolean', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '执行结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The response message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* 400'."\n" + .'* 404'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'UpdateInstance', + ], + 'StartInstance' => [ + 'summary' => '启动实例', + 'path' => '/api/v2/instances/{InstanceId}/start', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '118635', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '执行结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => '', + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\"\\n}","type":"json"}]', + ], + 'StopInstance' => [ + 'summary' => '停止实例', + 'path' => '/api/v2/instances/{InstanceId}/stop', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '118632', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'SaveImage', + 'in' => 'query', + 'schema' => [ + 'title' => '是否保存环境后再关闭实例', + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '执行结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => '', + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\"\\n}","type":"json"}]', + ], + 'GetInstance' => [ + 'summary' => 'Queries the details of a DSW instance.', + 'path' => '/api/v2/instances/{InstanceId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '118634', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例Id', + 'description' => 'The instance ID. You can call [ListInstances](~~470439~~) to obtain the instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sharing token information.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'WUzWCMr325LV0bH2JH4C4HoDaKIU6C4S', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '实例详情', + 'description' => 'The instance details.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'title' => '工作空间Id', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '40823', + ], + 'WorkspaceName' => [ + 'title' => '工作空间名称', + 'description' => 'The workspace name.'."\n", + 'type' => 'string', + 'example' => 'training_data', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'InstanceName' => [ + 'title' => '实例名称', + 'description' => 'The instance name.'."\n", + 'type' => 'string', + 'example' => 'training_data', + ], + 'EcsSpec' => [ + 'title' => '实例对应的Ecs规格', + 'description' => 'The ECS instance type of the instance.'."\n", + 'type' => 'string', + 'example' => 'ecs.c6.large', + ], + 'Status' => [ + 'title' => '实例状态', + 'description' => 'The instance status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Creating'."\n" + .'* SaveFailed'."\n" + .'* Stopped'."\n" + .'* Failed'."\n" + .'* ResourceAllocating'."\n" + .'* Stopping'."\n" + .'* Updating'."\n" + .'* Saving'."\n" + .'* Queuing'."\n" + .'* Recovering'."\n" + .'* Starting'."\n" + .'* Running'."\n" + .'* Saved'."\n" + .'* Deleting'."\n" + .'* EnvPreparing'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Creating' => '', + 'SaveFailed' => '', + 'Stopped' => '', + 'Failed' => '', + 'ResourceAllocating' => '', + 'Stopping' => '', + 'Updating' => '', + 'Saving' => '', + 'Queuing' => '', + 'Recovering' => '', + 'Starting' => '', + 'Running' => '', + 'Saved' => '', + 'Deleting' => '', + 'EnvPreparing' => '', + ], + 'example' => 'Running', + ], + 'InstanceUrl' => [ + 'title' => '实例Url', + 'description' => 'The instance URL.'."\n", + 'type' => 'string', + 'example' => 'https://dsw-cn-shanghai.data.aliyun.com/notebook.htm?instance=39772#/', + ], + 'JupyterlabUrl' => [ + 'title' => 'Jupyterlab Url', + 'description' => 'The JupyterLab URL.'."\n", + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/lab/', + ], + 'WebIDEUrl' => [ + 'title' => 'Web IDE url', + 'description' => 'The Web IDE URL.'."\n", + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/ide/', + ], + 'TerminalUrl' => [ + 'title' => '终端url', + 'description' => 'The terminal URL.'."\n", + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/tty/', + ], + 'AccumulatedRunningTimeInMs' => [ + 'title' => '累计运行时间（ms）', + 'description' => 'The accumulated running duration. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600000', + ], + 'ImageId' => [ + 'title' => '镜像Id', + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'image-05cefd0be2exxxx', + ], + 'ImageUrl' => [ + 'title' => '镜像地址', + 'description' => 'The image address.'."\n", + 'type' => 'string', + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu', + ], + 'ImageName' => [ + 'title' => '镜像名称', + 'description' => 'The image name.'."\n", + 'type' => 'string', + 'example' => 'py36_cpu_tf1.12_ubuntu', + ], + 'GmtCreateTime' => [ + 'title' => '实例创建时间', + 'description' => 'The creation time of the instance.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'GmtModifiedTime' => [ + 'title' => '实例修改时间', + 'description' => 'The last modified time of the instance.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'UserId' => [ + 'title' => '用户Id', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1612285282502324', + ], + 'UserName' => [ + 'title' => '用户名称', + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => '测试用户', + ], + 'Datasets' => [ + 'title' => '数据集集合', + 'description' => 'The datasets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A dataset object. The dataset can be of the NAS or OSS type. Its properties include the dataset ID and the mount path in the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'DatasetId' => [ + 'title' => '数据集Id', + 'description' => 'The dataset ID.'."\n", + 'type' => 'string', + 'example' => 'd-vsqjvsjp4orp5l206u', + ], + 'DatasetVersion' => [ + 'title' => '数据集版本', + 'description' => 'The dataset version.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Uri' => [ + 'title' => '数据Uri', + 'description' => 'The dataset URI.'."\n", + 'type' => 'string', + 'example' => 'oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/', + ], + 'MountPath' => [ + 'title' => '容器内挂载路径', + 'description' => 'The mount path in the container.'."\n", + 'type' => 'string', + 'example' => '/mnt/data', + ], + 'MountAccess' => [ + 'title' => '读写权限，RW：读写，RO：只读。', + 'description' => 'The read and write permissions. Valid values: RW and RO.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'RW' => 'RW', + 'RO' => 'RO', + ], + 'example' => 'RW', + ], + 'Options' => [ + 'title' => '数据挂载的配置项', + 'description' => 'The mount type of the dataset.'."\n", + 'type' => 'string', + 'example' => '{'."\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' => [ + 'description' => 'The mount type of the dataset (deprecated).'."\n", + 'type' => 'string', + 'example' => 'FastReadWrite', + ], + 'Dynamic' => [ + 'description' => 'Indicates whether dynamic mounting is enabled. Default value: false.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ActualMountAccess' => [ + 'title' => '实际读写权限，RW：读写，RO：只读。', + 'type' => 'string', + ], + ], + ], + ], + 'UserVpc' => [ + 'title' => 'user vpc配置', + 'description' => 'The virtual private cloud (VPC) configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => 'Vpc Id', + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-xxxxx', + ], + 'VSwitchId' => [ + 'title' => 'VSwitch Id', + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-xxxxx', + ], + 'SecurityGroupId' => [ + 'title' => 'Security Group Id', + 'description' => 'The security group ID.'."\n", + 'type' => 'string', + 'example' => 'sg-xxxxxx', + ], + 'ExtendedCIDRs' => [ + 'description' => 'The extended CIDR block.'."\n" + ."\n" + .'* If you leave VSwitchId empty, this parameter is not required and the system automatically obtains all CIDR blocks in the VPC.'."\n" + .'* If VSwitchId is not empty, this parameter is required. Specify all CIDR blocks in the VPC.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The extended CIDR block.'."\n", + 'type' => 'string', + 'example' => '"172.16.19.0/24","172.16.2.0/24","172.16.12.0/24"', + ], + 'example' => '["192.168.0.1/24", "192.168.1.1/24"]', + ], + 'DefaultRoute' => [ + 'title' => 'Default Route', + 'description' => 'Default Route'."\n", + 'type' => 'string', + 'example' => 'eth0 | eth1', + ], + 'ForwardInfos' => [ + 'description' => 'The forward information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The forward information.'."\n", + '$ref' => '#/components/schemas/ForwardInfoResponse', + ], + ], + 'BandwidthLimit' => [ + 'title' => '公网带宽限速配置', + '$ref' => '#/components/schemas/BandwidthLimit', + ], + 'Ip' => [ + 'title' => '用户VPC的IP地址', + 'type' => 'string', + ], + ], + ], + 'InstanceShutdownTimer' => [ + 'title' => '定时关机任务', + 'description' => 'The scheduled stop tasks.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'GmtCreateTime' => [ + 'title' => '创建时间', + 'description' => 'The creation time.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'GmtModifiedTime' => [ + 'title' => '修改时间', + 'description' => 'The modified time.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'DueTime' => [ + 'title' => '设定关机时间', + 'description' => 'The scheduled stop time.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'RemainingTimeInMs' => [ + 'title' => '剩余关机时间（ms）', + 'description' => 'The remaining time before the instance is stopped. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600000', + ], + ], + ], + 'ReasonCode' => [ + 'title' => '实例错误代码', + 'description' => 'The error code of the instance.'."\n", + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'ReasonMessage' => [ + 'title' => '实例错误原因', + 'description' => 'The cause of the instance error.'."\n", + 'type' => 'string', + 'example' => 'ImagePullBackOff', + ], + 'PaymentType' => [ + 'title' => '支付类型', + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* PayAsYouGo'."\n" + .'* Subscription'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'LatestSnapshot' => [ + 'title' => '最新保存的用户镜像', + 'description' => 'The latest user image saved.'."\n", + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'title' => '镜像Id', + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'image-05cefd0be2exxxx', + ], + 'ImageName' => [ + 'title' => '镜像名称', + 'description' => 'The image name.'."\n", + 'type' => 'string', + 'example' => 'py36_cpu_tf1.12_ubuntu', + ], + 'ImageUrl' => [ + 'title' => '镜像Url', + 'description' => 'The image URL.'."\n", + 'type' => 'string', + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu', + ], + 'RepositoryUrl' => [ + 'title' => '镜像仓库Url', + 'description' => 'The image repository URL.'."\n", + 'type' => 'string', + 'example' => 'https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images', + ], + 'GmtCreateTime' => [ + 'title' => '快照创建时间', + 'description' => 'The time when the snapshot was created.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'GmtModifiedTime' => [ + 'title' => '快照修改时间', + 'description' => 'The time when the snapshot was modified.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'ReasonCode' => [ + 'title' => '实例快照错误代码', + 'description' => 'The error code of the instance snapshot.'."\n", + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'ReasonMessage' => [ + 'title' => '实例快照错误消息', + 'description' => 'The error message of the instance snapshot.'."\n", + 'type' => 'string', + 'example' => 'ImagePullBackOff', + ], + 'Status' => [ + 'title' => '实例快照状态', + 'description' => 'The instance snapshot status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Committing'."\n" + .'* Pushing'."\n" + .'* Failed'."\n" + .'* Saved'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Committing' => '', + 'Pushing' => '', + 'Failed' => '', + 'Saved' => '', + ], + 'example' => 'Pushing', + ], + ], + ], + 'AcceleratorType' => [ + 'title' => '实例计算类型', + 'description' => 'The accelerator type of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* CPU'."\n" + .'* GPU'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'CPU' => 'CPU', + 'GPU' => 'GPU', + ], + 'example' => 'CPU', + ], + 'Accessibility' => [ + 'title' => '工作空间内是否他人可见', + 'description' => 'The accessibility. Valid values:'."\n" + ."\n" + .'* PRIVATE: Accessible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: Accessible to all members in the workspace.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'PUBLIC' => '', + 'PRIVATE' => '', + ], + 'example' => 'PRIVATE', + ], + 'EnvironmentVariables' => [ + 'title' => '环境变量', + 'description' => 'The environment variables.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The user defined environment variables, injected into the container after the instance is started.'."\n", + 'example' => 'app: MAAS', + ], + 'example' => '{userName: "Chris"}', + ], + 'ResourceId' => [ + 'title' => '资源Id,预付费时填写', + 'description' => 'The resource ID. This parameter is available if the billing method is subscription.'."\n", + 'type' => 'string', + 'example' => 'dsw-123456789', + ], + 'ResourceName' => [ + 'description' => 'The specification type.'."\n" + ."\n" + .'* For subscription, this is the requested CPU and memory size.'."\n" + .'* For pay-as-you-go, this is the selected ECS instance type.'."\n", + 'type' => 'string', + 'example' => 'ecs.g7.xlarge', + ], + 'Priority' => [ + 'title' => '优先级，在分配资源给实例时，优先级越高的实例越优先', + 'description' => 'The priority based on which resources are allocated to instances.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestedResource' => [ + 'title' => '资源配置，弹内或者轻量化时使用', + 'description' => 'The resource configurations in subscription scenarios.'."\n", + 'type' => 'object', + 'properties' => [ + 'CPU' => [ + 'title' => 'cpu核数', + 'description' => 'The number of CPU cores.'."\n", + 'type' => 'string', + 'example' => '32', + ], + 'Memory' => [ + 'title' => 'memory大小', + 'description' => 'The memory size. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '32', + ], + 'SharedMemory' => [ + 'title' => 'shared memory大小', + 'description' => 'The shared memory size. Unit: GB.'."\n", + 'type' => 'string', + 'example' => '32', + ], + 'GPU' => [ + 'title' => 'gpu数量', + 'description' => 'The number of GPUs.'."\n", + 'type' => 'string', + 'example' => '4', + ], + 'GPUType' => [ + 'title' => 'gpu显卡类型', + 'description' => 'The GPU type. Valid values:'."\n" + ."\n" + .'* V100'."\n" + .'* A100'."\n" + .'* T4'."\n" + .'* A10'."\n" + .'* P100'."\n", + 'type' => 'string', + 'example' => 'v100', + ], + ], + 'example' => '{"CPU":"4","Memory":"8Gi","SharedMemory":"4Gi","GPU":"1","GPUType":"Tesla-V100-16G"}', + ], + 'Labels' => [ + 'title' => '用户自定义标签', + 'description' => 'The custom tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'You can add custom tags to an instance to mark some custom attributes.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '用户定义标签键', + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'stsTokenOwner', + ], + 'Value' => [ + 'title' => '用户定义标签值', + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => '123xxxxxxxx', + ], + ], + ], + 'example' => '{\'foo\': \'bar\'}', + ], + 'IdleInstanceCuller' => [ + 'title' => '实例的空闲资源回收器', + 'description' => 'The automatic shutdown settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'CpuPercentThreshold' => [ + 'description' => 'The CPU utilization threshold. Unit: percentage. Valid values: 1 to 100. If the CPU utilization of the instance is lower than this threshold, the instance is considered idle.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'GpuPercentThreshold' => [ + 'description' => 'The GPU utilization threshold. Unit: percentage. Valid values: 1 to 100. This parameter takes effect only if the instance is of the GPU instance type. If both CPU and GPU utilization is lower than the thresholds, the instance is considered idle.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MaxIdleTimeInMinutes' => [ + 'description' => 'The maximum time duration for which the instance is idle. Unit: minutes. If the time duration for which the instance is idle exceeds this value, the system automatically stops the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'IdleTimeInMinutes' => [ + 'description' => 'The current time duration for which the instance is idle. Unit: minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + 'example' => '{"InstanceId":"dsw-05cefd0be2e5a278","CpuPercentThreshold":20,"GpuPercentThreshold":10,"MaxIdleTimeInMinutes":120,"IdleTimeInMinutes":30}', + ], + 'InstanceSnapshotList' => [ + 'title' => '实例的快照列表', + 'description' => 'The instance snapshots.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance snapshot.'."\n", + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'title' => '镜像Id', + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'image-05cefd0be2exxxx', + ], + 'ImageName' => [ + 'title' => '镜像名称', + 'description' => 'The image name.'."\n", + 'type' => 'string', + 'example' => 'py36_cpu_tf1.12_ubuntu', + ], + 'ImageUrl' => [ + 'title' => '镜像Url', + 'description' => 'The image URL.'."\n", + 'type' => 'string', + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu', + ], + 'RepositoryUrl' => [ + 'title' => '镜像仓库Url', + 'description' => 'The image repository URL.'."\n", + 'type' => 'string', + 'example' => 'https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images', + ], + 'GmtCreateTime' => [ + 'title' => '快照创建时间', + 'description' => 'The time when the snapshot was created.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'GmtModifiedTime' => [ + 'title' => '快照修改时间', + 'description' => 'The time when the snapshot was modified.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'ReasonCode' => [ + 'title' => '实例快照错误代码', + 'description' => 'The error code of the instance snapshot.'."\n", + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'ReasonMessage' => [ + 'title' => '实例快照错误消息', + 'description' => 'The error message of the instance snapshot.'."\n", + 'type' => 'string', + 'example' => 'ImagePullBackOff', + ], + 'Status' => [ + 'title' => '实例快照状态', + 'description' => 'The instance snapshot status.'."\n", + 'type' => 'string', + 'example' => 'Pushing', + ], + ], + ], + 'example' => '[]', + ], + 'CloudDisks' => [ + 'title' => '实例的云盘列表', + 'description' => 'The cloud disks of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The disk information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Capacity' => [ + 'title' => '云盘容量', + 'description' => 'Disk Capacity'."\n", + 'type' => 'string', + 'example' => '30Gi', + ], + 'SubType' => [ + 'title' => '云盘使用方式, rootfs 挂载为rootfs', + 'description' => 'The usage mode of the cloud disk. The value rootfs indicates that the cloud disk is used as the root file system.'."\n", + 'type' => 'string', + 'example' => 'rootfs', + ], + 'MountPath' => [ + 'title' => '容器内挂载云盘路径', + 'description' => 'The mount path of the cloud disk in the container.'."\n", + 'type' => 'string', + 'example' => '/mmt/workspace', + ], + 'Path' => [ + 'title' => '云盘内被挂载目录路径', + 'description' => 'The directory on the cloud disk that is mounted to the container.'."\n", + 'type' => 'string', + 'example' => '/workspace', + ], + 'Status' => [ + 'type' => 'object', + 'properties' => [ + 'Available' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Usage' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Capacity' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'example' => '[]', + ], + 'WorkspaceSource' => [ + 'title' => '工作空间指向的存储，如果不指定，则依次使用NAS，CloudDisk或者本地磁盘', + 'description' => 'The storage for the workspace. If you leave this parameter empty, the workspace uses File Storage NAS (NAS) storage, cloud disks, or local disks in sequence.'."\n", + 'type' => 'string', + 'example' => 'd-123456789', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The error message. Valid values:'."\n" + ."\n" + .'* If the request is successful, null is returned.'."\n" + .'* If the request fails, the cause for the failure is returned.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: All errors, except for parameter validation errors, are internal errors.'."\n" + .'* ValidationError: A parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* 400'."\n" + .'* 404'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'Driver' => [ + 'title' => 'NVIDIA 驱动配置', + 'description' => 'The NVIDIA driver configuration.'."\n", + 'type' => 'string', + 'example' => '535.54.03', + ], + 'NodeErrorRecovery' => [ + 'description' => 'The error recovery configuration of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'hasNodeError' => [ + 'description' => 'Indicates whether the node has an error.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'enableAutoSwitchOnNodeError' => [ + 'description' => 'Indicates whether to enable automatic switchover when a node error occurs.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'autoSwitchCountdownSeconds' => [ + 'description' => 'The number of seconds to wait before automatic switchover.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + ], + ], + 'CredentialConfig' => [ + 'title' => 'Credential注入配置。', + 'description' => 'The credential injection configuration.'."\n", + '$ref' => '#/components/schemas/CredentialConfig', + ], + 'Affinity' => [ + 'description' => 'The affinity configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'CPU' => [ + 'description' => 'The CPU affinity configuration. Only subscription instances that use general-purpose computing resources support CPU affinity configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'description' => 'Indicates whether CPU affinity is enabled.'."\n" + ."\n" + .'true false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'ImageAuth' => [ + 'title' => '用户私有镜像的账号密码信息base64编码后的值，密码部分会被隐藏。', + 'description' => 'The Base64-encoded account and password for the user‘s private image. The password will be hidden.'."\n", + 'type' => 'string', + 'example' => 'YWxpeXVuNjUzMzM5MjIwMzoqKioqKio=', + ], + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'A resource tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'tag1', + ], + 'TagValue' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'DynamicMount' => [ + 'description' => 'The dynamic mount configuration.'."\n", + '$ref' => '#/components/schemas/DynamicMount', + ], + 'ProxyPath' => [ + 'description' => 'The proxy path.'."\n", + 'type' => 'string', + 'example' => 'dsw-170197/proxy/', + ], + 'UserCommandId' => [ + 'type' => 'string', + ], + 'ServiceConfig' => [ + '$ref' => '#/components/schemas/ServiceConfig', + ], + 'PodIps' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/PodIp', + ], + ], + 'MigrationOptions' => [ + 'title' => '实例迁移选项', + 'type' => 'object', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WorkspaceId\\": \\"40823\\",\\n \\"WorkspaceName\\": \\"training_data\\",\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"InstanceName\\": \\"training_data\\",\\n \\"EcsSpec\\": \\"ecs.c6.large\\",\\n \\"Status\\": \\"Running\\",\\n \\"InstanceUrl\\": \\"https://dsw-cn-shanghai.data.aliyun.com/notebook.htm?instance=3****#/\\",\\n \\"JupyterlabUrl\\": \\"https://dsw-gateway-cn-shanghai.aliyun.com/dsw-3****/lab/\\",\\n \\"WebIDEUrl\\": \\"https://dsw-gateway-cn-shanghai.aliyun.com/dsw-3****/ide/\\",\\n \\"TerminalUrl\\": \\"https://dsw-gateway-cn-shanghai.aliyun.com/dsw-3****/tty/\\",\\n \\"AccumulatedRunningTimeInMs\\": 3600000,\\n \\"ImageId\\": \\"image-05cefd0be2exxxx\\",\\n \\"ImageUrl\\": \\"registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu\\",\\n \\"ImageName\\": \\"py36_cpu_tf1.12_ubuntu\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"UserId\\": \\"161228528250****\\",\\n \\"UserName\\": \\"测试用户\\",\\n \\"Datasets\\": [\\n {\\n \\"DatasetId\\": \\"d-vsqjvsjp4orp5l****\\",\\n \\"DatasetVersion\\": \\"v1\\",\\n \\"Uri\\": \\"oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/\\",\\n \\"MountPath\\": \\"/mnt/data\\",\\n \\"MountAccess\\": \\"RW\\",\\n \\"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}\\",\\n \\"OptionType\\": \\"FastReadWrite\\",\\n \\"Dynamic\\": false,\\n \\"ActualMountAccess\\": \\"\\"\\n }\\n ],\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-xxxxx\\",\\n \\"VSwitchId\\": \\"vsw-xxxxx\\",\\n \\"SecurityGroupId\\": \\"sg-xxxxxx\\",\\n \\"ExtendedCIDRs\\": [\\n \\"\\\\\\"172.16.19.0/24\\\\\\",\\\\\\"172.16.2.0/24\\\\\\",\\\\\\"172.16.12.0/24\\\\\\"\\"\\n ],\\n \\"DefaultRoute\\": \\"eth0 | eth1\\",\\n \\"ForwardInfos\\": [\\n {\\n \\"Enable\\": true,\\n \\"ContainerName\\": \\"dsw-notebook\\",\\n \\"ForwardPort\\": \\"22\\",\\n \\"NatGatewayId\\": \\"ngw-bp1uewa15k4iy5770****\\",\\n \\"EipAllocationId\\": \\"eip-25877c70gddh****\\",\\n \\"SSHPublicKey\\": \\"\\",\\n \\"ConnectInfo\\": {\\n \\"Phase\\": \\"Ready\\",\\n \\"Message\\": \\"DNAT and privateZone are both ready.\\",\\n \\"Intranet\\": {\\n \\"Endpoint\\": \\"dsw-notebook-22-urz3u6cnu0uts7ej9r.dsw-5cc6083084818f60.dsw.pai.alibaba.com\\",\\n \\"Port\\": \\"22\\"\\n },\\n \\"Internet\\": {\\n \\"Endpoint\\": \\"47.111.119.114\\",\\n \\"Port\\": \\"22\\"\\n }\\n },\\n \\"Name\\": \\"ssh\\",\\n \\"ExternalPort\\": \\"1024\\",\\n \\"AccessType\\": [\\n \\"intranet\\"\\n ]\\n }\\n ],\\n \\"BandwidthLimit\\": {\\n \\"EgressWhitelists\\": [\\n \\"\\"\\n ],\\n \\"IngressRate\\": \\"\\",\\n \\"EgressRate\\": \\"\\",\\n \\"IngressWhitelists\\": [\\n \\"\\"\\n ]\\n },\\n \\"Ip\\": \\"\\"\\n },\\n \\"InstanceShutdownTimer\\": {\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"DueTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"RemainingTimeInMs\\": 3600000\\n },\\n \\"ReasonCode\\": \\"Internal Error\\",\\n \\"ReasonMessage\\": \\"ImagePullBackOff\\",\\n \\"PaymentType\\": \\"PayAsYouGo\\",\\n \\"LatestSnapshot\\": {\\n \\"ImageId\\": \\"image-05cefd0be2exxxx\\",\\n \\"ImageName\\": \\"py36_cpu_tf1.12_ubuntu\\",\\n \\"ImageUrl\\": \\"registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu\\",\\n \\"RepositoryUrl\\": \\"https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"ReasonCode\\": \\"Internal Error\\",\\n \\"ReasonMessage\\": \\"ImagePullBackOff\\",\\n \\"Status\\": \\"Pushing\\"\\n },\\n \\"AcceleratorType\\": \\"CPU\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EnvironmentVariables\\": {\\n \\"key\\": \\"app: MAAS\\"\\n },\\n \\"ResourceId\\": \\"dsw-12345****\\",\\n \\"ResourceName\\": \\"ecs.g7.xlarge\\",\\n \\"Priority\\": 1,\\n \\"RequestedResource\\": {\\n \\"CPU\\": \\"32\\",\\n \\"Memory\\": \\"32\\",\\n \\"SharedMemory\\": \\"32\\",\\n \\"GPU\\": \\"4\\",\\n \\"GPUType\\": \\"v100\\"\\n },\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"stsTokenOwner\\",\\n \\"Value\\": \\"123xxxxxxxx\\"\\n }\\n ],\\n \\"IdleInstanceCuller\\": {\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"CpuPercentThreshold\\": 20,\\n \\"GpuPercentThreshold\\": 10,\\n \\"MaxIdleTimeInMinutes\\": 60,\\n \\"IdleTimeInMinutes\\": 30\\n },\\n \\"InstanceSnapshotList\\": [\\n {\\n \\"ImageId\\": \\"image-05cefd0be2exxxx\\",\\n \\"ImageName\\": \\"py36_cpu_tf1.12_ubuntu\\",\\n \\"ImageUrl\\": \\"registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu\\",\\n \\"RepositoryUrl\\": \\"https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"ReasonCode\\": \\"Internal Error\\",\\n \\"ReasonMessage\\": \\"ImagePullBackOff\\",\\n \\"Status\\": \\"Pushing\\"\\n }\\n ],\\n \\"CloudDisks\\": [\\n {\\n \\"Capacity\\": \\"30Gi\\",\\n \\"SubType\\": \\"rootfs\\",\\n \\"MountPath\\": \\"/mmt/workspace\\",\\n \\"Path\\": \\"/workspace\\",\\n \\"Status\\": {\\n \\"Available\\": 0,\\n \\"Usage\\": 0,\\n \\"Capacity\\": 0\\n }\\n }\\n ],\\n \\"WorkspaceSource\\": \\"d-123456789\\",\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FC****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"null\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Driver\\": \\"535.54.03\\",\\n \\"NodeErrorRecovery\\": {\\n \\"hasNodeError\\": false,\\n \\"enableAutoSwitchOnNodeError\\": true,\\n \\"autoSwitchCountdownSeconds\\": 30\\n },\\n \\"CredentialConfig\\": {\\n \\"Enable\\": true,\\n \\"AliyunEnvRoleKey\\": \\"0\\",\\n \\"Configs\\": [\\n {\\n \\"Key\\": \\"0\\",\\n \\"Type\\": \\"Role\\",\\n \\"Roles\\": [\\n {\\n \\"RoleArn\\": \\"acs:ram::123******:role/****\\",\\n \\"RoleType\\": \\"service\\",\\n \\"AssumeRoleFor\\": \\"123******\\",\\n \\"Policy\\": \\"{}\\",\\n \\"UserInfo\\": {\\n \\"Id\\": \\"456******\\",\\n \\"Type\\": \\"sub\\",\\n \\"AccessKeyId\\": \\"LT********\\",\\n \\"SecurityToken\\": \\"********\\"\\n }\\n }\\n ]\\n }\\n ]\\n },\\n \\"Affinity\\": {\\n \\"CPU\\": {\\n \\"Enable\\": true\\n }\\n },\\n \\"ImageAuth\\": \\"YWxpeXVuNjUzMzM5MjIwMzoqKioqKio=\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"value1\\"\\n }\\n ],\\n \\"DynamicMount\\": {\\n \\"Enable\\": true,\\n \\"MountPoints\\": [\\n {\\n \\"RootPath\\": \\"\\",\\n \\"Options\\": \\"\\"\\n }\\n ]\\n },\\n \\"ProxyPath\\": \\"dsw-170197/proxy/\\",\\n \\"UserCommandId\\": \\"1900\\",\\n \\"ServiceConfig\\": {\\n \\"JupyterServerPassword\\": \\"\\",\\n \\"JupyterServerAuth\\": \\"\\",\\n \\"CodeServerPassword\\": \\"\\",\\n \\"CodeServerAuth\\": \\"\\"\\n },\\n \\"PodIps\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"Ip\\": \\"\\",\\n \\"InterfaceName\\": \\"\\"\\n }\\n ],\\n \\"MigrationOptions\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'GetInstance', + ], + 'ListInstances' => [ + 'summary' => 'Queries a list of Data Science Workshop (DSW) instances.', + 'path' => '/api/v2/instances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '118637', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间Id', + 'description' => 'The workspace ID. You can call [ListWorkspaces](~~449124~~) to obtain the workspace ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '40823', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'title' => '实例名称', + 'description' => 'The instance name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'training_data', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组Id', + 'description' => 'The resource group ID. If you leave this parameter empty, the instances in the pay-as-you-go resource group are queried. If you set this parameter to ALL, all instances are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-123456789', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '实例状态', + 'description' => 'The instance status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Creating'."\n" + .'* SaveFailed'."\n" + .'* Stopped'."\n" + .'* Failed'."\n" + .'* ResourceAllocating'."\n" + .'* Stopping'."\n" + .'* Updating'."\n" + .'* Saving'."\n" + .'* Queuing'."\n" + .'* Recovering'."\n" + .'* Starting'."\n" + .'* Running'."\n" + .'* Saved'."\n" + .'* Deleting'."\n" + .'* EnvPreparing'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Creating' => '', + 'SaveFailed' => '', + 'Stopped' => '', + 'Failed' => '', + 'ResourceAllocating' => '', + 'Stopping' => '', + 'Updating' => '', + 'Saving' => '', + 'Queuing' => '', + 'Recovering' => '', + 'Starting' => '', + 'Running' => '', + 'Saved' => '', + 'Deleting' => '', + 'EnvPreparing' => '', + ], + 'example' => 'Running', + ], + ], + [ + 'name' => 'PaymentType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PayAsYouGo'."\n" + .'* Subscription'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PayAsYouGo' => '', + 'Subscription' => '', + ], + 'example' => 'PayAsYouGo', + ], + ], + [ + 'name' => 'Accessibility', + 'in' => 'query', + 'schema' => [ + 'description' => 'The accessibility. Valid values:'."\n" + ."\n" + .'* PRIVATE (default): The instances are accessible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The instances are accessible only to all members in the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PRIVATE', + ], + ], + [ + 'name' => 'AcceleratorType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The accelerator type.'."\n" + ."\n" + .'* CPU: Only CPU computing is used.'."\n" + .'* GPU: GPUs are used to accelerate computing.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CPU' => 'CPU', + 'GPU' => 'GPU', + ], + 'example' => 'CPU', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '分页数量大小', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => 'The field that you use to sort the query results.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Priority'."\n" + .'* GmtCreateTime'."\n" + .'* GmtModifiedTime'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Priority' => '', + 'GmtCreateTime' => '', + 'GmtModifiedTime' => '', + ], + 'example' => 'gmtCreate', + 'default' => 'GmtModifiedTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排列顺序', + 'description' => 'The order that you use to sort the query results.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => '', + 'DESC' => '', + ], + 'example' => 'DESC', + 'default' => 'DESC', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID. You can call [ListInstances](~~470439~~) to obtain the instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The labels. A maximum of four labels are supported.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2",'."\n" + .' "key3": "value3"'."\n" + .'}', + ], + ], + [ + 'name' => 'CreateUserId', + 'in' => 'query', + 'schema' => [ + 'title' => '创建人的UserId', + 'description' => 'The UID of the creator.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12345*****67890', + ], + ], + [ + 'name' => 'GpuType', + 'in' => 'query', + 'schema' => [ + 'title' => 'Gpu类型', + 'description' => 'The GPU type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NVIDIA A10', + ], + ], + [ + 'name' => 'MinCpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of CPUs. Unit: 0.001 CPU. The value 1000 indicates one CPU.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2000', + ], + ], + [ + 'name' => 'MaxCpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of CPUs. Unit: 0.001 CPU. The value 1000 indicates one CPU.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '30000', + ], + ], + [ + 'name' => 'MinGpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of GPUs. Unit: 0.001 GPU. The value 1000 indicates one GPU.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'MaxGpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of GPUs. Unit: 0.001 GPU. The value 1000 indicates one GPU.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8000', + ], + ], + [ + 'name' => 'MinMemory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum memory size. Unit: GB.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'MaxMemory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum memory size. Unit: GB.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '48', + ], + ], + [ + 'name' => 'MinGpuMemory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum memory size per GPU card. Unit: GB.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8', + ], + ], + [ + 'name' => 'MaxGpuMemory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum memory size per GPU card. Unit: GB.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '16', + ], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'schema' => [ + 'title' => '镜像名', + 'description' => 'The image name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'modelscope:1.9.4-pytorch2.0.1tensorflow2.13.0-cpu-py38-ubuntu20.04', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'OversoldInfo', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'OversoldType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'CreateTimeAfter', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'CreateTimeBefore', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '实例列表', + 'description' => 'The instances.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The response message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* 400'."\n" + .'* 404'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'TotalCount' => [ + 'title' => '实例总数', + 'description' => 'The total number of instances.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35', + ], + 'Instances' => [ + 'title' => '本分页中请求的实例列表', + 'description' => 'The instances returned on this page.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'WorkspaceId' => [ + 'title' => '工作空间Id', + 'description' => 'The workspace ID.'."\n", + 'type' => 'string', + 'example' => '40823', + ], + 'WorkspaceName' => [ + 'title' => '工作空间名称', + 'description' => 'The workspace name.'."\n", + 'type' => 'string', + 'example' => 'training_data', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'InstanceName' => [ + 'title' => '实例名称', + 'description' => 'The instance name.'."\n", + 'type' => 'string', + 'example' => 'training_data', + ], + 'EcsSpec' => [ + 'title' => '实例对应的Ecs规格', + 'description' => 'The ECS instance type of the instance.'."\n", + 'type' => 'string', + 'example' => 'ecs.c6.large', + ], + 'Status' => [ + 'title' => '实例状态', + 'description' => 'The instance status.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'InstanceUrl' => [ + 'title' => '实例Url', + 'description' => 'The instance URL.'."\n", + 'type' => 'string', + 'example' => 'https://dsw-cn-shanghai.data.aliyun.com/notebook.htm?instance=39772#/', + ], + 'JupyterlabUrl' => [ + 'title' => 'Jupyterlab Url', + 'description' => 'The JupyterLab URL.'."\n", + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/lab/', + ], + 'WebIDEUrl' => [ + 'title' => 'Web IDE url', + 'description' => 'The Web IDE URL.'."\n", + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/ide/', + ], + 'TerminalUrl' => [ + 'title' => '终端url', + 'description' => 'The terminal URL.'."\n", + 'type' => 'string', + 'example' => 'https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/tty/', + ], + 'AccumulatedRunningTimeInMs' => [ + 'title' => '累计运行时间（ms）', + 'description' => 'The accumulated running duration. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600000', + ], + 'ImageId' => [ + 'title' => '镜像Id', + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'image-05cefd0be2exxxx', + ], + 'ImageUrl' => [ + 'title' => '镜像地址', + 'description' => 'The image address.'."\n", + 'type' => 'string', + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu', + ], + 'ImageName' => [ + 'title' => '镜像名称', + 'description' => 'The image name.'."\n", + 'type' => 'string', + 'example' => 'py36_cpu_tf1.12_ubuntu', + ], + 'GmtCreateTime' => [ + 'title' => '实例创建时间', + 'description' => 'The time when the instance was created.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'GmtModifiedTime' => [ + 'title' => '实例修改时间', + 'description' => 'The time when the instance was modified.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'UserId' => [ + 'title' => '用户Id', + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1612285282502324', + ], + 'UserName' => [ + 'title' => '用户名称', + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => '测试用户', + ], + 'Datasets' => [ + 'title' => '数据集集合', + 'description' => 'The datasets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dataset.'."\n", + 'type' => 'object', + 'properties' => [ + 'DatasetId' => [ + 'title' => '数据集Id', + 'description' => 'The dataset ID.'."\n", + 'type' => 'string', + 'example' => 'd-vsqjvsjp4orp5l206u', + ], + 'DatasetVersion' => [ + 'title' => '数据集版本', + 'description' => 'The dataset version.'."\n", + 'type' => 'string', + 'example' => 'v1', + ], + 'Uri' => [ + 'title' => '数据Uri', + 'description' => 'The dataset URI.'."\n", + 'type' => 'string', + 'example' => 'oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/', + ], + 'MountPath' => [ + 'title' => '容器内挂载路径', + 'description' => 'The mount path in the container.'."\n", + 'type' => 'string', + 'example' => '/mnt/data', + ], + 'MountAccess' => [ + 'title' => '读写权限，RW：读写，RO：只读。', + 'description' => 'The read and write permissions. Valid values: RW and RO.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'RW' => '', + 'RO' => '', + ], + 'example' => 'RW', + ], + 'Options' => [ + 'title' => '数据挂载的配置项', + 'description' => 'The mount type of the dataset.'."\n", + 'type' => 'string', + 'example' => '{'."\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' => [ + 'title' => '挂载配置项类型，目前只支持OSS数据集', + 'description' => 'The type of the mount option.'."\n", + 'type' => 'string', + 'example' => 'FastReadWrite', + ], + 'Dynamic' => [ + 'description' => 'Indicates whether dynamic mounting was enabled. Default value: false.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'UserVpc' => [ + 'title' => 'user vpc配置', + 'description' => 'The virtual private cloud (VPC) configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'title' => 'Vpc Id', + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-xxxxx', + ], + 'VSwitchId' => [ + 'title' => 'VSwitch Id', + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-xxxxx', + ], + 'SecurityGroupId' => [ + 'title' => 'Security Group Id', + 'description' => 'The security group ID.'."\n", + 'type' => 'string', + 'example' => 'sg-xxxxxx', + ], + 'ExtendedCIDRs' => [ + 'description' => 'The extended CIDR blocks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The extended CIDR block.'."\n", + 'type' => 'string', + 'example' => '192.168.0.1/24', + ], + 'example' => '["192.168.0.1/24", "192.168.1.1/24"]', + ], + 'DefaultRoute' => [ + 'title' => 'Default Route', + 'description' => 'The default route.'."\n", + 'type' => 'string', + 'example' => 'eth0 | eth1', + ], + 'ForwardInfos' => [ + 'description' => 'The forward information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The forward information.'."\n", + '$ref' => '#/components/schemas/ForwardInfoResponse', + ], + ], + 'BandwidthLimit' => [ + '$ref' => '#/components/schemas/BandwidthLimit', + ], + 'Ip' => [ + 'type' => 'string', + ], + ], + ], + 'InstanceShutdownTimer' => [ + 'title' => '定时关机任务', + 'description' => 'The scheduled stop task.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'GmtCreateTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the instance was created.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'GmtModifiedTime' => [ + 'title' => '修改时间', + 'description' => 'The time when the instance was modified.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'DueTime' => [ + 'title' => '设定关机时间', + 'description' => 'The scheduled stop time.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'RemainingTimeInMs' => [ + 'title' => '剩余关机时间（ms）', + 'description' => 'The remaining time before the instance is stopped.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600000', + ], + ], + ], + 'ReasonCode' => [ + 'title' => '实例错误代码', + 'description' => 'The error code of the instance.'."\n", + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'ReasonMessage' => [ + 'title' => '实例错误原因', + 'description' => 'The cause of the instance error.'."\n", + 'type' => 'string', + 'example' => 'ImagePullBackOff', + ], + 'PaymentType' => [ + 'title' => '支付类型', + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* PayAsYouGo'."\n" + .'* Subscription'."\n", + 'type' => 'string', + 'example' => 'PayAsYouGo', + ], + 'LatestSnapshot' => [ + 'title' => '最新保存的用户镜像', + 'description' => 'The user image that was latest saved.'."\n", + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'title' => '镜像Id', + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'image-05cefd0be2exxxx', + ], + 'ImageName' => [ + 'title' => '镜像名称', + 'description' => 'The image name.'."\n", + 'type' => 'string', + 'example' => 'py36_cpu_tf1.12_ubuntu', + ], + 'ImageUrl' => [ + 'title' => '镜像Url', + 'description' => 'The image URL.'."\n", + 'type' => 'string', + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu', + ], + 'RepositoryUrl' => [ + 'title' => '镜像仓库Url', + 'description' => 'The URL of the image repository.'."\n", + 'type' => 'string', + 'example' => 'https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images', + ], + 'GmtCreateTime' => [ + 'title' => '快照创建时间', + 'description' => 'The time when the snapshot was created.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'GmtModifiedTime' => [ + 'title' => '快照修改时间', + 'description' => 'The time when the snapshot was modified.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'ReasonCode' => [ + 'title' => '实例快照错误代码', + 'description' => 'The error code of the instance snapshot.'."\n", + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'ReasonMessage' => [ + 'title' => '实例快照错误消息', + 'description' => 'The error message of the instance snapshot.'."\n", + 'type' => 'string', + 'example' => 'ImagePullBackOff', + ], + 'Status' => [ + 'title' => '实例快照状态', + 'description' => 'The status of the instance snapshot.'."\n", + 'type' => 'string', + 'example' => 'Pushing', + ], + ], + ], + 'AcceleratorType' => [ + 'title' => '实例计算类型', + 'description' => 'The accelerator type of the instance. Valid values:'."\n" + ."\n" + .'* CPU'."\n" + .'* GPU'."\n", + 'type' => 'string', + 'example' => 'CPU', + ], + 'Accessibility' => [ + 'title' => '工作空间内是否他人可见', + 'description' => 'The accessibility. Valid values:'."\n" + ."\n" + .'* PRIVATE (default): The instances are accessible only to you and the administrator of the workspace.'."\n" + .'* PUBLIC: The instances are accessible only to all members in the workspace.'."\n", + 'type' => 'string', + 'example' => 'PRIVATE', + ], + 'EnvironmentVariables' => [ + 'title' => '环境变量', + 'description' => 'The environment variables.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'MAAS', + 'description' => 'The specific environment variable. After a DSW instance is started, the specific environment variable is injected into the container.'."\n", + ], + 'example' => '{userName: "Chris"}', + ], + 'ResourceId' => [ + 'title' => '资源Id,预付费时填写', + 'description' => 'The resource ID. This parameter is valid only if you set PaymentType to Subscription.'."\n", + 'type' => 'string', + 'example' => 'dsw-123456789', + ], + 'ResourceName' => [ + 'description' => 'The specifications.'."\n" + ."\n" + .'* In pay-as-you-go scenarios, the value is the specifications of the purchased ECS instance type.'."\n" + .'* In subscription scenarios, the value is the requested number of CPU cores and memory size.'."\n", + 'type' => 'string', + 'example' => 'resource_group', + ], + 'Priority' => [ + 'title' => '优先级，在分配资源给实例时，优先级越高的实例越优先', + 'description' => 'The priority based on which resources are allocated to instances. Resources are preferentially allocated to instances with higher priorities.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'RequestedResource' => [ + 'title' => '资源配置，弹内或者轻量化时使用', + 'description' => 'The resource configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'CPU' => [ + 'title' => 'cpu核数', + 'description' => 'The number of CPU cores.'."\n", + 'type' => 'string', + 'example' => '32', + ], + 'Memory' => [ + 'title' => 'memory大小', + 'description' => 'The memory size.'."\n", + 'type' => 'string', + 'example' => '32', + ], + 'SharedMemory' => [ + 'title' => 'shared memory大小', + 'description' => 'The size of the shared memory.'."\n", + 'type' => 'string', + 'example' => '32', + ], + 'GPU' => [ + 'title' => 'gpu数量', + 'description' => 'The number of GPUs.'."\n", + 'type' => 'string', + 'example' => '4', + ], + 'GPUType' => [ + 'title' => 'gpu显卡类型', + 'description' => 'The GPU memory type.'."\n", + 'type' => 'string', + 'example' => 'v100', + ], + ], + 'example' => '{"CPU":"4","Memory":"8Gi","SharedMemory":"4Gi","GPU":"1","GPUType":"Tesla-V100-16G"}', + ], + 'Labels' => [ + 'title' => '用户自定义标签', + 'description' => 'The custom labels.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The custom label.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '用户定义标签键', + 'description' => 'The custom label key.'."\n", + 'type' => 'string', + 'example' => 'stsTokenOwner', + ], + 'Value' => [ + 'title' => '用户定义标签值', + 'description' => 'The custom label value.'."\n", + 'type' => 'string', + 'example' => '123xxxxxxxx', + ], + ], + ], + 'example' => '{\'foo\': \'bar\'}', + ], + 'IdleInstanceCuller' => [ + 'title' => '实例的空闲资源回收器', + 'description' => 'The rule for stopping idle instances.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'CpuPercentThreshold' => [ + 'description' => 'The CPU utilization threshold. Unit: percentage. Valid values: 1 to 100. If the CPU utilization of the instance is lower than this threshold, the instance is considered idle.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'GpuPercentThreshold' => [ + 'description' => 'The GPU utilization threshold. Unit: percentage. Valid values: 1 to 100. This parameter takes effect only if the instance is of the GPU instance type. If both CPU and GPU utilization is lower than the thresholds, the instance is considered idle.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MaxIdleTimeInMinutes' => [ + 'description' => 'The maximum time duration for which the instance is idle. Unit: minutes. If the time duration for which the instance is idle exceeds this value, the system automatically stops the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'IdleTimeInMinutes' => [ + 'description' => 'The time duration for which the instance is idle. Unit: minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + 'example' => '{"InstanceId":"dsw-05cefd0be2e5a278","CpuPercentThreshold":20,"GpuPercentThreshold":10,"MaxIdleTimeInMinutes":120,"IdleTimeInMinutes":30}', + ], + 'InstanceSnapshotList' => [ + 'title' => '实例的快照列表', + 'description' => 'The instance snapshots.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance snapshot.'."\n", + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'title' => '镜像Id', + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'image-05cefd0be2exxxx', + ], + 'ImageName' => [ + 'title' => '镜像名称', + 'description' => 'The image name.'."\n", + 'type' => 'string', + 'example' => 'py36_cpu_tf1.12_ubuntu', + ], + 'ImageUrl' => [ + 'title' => '镜像Url', + 'description' => 'The image URL.'."\n", + 'type' => 'string', + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu', + ], + 'RepositoryUrl' => [ + 'title' => '镜像仓库Url', + 'description' => 'The URL of the image repository.'."\n", + 'type' => 'string', + 'example' => 'https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images', + ], + 'GmtCreateTime' => [ + 'title' => '快照创建时间', + 'description' => 'The time when the snapshot was created.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'GmtModifiedTime' => [ + 'title' => '快照修改时间', + 'description' => 'The time when the snapshot was modified.'."\n", + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'ReasonCode' => [ + 'title' => '实例快照错误代码', + 'description' => 'The error code of the instance snapshot.'."\n", + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'ReasonMessage' => [ + 'title' => '实例快照错误消息', + 'description' => 'The error message of the instance snapshot.'."\n", + 'type' => 'string', + 'example' => 'ImagePullBackOff', + ], + 'Status' => [ + 'title' => '实例快照状态', + 'description' => 'The status of the instance snapshot.'."\n", + 'type' => 'string', + 'example' => 'Pushing', + ], + ], + ], + 'example' => '[]', + ], + 'CloudDisks' => [ + 'title' => '实例的云盘列表', + 'description' => 'The cloud disks of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Capacity' => [ + 'title' => '云盘容量', + 'description' => 'The cloud disk capacity.'."\n", + 'type' => 'string', + 'example' => '30Gi', + ], + 'SubType' => [ + 'title' => '云盘使用方式, rootfs 挂载为rootfs', + 'description' => 'The cloud disk type. The value rootfs indicates that the cloud disk is used as the root file system (rootfs).'."\n", + 'type' => 'string', + 'example' => 'rootfs', + ], + 'MountPath' => [ + 'title' => '容器内挂载云盘路径', + 'description' => 'The mount path of the cloud disk in the container.'."\n", + 'type' => 'string', + 'example' => '/mmt/workspace', + ], + 'Path' => [ + 'title' => '云盘内被挂载目录路径', + 'description' => 'The directory on the cloud disk that is mounted to the container.'."\n", + 'type' => 'string', + 'example' => '/workspace', + ], + ], + 'description' => '', + ], + 'example' => '[]', + ], + 'WorkspaceSource' => [ + 'title' => '工作空间指向的存储，如果不指定，则依次使用NAS，CloudDisk或者本地磁盘', + 'description' => 'The storage for the workspace. If you leave this parameter empty, the workspace uses File Storage NAS (NAS) storage, cloud disks, or local disks in sequence.'."\n", + 'type' => 'string', + 'example' => 'd-123456789', + ], + 'Driver' => [ + 'title' => 'NVIDIA 驱动配置', + 'description' => 'The NVIDIA driver configuration.'."\n", + 'type' => 'string', + 'example' => '535.54.03', + ], + 'CredentialConfig' => [ + 'title' => 'Credential注入配置。', + 'description' => 'The credential configuration.'."\n", + '$ref' => '#/components/schemas/CredentialConfig', + ], + 'Affinity' => [ + 'description' => 'The affinity configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'CPU' => [ + 'description' => 'The CPU affinity configuration. Only subscription instances that use general-purpose computing resources support CPU affinity configuration.'."\n", + 'type' => 'object', + 'properties' => [ + 'Enable' => [ + 'description' => 'Indicates whether the CPU affinity feature was enabled.'."\n" + ."\n" + .'true false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'ImageAuth' => [ + 'title' => '用户私有镜像的账号密码信息base64编码后的值，密码部分会被隐藏。', + 'description' => 'The Base64-encoded account and password for the user\'s private image. The password will be hidden.'."\n", + 'type' => 'string', + 'example' => 'aGFyYm9yYWlAeGltYWxheWE6KioqKioq', + ], + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'tag1', + ], + 'TagValue' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'value1', + ], + ], + ], + ], + 'DynamicMount' => [ + 'description' => 'The dynamic mount configurations.'."\n", + '$ref' => '#/components/schemas/DynamicMount', + ], + 'OversoldType' => [ + 'type' => 'string', + ], + 'OversoldInfo' => [ + 'type' => 'string', + ], + 'ServiceConfig' => [ + '$ref' => '#/components/schemas/ServiceConfig', + ], + ], + ], + ], + 'MigrationOptions' => [ + 'title' => '实例迁移选项', + 'type' => 'object', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"TotalCount\\": 35,\\n \\"Instances\\": [\\n {\\n \\"WorkspaceId\\": \\"40823\\",\\n \\"WorkspaceName\\": \\"training_data\\",\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"InstanceName\\": \\"training_data\\",\\n \\"EcsSpec\\": \\"ecs.c6.large\\",\\n \\"Status\\": \\"Running\\",\\n \\"InstanceUrl\\": \\"https://dsw-cn-shanghai.data.aliyun.com/notebook.htm?instance=39772#/\\",\\n \\"JupyterlabUrl\\": \\"https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/lab/\\",\\n \\"WebIDEUrl\\": \\"https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/ide/\\",\\n \\"TerminalUrl\\": \\"https://dsw-gateway-cn-shanghai.aliyun.com/dsw-39772/tty/\\",\\n \\"AccumulatedRunningTimeInMs\\": 3600000,\\n \\"ImageId\\": \\"image-05cefd0be2exxxx\\",\\n \\"ImageUrl\\": \\"registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu\\",\\n \\"ImageName\\": \\"py36_cpu_tf1.12_ubuntu\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"UserId\\": \\"1612285282502324\\",\\n \\"UserName\\": \\"测试用户\\",\\n \\"Datasets\\": [\\n {\\n \\"DatasetId\\": \\"d-vsqjvsjp4orp5l206u\\",\\n \\"DatasetVersion\\": \\"v1\\",\\n \\"Uri\\": \\"oss://bucket-name.oss-cn-shanghai-internal.aliyuncs.com/data/path/\\",\\n \\"MountPath\\": \\"/mnt/data\\",\\n \\"MountAccess\\": \\"RW\\",\\n \\"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}\\",\\n \\"OptionType\\": \\"FastReadWrite\\",\\n \\"Dynamic\\": false\\n }\\n ],\\n \\"UserVpc\\": {\\n \\"VpcId\\": \\"vpc-xxxxx\\",\\n \\"VSwitchId\\": \\"vsw-xxxxx\\",\\n \\"SecurityGroupId\\": \\"sg-xxxxxx\\",\\n \\"ExtendedCIDRs\\": [\\n \\"192.168.0.1/24\\"\\n ],\\n \\"DefaultRoute\\": \\"eth0 | eth1\\",\\n \\"ForwardInfos\\": [\\n {\\n \\"Enable\\": true,\\n \\"ContainerName\\": \\"dsw-notebook\\",\\n \\"ForwardPort\\": \\"22\\",\\n \\"NatGatewayId\\": \\"ngw-bp1uewa15k4iy5770****\\",\\n \\"EipAllocationId\\": \\"eip-25877c70gddh****\\",\\n \\"SSHPublicKey\\": \\"\\",\\n \\"ConnectInfo\\": {\\n \\"Phase\\": \\"Ready\\",\\n \\"Message\\": \\"DNAT and privateZone are both ready.\\",\\n \\"Intranet\\": {\\n \\"Endpoint\\": \\"dsw-notebook-22-urz3u6cnu0uts7ej9r.dsw-5cc6083084818f60.dsw.pai.alibaba.com\\",\\n \\"Port\\": \\"22\\"\\n },\\n \\"Internet\\": {\\n \\"Endpoint\\": \\"47.111.119.114\\",\\n \\"Port\\": \\"22\\"\\n }\\n },\\n \\"Name\\": \\"ssh\\",\\n \\"ExternalPort\\": \\"1024\\",\\n \\"AccessType\\": [\\n \\"intranet\\"\\n ]\\n }\\n ],\\n \\"BandwidthLimit\\": {\\n \\"EgressWhitelists\\": [\\n \\"\\"\\n ],\\n \\"IngressRate\\": \\"\\",\\n \\"EgressRate\\": \\"\\",\\n \\"IngressWhitelists\\": [\\n \\"\\"\\n ]\\n },\\n \\"Ip\\": \\"\\"\\n },\\n \\"InstanceShutdownTimer\\": {\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"DueTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"RemainingTimeInMs\\": 3600000\\n },\\n \\"ReasonCode\\": \\"Internal Error\\",\\n \\"ReasonMessage\\": \\"ImagePullBackOff\\",\\n \\"PaymentType\\": \\"PayAsYouGo\\",\\n \\"LatestSnapshot\\": {\\n \\"ImageId\\": \\"image-05cefd0be2exxxx\\",\\n \\"ImageName\\": \\"py36_cpu_tf1.12_ubuntu\\",\\n \\"ImageUrl\\": \\"registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu\\",\\n \\"RepositoryUrl\\": \\"https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"ReasonCode\\": \\"Internal Error\\",\\n \\"ReasonMessage\\": \\"ImagePullBackOff\\",\\n \\"Status\\": \\"Pushing\\"\\n },\\n \\"AcceleratorType\\": \\"CPU\\",\\n \\"Accessibility\\": \\"PRIVATE\\",\\n \\"EnvironmentVariables\\": {\\n \\"key\\": \\"MAAS\\"\\n },\\n \\"ResourceId\\": \\"dsw-123456789\\",\\n \\"ResourceName\\": \\"resource_group\\",\\n \\"Priority\\": 1,\\n \\"RequestedResource\\": {\\n \\"CPU\\": \\"32\\",\\n \\"Memory\\": \\"32\\",\\n \\"SharedMemory\\": \\"32\\",\\n \\"GPU\\": \\"4\\",\\n \\"GPUType\\": \\"NVIDIA A10\\"\\n },\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"stsTokenOwner\\",\\n \\"Value\\": \\"123xxxxxxxx\\"\\n }\\n ],\\n \\"IdleInstanceCuller\\": {\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"CpuPercentThreshold\\": 20,\\n \\"GpuPercentThreshold\\": 10,\\n \\"MaxIdleTimeInMinutes\\": 60,\\n \\"IdleTimeInMinutes\\": 30\\n },\\n \\"InstanceSnapshotList\\": [\\n {\\n \\"ImageId\\": \\"image-05cefd0be2exxxx\\",\\n \\"ImageName\\": \\"py36_cpu_tf1.12_ubuntu\\",\\n \\"ImageUrl\\": \\"registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu\\",\\n \\"RepositoryUrl\\": \\"https://cr.console.aliyun.com/repository/cn-hangzhou/zouxu/kf/images\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"ReasonCode\\": \\"Internal Error\\",\\n \\"ReasonMessage\\": \\"ImagePullBackOff\\",\\n \\"Status\\": \\"Pushing\\"\\n }\\n ],\\n \\"CloudDisks\\": [\\n {\\n \\"Capacity\\": \\"30Gi\\",\\n \\"SubType\\": \\"rootfs\\",\\n \\"MountPath\\": \\"/mmt/workspace\\",\\n \\"Path\\": \\"/workspace\\"\\n }\\n ],\\n \\"WorkspaceSource\\": \\"d-123456789\\",\\n \\"Driver\\": \\"535.54.03\\",\\n \\"CredentialConfig\\": {\\n \\"Enable\\": true,\\n \\"AliyunEnvRoleKey\\": \\"0\\",\\n \\"Configs\\": [\\n {\\n \\"Key\\": \\"0\\",\\n \\"Type\\": \\"Role\\",\\n \\"Roles\\": [\\n {\\n \\"RoleArn\\": \\"acs:ram::123******:role/****\\",\\n \\"RoleType\\": \\"service\\",\\n \\"AssumeRoleFor\\": \\"123******\\",\\n \\"Policy\\": \\"{}\\",\\n \\"UserInfo\\": {\\n \\"Id\\": \\"456******\\",\\n \\"Type\\": \\"sub\\",\\n \\"AccessKeyId\\": \\"LT********\\",\\n \\"SecurityToken\\": \\"********\\"\\n }\\n }\\n ]\\n }\\n ]\\n },\\n \\"Affinity\\": {\\n \\"CPU\\": {\\n \\"Enable\\": true\\n }\\n },\\n \\"ImageAuth\\": \\"aGFyYm9yYWlAeGltYWxheWE6KioqKioq\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"value1\\"\\n }\\n ],\\n \\"DynamicMount\\": {\\n \\"Enable\\": true,\\n \\"MountPoints\\": [\\n {\\n \\"RootPath\\": \\"\\",\\n \\"Options\\": \\"\\"\\n }\\n ]\\n },\\n \\"OversoldType\\": \\"\\",\\n \\"OversoldInfo\\": \\"\\",\\n \\"ServiceConfig\\": {\\n \\"JupyterServerPassword\\": \\"\\",\\n \\"JupyterServerAuth\\": \\"\\",\\n \\"CodeServerPassword\\": \\"\\",\\n \\"CodeServerAuth\\": \\"\\"\\n }\\n }\\n ],\\n \\"MigrationOptions\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ListInstances', + ], + 'GetInstanceEvents' => [ + 'summary' => 'Queries a list of system events for a Data Science Workshop (DSW) instance.', + 'path' => '/api/v2/instances/{InstanceId}/events', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191013', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'MaxEventsNum', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of events. Default value: 2000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2000', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-08T15:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-08T15:00:00Z', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token used to share the URL.'."\n", + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EventLevel', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'InstanceEventListResult', + 'description' => 'The events of the DSW instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The response message.'."\n", + 'type' => 'string', + 'example' => 'XXX'."\n", + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* 400: One or more parameters are invalid.'."\n" + .'* 404: The instance does not exist.'."\n" + .'* 200: The request is normal.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'Events' => [ + 'title' => '实例事件列表', + 'description' => 'The events.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The event.'."\n", + 'type' => 'string', + 'example' => 'You are using pip version 9.0.1, however version 20.2.4 is available. ', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"XXX\\\\n\\",\\n \\"Code\\": \\"None\\",\\n \\"HttpStatusCode\\": 200,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"Events\\": [\\n \\"You are using pip version 9.0.1, however version 20.2.4 is available. \\"\\n ]\\n}","type":"json"}]', + 'title' => 'GetInstanceEvents', + ], + 'UpdateInstanceLabels' => [ + 'summary' => 'Updates the tags of a Data Science Workshop (DSW) instance. If the tags do not exist, the system adds tags.', + 'path' => '/api/v2/instances/{InstanceId}/labels', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228178', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Labels' => [ + 'title' => '需要更新的标签', + 'description' => 'The tags that you want to update.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The custom tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the custom tag.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'customLabelKey', + ], + 'Value' => [ + 'description' => 'The value of the custom tag.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'labelValue', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => 'DSW实例Id', + 'description' => 'The ID of the DSW instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response to the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\"\\n}","type":"json"}]', + 'title' => 'UpdateInstanceLabels', + ], + 'DeleteInstanceLabels' => [ + 'summary' => 'Delete tags from a Data Science Workshop (DSW) instance.', + 'path' => '/api/v2/instances/{InstanceId}/labels', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228180', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => 'DSW实例Id', + 'description' => 'The ID of the DSW instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'LabelKeys', + 'in' => 'query', + 'schema' => [ + 'title' => '需要删除的标签的Key，多个标签以半角逗号隔开', + 'description' => 'The keys of the tags that you want to delete. Separate multiple tags with commas (,).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'labelKey1,labelKey2,labelKey3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\"\\n}","type":"json"}]', + 'title' => 'DeleteInstanceLabels', + ], + 'DeleteInstances' => [ + 'summary' => '批量删除实例', + 'path' => '/api/v2/batch/instances/delete', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '247984', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[\'dsw-13cb3d2e173cb74e\']', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'AA527C1A-F259-5E53-A4DD-D0941193F02D', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'The instance can not be deleted.', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PermissionError', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'InstanceIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[\'dsw-6lo809wgmnfcl9sn34\']', + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'object', + 'example' => '{}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA527C1A-F259-5E53-A4DD-D0941193F02D\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance can not be deleted.\\",\\n \\"Code\\": \\"PermissionError\\",\\n \\"HttpStatusCode\\": 200,\\n \\"InstanceIds\\": [\\n \\"[\'dsw-6lo809wgmnfcl9sn34\']\\"\\n ],\\n \\"AccessDeniedDetail\\": {}\\n}","type":"json"}]', + ], + 'StopInstances' => [ + 'summary' => '批量停止实例', + 'path' => '/api/v2/batch/instances/stop', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '247825', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[\'dsw-msq7tjk9kox7v26il3\']', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'PermissionError', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{}', + 'description' => '', + ], + ], + 'InstanceIds' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[\'dsw-fcbhy7b9nseilom7fw\']', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"PermissionError\\",\\n \\"HttpStatusCode\\": 200,\\n \\"AccessDeniedDetail\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"InstanceIds\\": [\\n \\"[\'dsw-fcbhy7b9nseilom7fw\']\\"\\n ]\\n}","type":"json"}]', + ], + 'GetLifecycle' => [ + 'summary' => 'Obtains the lifecycle of an instance', + 'path' => '/api/v2/instances/{InstanceId}/lifecycle', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '158370', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID. You can call [ListInstances](~~470439~~) to obtain the instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-9698d842b6***', + ], + ], + [ + 'name' => 'SessionNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'A session refers to the process of an instance from startup to failure or shutdown. The sessionNumber indicates the offset value for the instance\'s session sequence.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-08T15:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-08T15:00:00Z', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of sessions to query.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting order of the results. Valid values:'."\n" + ."\n" + .'* ASC: sorted by time in ascending order.'."\n" + .'* DESC: sorted by time in descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token used to share the URL.'."\n", + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'LifecycleResult', + 'description' => 'The lifecycle query results.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: All errors, except for parameter validation errors, are internal errors.'."\n" + .'* ValidationError: A parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'Lifecycle' => [ + 'description' => 'The lifecycle details.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of lifecycle results. Each child item is the lifecycle of a session.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The lifecycle of a session.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'* Creating'."\n" + .'* SaveFailed: The instance image failed to be saved.'."\n" + .'* Stopped'."\n" + .'* Failed'."\n" + .'* ResourceAllocating'."\n" + .'* Stopping'."\n" + .'* Updating'."\n" + .'* Saving'."\n" + .'* Starting'."\n" + .'* Running'."\n" + .'* Saved'."\n" + .'* EnvPreparing: Preparing environment.'."\n" + .'* ArrearStopping: The service is being stopped due to overdue payments.'."\n" + .'* Arrearge: The service is stopped due to overdue payments.'."\n" + .'* Queuing'."\n" + .'* Recovering'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'ArrearStopping' => 'ArrearStopping', + 'Creating' => 'Creating', + 'SaveFailed' => 'SaveFailed', + 'Stopped' => 'Stopped', + 'Failed' => 'Failed', + 'ResourceAllocating' => 'ResourceAllocating', + 'Stopping' => 'Stopping', + 'Updating' => 'Updating', + 'Saving' => 'Saving', + 'Arrearge' => 'Arrearge', + 'Queuing' => 'Queuing', + 'Recovering' => 'Recovering', + 'Starting' => 'Starting', + 'Running' => 'Running', + 'Saved' => 'Saved', + 'EnvPreparing' => 'EnvPreparing', + ], + 'example' => 'Starting', + ], + 'ReasonCode' => [ + 'description' => 'The reason code that corresponds to an event.'."\n", + 'type' => 'string', + 'example' => '“”', + ], + 'ReasonMessage' => [ + 'description' => 'The reason message that corresponds to an event.'."\n", + 'type' => 'string', + 'example' => '“”', + ], + 'GmtCreateTime' => [ + 'description' => 'The time the status was created, specifically the time the instance transitioned to this status (in GMT).'."\n", + 'type' => 'string', + 'example' => '2022-10-21T07:27:44Z', + ], + 'GmtEndTime' => [ + 'type' => 'string', + ], + 'LifecycleId' => [ + 'type' => 'string', + ], + ], + ], + ], + 'example' => '[[{"Status":"Creating","GmtCreateTime":"2022-09-19T22:38:00Z","Reason":"","ReasonCode":""}]]', + ], + 'TotalCount' => [ + 'description' => 'The total number of queried sessions.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '35', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FC****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"Lifecycle\\": [\\n [\\n {\\n \\"Status\\": \\"Starting\\",\\n \\"ReasonCode\\": \\"“”\\",\\n \\"ReasonMessage\\": \\"“”\\",\\n \\"GmtCreateTime\\": \\"2022-10-21T07:27:44Z\\",\\n \\"GmtEndTime\\": \\"\\",\\n \\"LifecycleId\\": \\"\\"\\n }\\n ]\\n ],\\n \\"TotalCount\\": 35\\n}","type":"json"}]', + 'title' => 'GetLifecycle', + 'description' => 'Obtains the lifecycle transition information for an instance, including details on the status an instance transitions to at a specific point in time.'."\n", + ], + 'GetInstanceMetrics' => [ + 'path' => '/api/v2/instance/{InstanceId}/metrics', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '152077', + 'abilityTreeNodes' => [ + 'FEATURElearnTBR2KU', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID. You can call [ListInstances](~~470439~~) to obtain the instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The metric type. Valid values:'."\n" + ."\n" + .'* GpuCoreUsage: the GPU utilization.'."\n" + .'* GpuMemoryUsage: the GPU memory utilization.'."\n" + .'* CpuCoreUsage: the CPU utilization.'."\n" + .'* MemoryUsage: the memory utilization.'."\n" + .'* NetworkInputRate: the network ingress rate.'."\n" + .'* NetworkOutputRate: the network egress rate.'."\n" + .'* DiskReadRate: the disk read rate.'."\n" + .'* DiskWriteRate: the disk write rate.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'GpuCoreUsage' => '', + 'NetworkInputRate' => '', + 'DiskWriteRate' => '', + 'CpuCoreUsage' => '', + 'GpuMemoryUsage' => '', + 'NetworkOutputRate' => '', + 'DiskReadRate' => '', + 'MemoryUsage' => '', + ], + 'example' => 'GpuCoreUsage', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-08T15:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-08T15:00:00Z', + ], + ], + [ + 'name' => 'TimeStep', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval at which metrics are returned. Unit: minutes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '15m', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'MetricResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The response message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* 400'."\n" + .'* 404'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'PodMetrics' => [ + 'description' => 'The information about the metrics of the pod that corresponds to the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the metric of the pod that corresponds to the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'PodId' => [ + 'description' => 'The ID of the pod that corresponds to the instance.'."\n", + 'type' => 'string', + 'example' => 'dsw-15870-695f44c5bc-hd6xm', + ], + 'Metrics' => [ + 'description' => 'The metrics of the pod that corresponds to the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The metric of the pod that corresponds to the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => 'The timestamp corresponding to the metric.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1670890560', + ], + 'Value' => [ + 'description' => 'The metric value.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '25.901031', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"PodMetrics\\": [\\n {\\n \\"PodId\\": \\"dsw-15870-695f44c5bc-hd6xm\\",\\n \\"Metrics\\": [\\n {\\n \\"Time\\": 1670890560,\\n \\"Value\\": 25.901031\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetInstanceMetrics', + 'summary' => 'Queries the resource metrics of an instance.', + ], + 'CreateInstanceSnapshot' => [ + 'summary' => '创建实例快照', + 'path' => '/api/v2/instances/{InstanceId}/snapshots', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '118641', + 'abilityTreeNodes' => [ + 'FEATURElearnE5ZUBR', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '实例快照属性', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SnapshotName' => [ + 'title' => '实例快照名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'training_data_env', + ], + 'SnapshotDescription' => [ + 'title' => '实例快照描述', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'training_data_env', + ], + 'ImageUrl' => [ + 'title' => '镜像地址', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu', + ], + 'Labels' => [ + 'title' => '用户自定义标签', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '用户定义标签键', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'stsTokenOwner', + ], + 'Value' => [ + 'title' => '用户定义标签值', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123xxxxxxxx', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '{\'foo\': \'bar\'}', + ], + 'ExcludePaths' => [ + 'title' => '排除文件路径列表，仅支持 ECI 实例设置， 用于制作镜像时忽略指定文件夹或文件。', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'required' => false, + ], + 'Overwrite' => [ + 'title' => '是否覆盖更新镜像仓库中已存在的镜像 tag。', + 'type' => 'boolean', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '执行结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => '', + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'SnapshotId' => [ + 'title' => '实例快照Id', + 'description' => '', + 'type' => 'string', + 'example' => 'snp-05cexxxxxxxxx', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"SnapshotId\\": \\"snp-05cexxxxxxxxx\\"\\n}","type":"json"}]', + ], + 'DeleteInstanceSnapshot' => [ + 'summary' => '获取实例快照详情', + 'path' => '/api/v2/instances/{InstanceId}/snapshots/{SnapshotId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '118643', + 'abilityTreeNodes' => [ + 'FEATURElearnE5ZUBR', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例快照Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'snp-05cexxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '实例快照详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => '', + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'SnapshotId' => [ + 'title' => '实例快照Id', + 'description' => '', + 'type' => 'string', + 'example' => 'snp-05cexxxxxxxxx', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"SnapshotId\\": \\"snp-05cexxxxxxxxx\\"\\n}","type":"json"}]', + ], + 'GetInstanceSnapshot' => [ + 'summary' => '获取实例快照详情', + 'path' => '/api/v2/instances/{InstanceId}/snapshots/{SnapshotId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '118644', + 'abilityTreeNodes' => [ + 'FEATURElearnE5ZUBR', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例快照Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'snp-05cexxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '实例快照详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => '', + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'SnapshotId' => [ + 'title' => '实例快照Id', + 'description' => '', + 'type' => 'string', + 'example' => 'snp-05cexxxxxxxxx', + ], + 'SnapshotName' => [ + 'title' => '实例快照名称', + 'description' => '', + 'type' => 'string', + 'example' => 'training_data_env', + ], + 'Status' => [ + 'title' => '实例快照状态', + 'description' => '', + 'type' => 'string', + 'example' => 'Pushing', + ], + 'ImageId' => [ + 'title' => '实例快照的镜像Id', + 'description' => '', + 'type' => 'string', + 'example' => 'image-05cefd0be2exxxx', + ], + 'ImageUrl' => [ + 'title' => '实例快照的镜像地址', + 'description' => '', + 'type' => 'string', + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu', + ], + 'ReasonCode' => [ + 'title' => '实例快照错误代码', + 'description' => '', + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'ReasonMessage' => [ + 'title' => '实例快照错误消息', + 'description' => '', + 'type' => 'string', + 'example' => 'ImagePullBackOff', + ], + 'GmtCreateTime' => [ + 'title' => '实例快照创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'GmtModifiedTime' => [ + 'title' => '实例快照修改时间', + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'Labels' => [ + 'title' => '用户自定义标签', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '用户定义标签键', + 'type' => 'string', + 'example' => 'stsTokenOwner', + ], + 'Value' => [ + 'title' => '用户定义标签值', + 'type' => 'string', + 'example' => '123xxxxxxxx', + ], + ], + ], + 'example' => '{\'foo\': \'bar\'}', + ], + 'ExcludePaths' => [ + 'title' => '排除文件路径列表，仅支持 ECI 实例设置， 用于制作镜像时忽略指定文件夹或文件', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"SnapshotId\\": \\"snp-05cexxxxxxxxx\\",\\n \\"SnapshotName\\": \\"training_data_env\\",\\n \\"Status\\": \\"Pushing\\",\\n \\"ImageId\\": \\"image-05cefd0be2exxxx\\",\\n \\"ImageUrl\\": \\"registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu\\",\\n \\"ReasonCode\\": \\"Internal Error\\",\\n \\"ReasonMessage\\": \\"ImagePullBackOff\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"stsTokenOwner\\",\\n \\"Value\\": \\"123xxxxxxxx\\"\\n }\\n ],\\n \\"ExcludePaths\\": [\\n \\"\\"\\n ]\\n}","type":"json"}]', + ], + 'ListInstanceSnapshot' => [ + 'summary' => '查询实例快照列表', + 'path' => '/api/v2/instances/{InstanceId}/snapshots', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'gmtCreate', + 'default' => 'gmtCreate', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + 'default' => 'DESC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '实例快照列表', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => '', + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'TotalCount' => [ + 'title' => '实例总数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35', + ], + 'Snapshots' => [ + 'title' => '本分页中请求的实例镜像列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'SnapshotId' => [ + 'title' => '实例快照Id', + 'description' => '', + 'type' => 'string', + 'example' => 'snp-05cexxxxxxxxx', + ], + 'SnapshotName' => [ + 'title' => '实例快照名称', + 'description' => '', + 'type' => 'string', + 'example' => 'training_data_env', + ], + 'Status' => [ + 'title' => '实例快照状态', + 'description' => '', + 'type' => 'string', + 'example' => 'Pushing', + ], + 'ImageId' => [ + 'title' => '实例快照的镜像Id', + 'description' => '', + 'type' => 'string', + 'example' => 'image-05cefd0be2exxxx', + ], + 'ImageUrl' => [ + 'title' => '实例快照的镜像地址', + 'description' => '', + 'type' => 'string', + 'example' => 'registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu', + ], + 'ReasonCode' => [ + 'title' => '实例快照错误代码', + 'description' => '', + 'type' => 'string', + 'example' => 'Internal Error', + ], + 'ReasonMessage' => [ + 'title' => '实例快照错误消息', + 'description' => '', + 'type' => 'string', + 'example' => 'ImagePullBackOff', + ], + 'GmtCreateTime' => [ + 'title' => '实例快照创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'GmtModifiedTime' => [ + 'title' => '实例快照修改时间', + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'Labels' => [ + 'title' => '用户自定义标签', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '用户定义标签键', + 'description' => '', + 'type' => 'string', + 'example' => 'stsTokenOwner', + ], + 'Value' => [ + 'title' => '用户定义标签值', + 'description' => '', + 'type' => 'string', + 'example' => '123xxxxxxxx', + ], + ], + ], + 'example' => '{\'foo\': \'bar\'}', + ], + 'ExcludePaths' => [ + 'title' => '排除文件路径列表，仅支持 ECI 实例设置， 用于制作镜像时忽略指定文件夹或文件', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'example' => '["/path1","/path2"]', + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"TotalCount\\": 35,\\n \\"Snapshots\\": [\\n {\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"SnapshotId\\": \\"snp-05cexxxxxxxxx\\",\\n \\"SnapshotName\\": \\"training_data_env\\",\\n \\"Status\\": \\"Pushing\\",\\n \\"ImageId\\": \\"image-05cefd0be2exxxx\\",\\n \\"ImageUrl\\": \\"registry.cn-shanghai.aliyuncs.com/pai_product/tensorflow:py36_cpu_tf1.12_ubuntu\\",\\n \\"ReasonCode\\": \\"Internal Error\\",\\n \\"ReasonMessage\\": \\"ImagePullBackOff\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"stsTokenOwner\\",\\n \\"Value\\": \\"123xxxxxxxx\\"\\n }\\n ],\\n \\"ExcludePaths\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetResourceGroupStatistics' => [ + 'path' => '/api/v2/resourcegroupstatistics', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '166697', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceIds', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '27218,34956', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-123456789', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2020-11-08T15:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2020-11-08T15:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'ResourceGroupStatisticsResult', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => '', + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'string', + 'example' => 'InternalError', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Statistics' => [ + 'title' => '统计信息', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + 'description' => '', + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"InternalError\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Statistics\\": {\\n \\"key\\": {\\n \\"key\\": 5\\n }\\n }\\n}","type":"json"}]', + ], + 'ListInstanceStatistics' => [ + 'summary' => '获取实例统计信息', + 'path' => '/api/v2/instancestatistics', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '118645', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'WorkspaceIds', + 'in' => 'query', + 'schema' => [ + 'title' => '工作空间列表', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '27218,34956', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '实例统计信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => '', + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'string', + 'example' => 'InternalError', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '400', + ], + 'Statistics' => [ + 'title' => '统计信息', + 'description' => '', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + 'description' => '', + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"InternalError\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Statistics\\": {\\n \\"key\\": {\\n \\"key\\": 5\\n }\\n }\\n}","type":"json"}]', + ], + 'CreateInstanceShutdownTimer' => [ + 'summary' => 'Creates a scheduled stop task for an instance.', + 'path' => '/api/v2/instances/{InstanceId}/shutdowntimer', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '118640', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '定时关机任务对应实例的Id', + 'description' => 'The instance ID. You can call [ListInstances](~~470439~~) to obtain the instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '定时关机属性', + 'description' => 'The property of the scheduled stop task.'."\n", + 'type' => 'object', + 'properties' => [ + 'DueTime' => [ + 'title' => '定时关机设定时间', + 'description' => 'The scheduled stop time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-12T14:36:01Z', + ], + 'RemainingTimeInMs' => [ + 'title' => '距离定时关机时间段', + 'description' => 'The time duration before the instance is stopped. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600000', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '执行结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The response message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* 400'."\n" + .'* 404'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'CreateInstanceShutdownTimer', + ], + 'DeleteInstanceShutdownTimer' => [ + 'summary' => 'Deletes a scheduled stop task of an instance.', + 'path' => '/api/v2/instances/{InstanceId}/shutdowntimer', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '118638', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例Id', + 'description' => 'The instance ID. You can call [ListInstances](~~470439~~) to obtain the instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '执行结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The response message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* 400'."\n" + .'* 404'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'DeleteInstanceShutdownTimer', + ], + 'GetInstanceShutdownTimer' => [ + 'summary' => '获取定时关机任务', + 'path' => '/api/v2/instances/{InstanceId}/shutdowntimer', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '118639', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '定时关机任务', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => '', + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'InstanceId' => [ + 'title' => '实例Id', + 'description' => '', + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'GmtCreateTime' => [ + 'title' => '创建时间', + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'GmtModifiedTime' => [ + 'title' => '修改时间', + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'DueTime' => [ + 'title' => '设定关机时间', + 'description' => '', + 'type' => 'string', + 'example' => '2021-01-12T14:36:01Z', + ], + 'RemainingTimeInMs' => [ + 'title' => '剩余关机时间（ms）', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3600000', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"GmtCreateTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"DueTime\\": \\"2021-01-12T14:36:01Z\\",\\n \\"RemainingTimeInMs\\": 3600000\\n}","type":"json"}]', + ], + 'CreateIdleInstanceCuller' => [ + 'path' => '/api/v2/instances/{InstanceId}/idleinstanceculler', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '154060', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID. You can call [ListInstances](~~470439~~) to obtain the instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'CpuPercentThreshold' => [ + 'description' => 'The CPU utilization threshold. Unit: percentage. Valid values: 1 to 100. If the CPU utilization of the instance is lower than this threshold, the instance is considered idle.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'GpuPercentThreshold' => [ + 'description' => 'The GPU utilization threshold. Unit: percentage. Valid values: 1 to 100. This parameter takes effect only if the instance is of the GPU instance type. If both CPU and GPU utilization is lower than the thresholds, the instance is considered idle.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'MaxIdleTimeInMinutes' => [ + 'description' => 'The maximum time duration for which the instance is idle. Unit: minutes. If the time duration for which the instance is idle exceeds this value, the system automatically stops the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'IdleInstanceCullerIdResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'CreateIdleInstanceCuller', + 'summary' => 'Creates an automatic stop policy for a specific Data Science Workshop (DSW) instance. When the conditions are met, the instance is automatically stopped. You can create only one automatic stop policy for an idle DSW instance. If the specific instance has an automatic stop policy, call DeleteIdleInstanceCuller to delete it first.', + ], + 'DeleteIdleInstanceCuller' => [ + 'path' => '/api/v2/instances/{InstanceId}/idleinstanceculler', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '154058', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID. You can call [ListInstances](~~470439~~) to obtain the instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'IdleInstanceCullerIdResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The response message.'."\n" + ."\n" + .'* If the request is successful, null is returned.'."\n" + .'* If the request fails, the failure cause is returned.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'ValidationError', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FC****\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"null\\",\\n \\"Code\\": \\"ValidationError\\",\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'DeleteIdleInstanceCuller', + 'summary' => 'Deletes the automatic stop policy of an instance.', + ], + 'GetIdleInstanceCuller' => [ + 'path' => '/api/v2/instances/{InstanceId}/idleinstanceculler', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '154059', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => 'The instance ID. You can call [ListInstances](~~470439~~) to obtain the instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'IdleInstanceCullerResult', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'ValidationError', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'CpuPercentThreshold' => [ + 'description' => 'The CPU utilization threshold. Unit: percentage. Valid values: 1 to 100. If the CPU utilization of the instance is lower than this threshold, the instance is considered idle.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'GpuPercentThreshold' => [ + 'description' => 'The GPU utilization threshold. Unit: percentage. Valid values: 1 to 100. This parameter takes effect only if the instance is of the GPU instance type. If both CPU and GPU utilization is lower than the thresholds, the instance is considered idle.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MaxIdleTimeInMinutes' => [ + 'description' => 'The maximum time duration for which the instance is idle. Unit: minutes. If the time duration for which the instance is idle exceeds this value, the system automatically stops the instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'IdleTimeInMinutes' => [ + 'description' => 'The time duration for which the instance is idle. Unit: minutes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"ValidationError\\",\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"CpuPercentThreshold\\": 20,\\n \\"GpuPercentThreshold\\": 10,\\n \\"MaxIdleTimeInMinutes\\": 60,\\n \\"IdleTimeInMinutes\\": 30\\n}","type":"json"}]', + 'title' => 'GetIdleInstanceCuller', + 'summary' => 'Queries the information about an auto stop policy for a specific idle instance.', + ], + 'ListEcsSpecs' => [ + 'summary' => 'Queries a list of specifications of ECS instances.', + 'path' => '/api/v2/ecsspecs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '118542', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [ + [ + 'name' => 'AcceleratorType', + 'in' => 'query', + 'schema' => [ + 'title' => '加速类型', + 'description' => 'The accelerator type.'."\n" + ."\n" + .'* CPU: Only CPU computing is used.'."\n" + .'* GPU: GPUs are used to accelerate computing.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'CPU', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段', + 'description' => 'The field by which the query results are sorted. Set the value to gmtCreate.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gmtCreate', + 'default' => 'gmtCreate', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序顺序', + 'description' => 'The sorting order. Valid values:'."\n" + ."\n" + .'* ASC'."\n" + .'* DESC'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + 'default' => 'DESC', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ECS规格列表', + 'description' => 'The specifications of ECS instances.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The response message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: an internal error. All errors, except for parameter validation errors, are classified as internal errors.'."\n" + .'* ValidationError: a parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'* 400'."\n" + .'* 404'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + 'TotalCount' => [ + 'title' => '实例总数', + 'description' => 'The total number of ECS instances.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '35', + ], + 'EcsSpecs' => [ + 'title' => '本分页中请求的实例列表', + 'description' => 'The specifications of the ECS instances returned on this page.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The specification of the ECS instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'title' => '实例规格', + 'description' => 'The instance type.'."\n", + 'type' => 'string', + 'example' => 'ecs.gn5-c28g1.7xlarge', + ], + 'GPUType' => [ + 'title' => '显卡类型', + 'description' => 'The GPU type. Valid values:'."\n" + ."\n" + .'* V100'."\n" + .'* A100'."\n" + .'* A10'."\n" + .'* T4'."\n" + .'* P100'."\n", + 'type' => 'string', + 'example' => 'v100', + ], + 'CPU' => [ + 'title' => 'CPU核数', + 'description' => 'The number of vCPUs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'GPU' => [ + 'title' => 'GPU卡数', + 'description' => 'The number of GPUs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'Memory' => [ + 'title' => '内存大小(GB)', + 'description' => 'The memory size. Unit: GB.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '32', + ], + 'SystemDiskCapacity' => [ + 'title' => '系统盘大小(GB)', + 'description' => 'The size of the system disk. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'AcceleratorType' => [ + 'title' => '资源类型', + 'description' => 'The accelerator type.'."\n", + 'type' => 'string', + 'example' => 'CPU', + ], + 'Price' => [ + 'title' => '价格', + 'description' => 'The price.'."\n", + 'type' => 'number', + 'format' => 'double', + 'example' => '22.8', + ], + 'Currency' => [ + 'title' => '货币单位', + 'description' => 'The currency unit.'."\n", + 'type' => 'string', + 'example' => 'CNY', + ], + 'InstanceBandwidthRx' => [ + 'title' => '实例接收带宽', + 'description' => 'The inbound bandwidth of the instance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5120000', + ], + 'Labels' => [ + 'title' => '用户自定义标签', + 'description' => 'The labels of the ECS specification.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The label.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => 'Ecs规格标签键', + 'description' => 'The label key added to the ECS specification.'."\n", + 'type' => 'string', + 'example' => 'SupportResourcePackDeduction', + ], + 'Value' => [ + 'description' => 'The label value added to the ECS specification.'."\n", + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + ], + ], + 'example' => '{\'foo\': \'bar\'}', + ], + 'IsAvailable' => [ + 'title' => '资源是否可用', + 'description' => 'Indicates whether the resource was available.'."\n", + 'type' => 'boolean', + 'example' => 'True', + 'default' => 'true', + ], + 'GPUMemorySize' => [ + 'type' => 'number', + 'format' => 'float', + ], + 'SpotStockStatus' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0,\\n \\"TotalCount\\": 35,\\n \\"EcsSpecs\\": [\\n {\\n \\"InstanceType\\": \\"ecs.gn5-c28g1.7xlarge\\",\\n \\"GPUType\\": \\"v100\\",\\n \\"CPU\\": 32,\\n \\"GPU\\": 4,\\n \\"Memory\\": 32,\\n \\"SystemDiskCapacity\\": 500,\\n \\"AcceleratorType\\": \\"CPU\\",\\n \\"Price\\": 22.8,\\n \\"Currency\\": \\"CNY\\",\\n \\"InstanceBandwidthRx\\": 5120000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"SupportResourcePackDeduction\\",\\n \\"Value\\": \\"true\\"\\n }\\n ],\\n \\"IsAvailable\\": true,\\n \\"GPUMemorySize\\": 0,\\n \\"SpotStockStatus\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListEcsSpecs', + ], + 'GetUserConfig' => [ + 'summary' => '获取用户配置', + 'path' => '/api/v2/userconfig', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '118609', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '用户配置', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccountSufficient' => [ + 'title' => '用户账号金额是否充足', + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'FreeTierSpecAvailable' => [ + 'title' => '是否可以购买free tier规格的实例', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FreeTier' => [ + 'title' => 'free tier属性', + 'type' => 'object', + 'properties' => [ + 'IsFreeTierUser' => [ + 'title' => '是否是free tier用户', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StartTime' => [ + 'title' => 'free tier开始时间', + 'type' => 'string', + 'example' => '2020-11-08T15:00:00Z', + ], + 'EndTime' => [ + 'title' => 'free tier结束时间', + 'type' => 'string', + 'example' => '2020-11-08T15:00:00Z', + ], + 'Status' => [ + 'title' => 'free tier状态,有效或者无效', + 'type' => 'string', + 'example' => 'valid', + ], + 'InitBaseValue' => [ + 'title' => 'free tier，资源初始值', + 'type' => 'number', + 'format' => 'double', + 'example' => '5000', + ], + 'InitShowValue' => [ + 'title' => 'free tier，资源初始显示值', + 'type' => 'string', + 'example' => '5000', + ], + 'InitBaseUnit' => [ + 'title' => 'free tier，资源初始值单位', + 'type' => 'string', + 'example' => '个', + ], + 'InitShowUnit' => [ + 'title' => 'free tier，资源初始显示单位', + 'type' => 'string', + 'example' => '个', + ], + 'PeriodBaseValue' => [ + 'title' => 'free tier，资源当前值', + 'type' => 'number', + 'format' => 'double', + 'example' => '3000', + ], + 'PeriodShowValue' => [ + 'title' => 'free tier，资源当前显示值', + 'type' => 'string', + 'example' => '3000', + ], + 'PeriodBaseUnit' => [ + 'title' => 'free tier，资源当前值单位', + 'type' => 'string', + 'example' => '个', + ], + 'PeriodShowUnit' => [ + 'title' => 'free tier, 资源当前显示单位', + 'type' => 'string', + 'example' => '个', + ], + ], + ], + 'EnableEciDisk' => [ + 'title' => '是否打开eciDisk', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'title' => '请求Id', + 'description' => '', + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => '', + 'type' => 'string', + 'example' => '"Access denied"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'HttpStatusCode' => [ + 'title' => 'http状态码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'null', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccountSufficient\\": false,\\n \\"FreeTierSpecAvailable\\": true,\\n \\"FreeTier\\": {\\n \\"IsFreeTierUser\\": true,\\n \\"StartTime\\": \\"2020-11-08T15:00:00Z\\",\\n \\"EndTime\\": \\"2020-11-08T15:00:00Z\\",\\n \\"Status\\": \\"valid\\",\\n \\"InitBaseValue\\": 5000,\\n \\"InitShowValue\\": \\"5000\\",\\n \\"InitBaseUnit\\": \\"个\\",\\n \\"InitShowUnit\\": \\"个\\",\\n \\"PeriodBaseValue\\": 3000,\\n \\"PeriodShowValue\\": \\"3000\\",\\n \\"PeriodBaseUnit\\": \\"个\\",\\n \\"PeriodShowUnit\\": \\"个\\"\\n },\\n \\"EnableEciDisk\\": true,\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"Access denied\\\\\\"\\",\\n \\"Code\\": \\"null\\",\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + ], + 'CreateDiagnosis' => [ + 'summary' => '诊断问题', + 'path' => '/api/v2/diagnoses', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195184', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '分享信息', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'title' => '分享文件名称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'dsw-5bk19******n97w', + ], + 'ProblemCategory' => [ + 'title' => '分享文件版本', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'InstanceStartFailed', + ], + 'GmtFailureTime' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'required' => false, + 'example' => '2021-01-12T14:36:01Z', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '分享结果', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ReasonCode' => [ + 'title' => '分享文件名称', + 'description' => '', + 'type' => 'string', + 'example' => 'Resource.InsufficientResource', + ], + 'SolutionMessage' => [ + 'title' => '分享文件版本', + 'description' => '', + 'type' => 'string', + 'example' => 'Switch resource config', + ], + 'ReasonMessage' => [ + 'title' => '分享资源链接', + 'description' => '', + 'type' => 'string', + 'example' => 'Insufficient resource', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ReasonCode\\": \\"Resource.InsufficientResource\\",\\n \\"SolutionMessage\\": \\"Switch resource config\\",\\n \\"ReasonMessage\\": \\"Insufficient resource\\"\\n}","type":"json"}]', + ], + 'GetToken' => [ + 'summary' => 'Obtains the temporary authentication information of a DSW instance.', + 'path' => '/api/v2/tokens', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '147022', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'ExpireTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'Access', + 'default' => 'Access', + 'enum' => [ + 'Access', + 'View', + ], + ], + ], + [ + 'name' => 'Audience', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'Aliyun', + 'default' => 'Aliyun', + 'enum' => [ + 'Aliyun', + 'ThirdParty', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'TokenResult', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求Id', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7D55162-4489-1619-AAF5-3F97D5FCA948', + ], + 'Success' => [ + 'title' => '成功标志', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'Message' => [ + 'title' => '说明', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => '"XXX"', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'The status code. Valid values:'."\n" + ."\n" + .'* InternalError: All errors, except for parameter validation errors, are internal errors.'."\n" + .'* ValidationError: A parameter validation error.'."\n", + 'type' => 'string', + 'example' => 'ValidationError', + ], + 'Token' => [ + 'title' => 'token', + 'description' => 'The temporary authentication information of the DSW instance.'."\n", + 'type' => 'string', + 'example' => '*******', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7D55162-4489-1619-AAF5-3F97D5FCA948\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"\\\\\\"XXX\\\\\\"\\",\\n \\"Code\\": \\"ValidationError\\",\\n \\"Token\\": \\"*******\\"\\n}","type":"json"}]', + 'title' => 'GetToken', + ], + 'GetMetrics' => [ + 'summary' => '获取metrics数据', + 'path' => '/api/v2/instance/{InstanceId}/cms/metrics', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '223121', + 'abilityTreeNodes' => [ + 'FEATURElearnTBR2KU', + ], + ], + 'parameters' => [ + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'acs_pai_dsw', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'dsw-328d2bbf605*****', + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"userId":"16122852825*****","jobId":"dsw-328d2bbf605*****","regionId":"cn-wulanchabu","pod":"dsw-45680-76766f8778-95gxh"}', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-08T16:00:00Z', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCE_SPEC_MEMORY_SWAP', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2020-11-08T15:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Datapoints' => [ + 'type' => 'string', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Succeed', + ], + 'Period' => [ + 'description' => '', + 'type' => 'string', + 'example' => '60', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****\\",\\n \\"Success\\": true,\\n \\"Datapoints\\": \\"[{\'timestamp\': 1740452220000, \'jobId\': \'dsw-94ed9f9********\', \'pod\': \'dsw-871***-764fdf******\', \'regionId\': \'cn-hangzhou\', \'userId\': \'1042612********\', \'workspaceId\': \'1445***\', \'Value\': 0.0}]\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Succeed\\",\\n \\"Period\\": \\"60\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","type":"json"}]', + ], + 'GetUserCommand' => [ + 'summary' => 'Get the user defined command', + 'path' => '/api/v2/usercommands/{UserCommandId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'consumes' => [], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '273001', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'UserCommandId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1900', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Token', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'UserCommandId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1900', + ], + 'OnStart' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'apt update', + ], + ], + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ValidationError', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BEBDF2EE-642E-5992-8907-D2011A7ACEFE', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'accessDeniedDetail' => [ + 'description' => '', + 'type' => 'object', + 'example' => '"AccessDeniedDetail": {'."\n" + .' "PolicyType": "AccountLevelIdentityBasedPolicy",'."\n" + .' "AuthPrincipalOwnerId": "xxx",'."\n" + .' "EncodedDiagnosticMessage": "AQIBIAAAA....bwhg==",'."\n" + .' "AuthPrincipalType": "SubUser",'."\n" + .' "AuthPrincipalDisplayName": "xxx",'."\n" + .' "NoPermissionType": "ImplicitDeny",'."\n" + .' "AuthAction": "ram:GetUserCommand"'."\n" + .' }', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UserCommandId\\": \\"1900\\",\\n \\"OnStart\\": {\\n \\"Content\\": \\"apt update\\"\\n },\\n \\"Message\\": \\"null\\",\\n \\"Code\\": \\"ValidationError\\",\\n \\"RequestId\\": \\"BEBDF2EE-642E-5992-8907-D2011A7ACEFE\\",\\n \\"Success\\": true,\\n \\"accessDeniedDetail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]', + ], + 'ListSystemLogs' => [ + 'summary' => '获取系统日志', + 'path' => '/api/v2/systemlogs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254265', + 'abilityTreeNodes' => [ + 'FEATURElearnQHG7ZB', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'dsw-730xxxxxxxxxx', + ], + ], + [ + 'name' => 'SourceRequestId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '473469C7-******5-B3DB-A3DC0DE3C83E', + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'GmtCreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + ], + ], + [ + 'name' => 'LogRepository', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'LogLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Error', + ], + ], + [ + 'name' => 'GmtStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'required' => false, + 'example' => '2020-11-08T16:00:00Z', + ], + ], + [ + 'name' => 'GmtEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'required' => false, + 'example' => '2020-12-08T16:00:00Z', + ], + ], + [ + 'name' => 'ProblemCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'InstanceStartFailed', + ], + ], + [ + 'name' => 'LifecycleId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ECS规格列表', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SystemLogs' => [ + 'title' => '本分页中请求的实例列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'title' => '实例规格', + 'description' => '', + 'type' => 'string', + 'example' => 'You are using******', + ], + 'GmtCreateTime' => [ + 'title' => '显卡类型', + 'description' => '', + 'type' => 'string', + 'format' => 'iso8601_normal', + 'example' => '2020-10-08T16:00:00Z'."\n", + ], + 'Level' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Error。', + ], + ], + ], + ], + 'Offset' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SystemLogs\\": [\\n {\\n \\"Content\\": \\"You are using******\\",\\n \\"GmtCreateTime\\": \\"2020-10-08T16:00:00Z\\\\n\\",\\n \\"Level\\": \\"Error。\\"\\n }\\n ],\\n \\"Offset\\": \\"\\"\\n}","type":"json"}]', + ], + 'GetSanityCheckTask' => [ + 'summary' => '查询健康检查任务结果', + 'path' => '/api/v2/sanitychecks/{CheckType}/{TaskId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckType', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SSH', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '917479ff-c869-49ea-908e-ae85bd987bc0'."\n", + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '44FB0869-AA85-599D-A09D-C42F7467618A', + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '917479ff-c869-49ea-908e-ae85bd987bc0', + ], + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dsw-730xxxxxxxxxx', + ], + 'CheckType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SSH', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Executing', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-08T15:00:00Z', + ], + 'EndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2020-11-08T15:00:00Z', + ], + 'Issues' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => '[ "Port 22 is blocked by the security group." , "sshd has not been installed"]', + ], + ], + 'CheckDetails' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'secureGroupCheck', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Check whether the security group allows traffic on port 22', + ], + 'Result' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'passed', + ], + 'Reason' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Port 22 is blocked by the security group', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"44FB0869-AA85-599D-A09D-C42F7467618A\\",\\n \\"TaskId\\": \\"917479ff-c869-49ea-908e-ae85bd987bc0\\",\\n \\"InstanceId\\": \\"dsw-730xxxxxxxxxx\\",\\n \\"CheckType\\": \\"SSH\\",\\n \\"Status\\": \\"Executing\\",\\n \\"StartTime\\": \\"2020-11-08T15:00:00Z\\",\\n \\"EndTime\\": \\"2020-11-08T15:00:00Z\\",\\n \\"Issues\\": [\\n \\"sshd has not been installed\\\\\\"\\"\\n ],\\n \\"CheckDetails\\": [\\n {\\n \\"Name\\": \\"secureGroupCheck\\",\\n \\"Description\\": \\"Check whether the security group allows traffic on port 22\\",\\n \\"Result\\": \\"passed\\",\\n \\"Reason\\": \\"Port 22 is blocked by the security group\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'CreateSanityCheckTask' => [ + 'summary' => '创建一个健康检查任务', + 'path' => '/api/v2/sanitychecks/{CheckType}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATURElearnRNGD0R', + ], + ], + 'parameters' => [ + [ + 'name' => 'CheckType', + 'in' => 'path', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'SSH', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'dsw-730xxxxxxxxxx'."\n", + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BEBDF2EE-642E-5992-8907-D2011A7ACEFE'."\n", + ], + 'TaskId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '917479ff-c869-49ea-908e-ae85bd987bc0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BEBDF2EE-642E-5992-8907-D2011A7ACEFE\\\\n\\",\\n \\"TaskId\\": \\"917479ff-c869-49ea-908e-ae85bd987bc0\\"\\n}","type":"json"}]', + ], + ], + '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', + ], + ], +]; |