diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/ehpc/2018-04-12 | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/ehpc/2018-04-12')
| -rw-r--r-- | data/en_us/ehpc/2018-04-12/api-docs.php | 27386 |
1 files changed, 27386 insertions, 0 deletions
diff --git a/data/en_us/ehpc/2018-04-12/api-docs.php b/data/en_us/ehpc/2018-04-12/api-docs.php new file mode 100644 index 0000000..bcdcc2f --- /dev/null +++ b/data/en_us/ehpc/2018-04-12/api-docs.php @@ -0,0 +1,27386 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'EHPC', + 'version' => '2018-04-12', + ], + 'directories' => [ + [ + 'id' => 181976, + 'title' => 'Clusters', + 'type' => 'directory', + 'children' => [ + 'DescribePrice', + 'CreateCluster', + 'DescribeCluster', + 'ModifyClusterAttributes', + 'ListClusters', + 'ListClustersMeta', + 'StartCluster', + 'StopCluster', + 'RecoverCluster', + 'DeleteCluster', + ], + ], + [ + 'id' => 181434, + 'title' => 'Hybrid cloud clusters', + 'type' => 'directory', + 'children' => [ + 'CreateHybridCluster', + 'AddLocalNodes', + 'GetHybridClusterConfig', + 'SyncUsers', + ], + ], + [ + 'id' => 181509, + 'title' => 'ECS instances', + 'type' => 'directory', + 'children' => [ + 'ListPreferredEcsTypes', + 'ListAvailableEcsTypes', + 'GetIfEcsTypeSupportHtConfig', + ], + ], + [ + 'id' => 62742, + 'title' => 'Image', + 'type' => 'directory', + 'children' => [ + 'ListImages', + 'ListCustomImages', + 'ListCommunityImages', + 'DescribeImagePrice', + ], + ], + [ + 'id' => 62758, + 'title' => 'User', + 'type' => 'directory', + 'children' => [ + 'AddUsers', + 'ListUsers', + 'ListUsersAsync', + 'ModifyUserGroups', + 'ModifyUserPasswords', + 'DeleteUsers', + ], + ], + [ + 'id' => 62714, + 'title' => 'Nodes', + 'type' => 'directory', + 'children' => [ + 'AddNodes', + 'ApplyNodes', + 'AddExistedNodes', + 'ListNodes', + 'ListNodesNoPaging', + 'StartNodes', + 'StopNodes', + 'ResetNodes', + 'DeleteNodes', + ], + ], + [ + 'id' => 181435, + 'title' => 'Queues', + 'type' => 'directory', + 'children' => [ + 'AddQueue', + 'ListQueues', + 'UpdateQueueConfig', + 'ListNodesByQueue', + 'SetQueue', + 'DeleteQueue', + ], + ], + [ + 'id' => 181510, + 'title' => 'Schedulers', + 'type' => 'directory', + 'children' => [ + 'SetSchedulerInfo', + 'GetSchedulerInfo', + ], + ], + [ + 'id' => 181437, + 'title' => 'Software', + 'type' => 'directory', + 'children' => [ + 'ListSoftwares', + 'InstallSoftware', + 'ListInstalledSoftware', + 'UninstallSoftware', + ], + ], + [ + 'id' => 62709, + 'title' => 'Storage', + 'type' => 'directory', + 'children' => [ + 'ListFileSystemWithMountTargets', + 'ListCpfsFileSystems', + 'GetClusterVolumes', + 'ListVolumes', + 'UpdateClusterVolumes', + ], + ], + [ + 'id' => 62693, + 'title' => 'Job', + 'type' => 'directory', + 'children' => [ + 'SubmitJob', + 'CreateJobFile', + 'ListJobs', + 'DescribeJob', + 'ListJobsWithFilters', + 'RerunJobs', + 'StopJobs', + 'GetJobLog', + 'DeleteJobs', + ], + ], + [ + 'id' => 190861, + 'title' => 'Serverless Job', + 'type' => 'directory', + 'children' => [ + 'SubmitServerlessJob', + 'ListServerlessJobs', + 'DescribeServerlessJobs', + 'StopServerlessJobs', + ], + ], + [ + 'id' => 62769, + 'title' => 'Job template', + 'type' => 'directory', + 'children' => [ + 'CreateJobTemplate', + 'ListJobTemplates', + 'EditJobTemplate', + 'DeleteJobTemplates', + ], + ], + [ + 'id' => 62737, + 'title' => 'Interactive commands', + 'type' => 'directory', + 'children' => [ + 'InvokeShellCommand', + 'ListCommands', + 'ListInvocationResults', + 'ListInvocationStatus', + ], + ], + [ + 'id' => 181511, + 'title' => 'Post-processing script', + 'type' => 'directory', + 'children' => [ + 'SetPostScripts', + 'GetPostScripts', + ], + ], + [ + 'id' => 62731, + 'title' => 'VNC', + 'type' => 'directory', + 'children' => [ + 'GetVisualServiceStatus', + 'ModifyVisualServicePasswd', + 'StartVisualService', + 'StopVisualService', + ], + ], + [ + 'id' => 62705, + 'title' => 'Autoscaling', + 'type' => 'directory', + 'children' => [ + 'SetAutoScaleConfig', + 'DescribeAutoScaleConfig', + 'GetAutoScaleConfig', + ], + ], + [ + 'id' => 181439, + 'title' => 'Performance management', + 'type' => 'directory', + 'children' => [ + 'RunCloudMetricProfiling', + 'GetCloudMetricProfiling', + 'ListCloudMetricProfilings', + 'GetCloudMetricLogs', + ], + ], + [ + 'id' => 62772, + 'title' => 'Report', + 'type' => 'directory', + 'children' => [ + 'GetAccountingReport', + ], + ], + [ + 'id' => 62728, + 'title' => 'Operation log', + 'type' => 'directory', + 'children' => [ + 'ListClusterLogs', + ], + ], + [ + 'id' => 181438, + 'title' => 'Cluster client', + 'type' => 'directory', + 'children' => [ + 'ListCurrentClientVersion', + 'UpgradeClient', + 'ListUpgradeClients', + ], + ], + [ + 'id' => 62726, + 'title' => 'Service pack', + 'type' => 'directory', + 'children' => [ + 'QueryServicePackAndPrice', + ], + ], + [ + 'id' => 62754, + 'title' => 'Security groups', + 'type' => 'directory', + 'children' => [ + 'AddSecurityGroup', + 'ListSecurityGroups', + 'DeleteSecurityGroup', + ], + ], + [ + 'id' => 181515, + 'title' => 'Tag', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'ListTagResources', + 'UnTagResources', + ], + ], + [ + 'id' => 62673, + 'title' => 'Region', + 'type' => 'directory', + 'children' => [ + 'ListRegions', + ], + ], + [ + 'id' => 181440, + 'title' => 'Others', + 'type' => 'directory', + 'children' => [ + 'ListTasks', + 'InitializeEHPC', + ], + ], + [ + 'id' => 203958, + 'title' => 'Abandoned', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 181436, + 'title' => 'Container application', + 'type' => 'directory', + 'children' => [], + ], + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribePrice' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PriceUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing cycle of the Elastic Compute Service (ECS) instances. This parameter takes effect only when the ChargeType parameter is set to PrePaid. Valid values:'."\n" + ."\n" + .'* Month: pay-by-month'."\n" + .'* Year: pay-by-year'."\n" + .'* Hour: pay-by-hour'."\n" + ."\n" + .'Default value: Hour.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Hour', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the ECS instances. Valid values:'."\n" + ."\n" + .'* PostPaid: pay-as-you-go'."\n" + .'* PrePaid: subscription'."\n" + ."\n" + .'Default value: PostPaid.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the order. The order can be set only as a purchase order. Valid value: INSTANCE-BUY.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCE-BUY', + ], + ], + [ + 'name' => 'Commodities', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the service.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Amount' => [ + 'description' => 'The node quantity of the type. Valid values: 1 to 1000.'."\n" + ."\n" + .'Default value: 1.'."\n" + ."\n" + .'Valid values of N: 1 to 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + ], + 'SystemDiskSize' => [ + 'description' => 'The system disk size of the node. Unit: GB.'."\n" + ."\n" + .'Valid values: 40 to 500.'."\n" + ."\n" + .'Default value: 40.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + 'SystemDiskPerformanceLevel' => [ + 'description' => 'The performance level of the ESSD used as the system disk. This parameter takes effect only when the Commodities.N.SystemDiskCategory parameter is set to cloud_essd. Valid values:'."\n" + ."\n" + .'* PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: A single ESSD can deliver up to 50,000 IOPS of random read/write.'."\n" + .'* PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'Default value: PL1.'."\n" + ."\n" + .'Valid values of N: 1 to 10'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'NodeType' => [ + 'description' => 'The type of the node. Valid values:'."\n" + ."\n" + .'* Compute: compute node'."\n" + .'* Manager: management node'."\n" + .'* Login: logon node'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Compute', + ], + 'SystemDiskCategory' => [ + 'description' => 'The system disk type of the node. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: ESSD'."\n" + .'* cloud: basic disk'."\n" + ."\n" + .'Default value: cloud_efficiency'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + 'InternetChargeType' => [ + 'description' => 'The EIP billing method of the node. Valid values:'."\n" + ."\n" + .'* PayByBandwidth: pay-by-bandwidth'."\n" + .'* PayByTraffic: pay-by-traffic'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PayByBandwidth', + ], + 'NetworkType' => [ + 'description' => 'The network type of the node. Valid value: VPC.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the node.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ecs.n1.tiny', + ], + 'Period' => [ + 'description' => 'The subscription duration of the node. Valid values:'."\n" + ."\n" + .'* If PriceUnit is set to Year, the valid values of the Period parameter are 1, 2, and 3.'."\n" + .'* If PriceUnit is set to Month, the valid values of the Period parameter are 1, 2, 3, 4, 5, 6, 7, 8, and 9.'."\n" + .'* If PriceUnit is set to Hour, the valid value of the Period parameter is 1.'."\n" + ."\n" + .'Default value: 1.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + 'InternetMaxBandWidthOut' => [ + 'description' => 'The maximum outbound public bandwidth of the node. Unit: Mbit/s.'."\n" + ."\n" + .'Valid values: 0 to 100.'."\n" + ."\n" + .'Default value: 0.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'DataDisks' => [ + 'description' => 'The list of data disks.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'size' => [ + 'description' => 'The size of the data disk. Unit: GB.'."\n" + ."\n" + .'Valid values: 40 to 500.'."\n" + ."\n" + .'Default value: 40.'."\n" + ."\n" + .'Valid values of N: 0 to 4.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + 'category' => [ + 'description' => 'The type of the data disk. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: ESSD'."\n" + .'* cloud: basic disk'."\n" + ."\n" + .'Default value: cloud_efficiency.'."\n" + ."\n" + .'Valid values of N: 0 to 4.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_efficiency', + ], + 'deleteWithInstance' => [ + 'description' => 'Specifies whether the data disk is released when the node is released. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: true.'."\n" + ."\n" + .'Valid values of N: 0 to 4.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'performanceLevel' => [ + 'description' => 'The performance level of the ESSD used as the data disk. This parameter takes effect only when the Commodities.N.DataDisks.N.category parameter is set to cloud_essd. Valid values:'."\n" + ."\n" + .'* PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: A single ESSD can deliver up to 50,000 IOPS of random read/write.'."\n" + .'* PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'Default value: PL1.'."\n" + ."\n" + .'Valid values of N: 0 to 4.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'encrypted' => [ + 'description' => 'Specifies whether to encrypt the data disk. Valid values:'."\n" + ."\n" + .'* true: encrypts the data disk.'."\n" + .'* false: does not encrypt the data disk.'."\n" + ."\n" + .'Default value: false.'."\n" + ."\n" + .'Valid values of N: 0 to 4.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 4, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 2500, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalTradePrice' => [ + 'description' => 'The total price.'."\n" + ."\n" + .'Unit: USD.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1258', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '54FF9025-2C2F-42EB-870D-0DF5B0ACF24E', + ], + 'Prices' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PriceInfo' => [ + 'description' => 'The array of cluster prices. If you query the prices of multiple nodes in the cluster, the sequence of the prices in the returned value of PriceInfo is the same as the sequence of the nodes in the request parameters. For example, the first price in the value of PriceInfo is the price of the first node specified in the request parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OriginalPrice' => [ + 'description' => 'The original price.'."\n" + ."\n" + .'Unit: USD.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1258', + ], + 'NodeType' => [ + 'description' => 'The node type. Valid values:'."\n" + ."\n" + .'* Manager: management node'."\n" + .'* Login: logon node'."\n" + .'* Compute: compute node'."\n", + 'type' => 'string', + 'example' => 'Compute', + ], + 'Currency' => [ + 'description' => 'The currency that is used to measure the price. Valid values:'."\n" + ."\n" + .'USD'."\n", + 'type' => 'string', + 'example' => 'USD', + ], + 'TradePrice' => [ + 'description' => 'The final price.'."\n" + ."\n" + .'Unit: USD.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1258', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'The role does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalTradePrice\\": 1258,\\n \\"RequestId\\": \\"54FF9025-2C2F-42EB-870D-0DF5B0ACF24E\\",\\n \\"Prices\\": {\\n \\"PriceInfo\\": [\\n {\\n \\"OriginalPrice\\": 1258,\\n \\"NodeType\\": \\"Compute\\",\\n \\"Currency\\": \\"<props=\\\\\\"china\\\\\\">CNY</props>\\\\n\\\\n<props=\\\\\\"intl\\\\\\">USD</props>\\",\\n \\"TradePrice\\": 1258\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribePriceResponse>\\n <Prices>\\n <PriceInfo>\\n <OriginalPrice>1258</OriginalPrice>\\n <TradePrice>1258</TradePrice>\\n <Currency>CNY</Currency>\\n <NodeType>Compute</NodeType>\\n </PriceInfo>\\n </Prices>\\n <TotalTradePrice>1258</TotalTradePrice>\\n <RequestId>54FF9025-2C2F-42EB-870D-0DF5B0ACF24E</RequestId>\\n</DescribePriceResponse> ","errorExample":""}]', + 'title' => 'DescribePrice', + 'summary' => 'Queries the pricing information of a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCluster' => [ + 'summary' => 'Creates a pay-as-you-go or subscription E-HPC cluster.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone in which the resource resides.'."\n" + ."\n" + .'You can call the [ListRegions](~~188593~~) and [DescribeZones](~~25610~~) operations to query the IDs of the zones where E-HPC is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the E-HPC cluster. The name must be 2 to 64 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the E-HPC cluster. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.', + 'type' => 'string', + 'required' => false, + 'example' => 'TestDescription', + ], + ], + [ + 'name' => 'EhpcVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of E-HPC. By default, the parameter is set to the latest version number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the E-HPC client. By default, the parameter is set to the latest version number.'."\n" + ."\n" + .'You can call the [ListCurrentClientVersion](~~87223~~) operation to query the latest version of the E-HPC client.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0.64', + ], + ], + [ + 'name' => 'OsTag', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operating system tag of the image.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the domain account service. Valid values:'."\n" + ."\n" + .'* nis'."\n" + .'* ldap'."\n" + ."\n" + .'Default value: nis.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nis', + 'default' => 'nis', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The domain name of the on-premises E-HPC cluster.'."\n" + ."\n" + .'This parameter takes effect only when the AccountType parameter is set to Idap.', + 'type' => 'string', + 'required' => false, + 'example' => 'ldap', + ], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the scheduler. Valid values:'."\n" + ."\n" + .'* pbs'."\n" + .'* slurm'."\n" + .'* opengridscheduler'."\n" + .'* deadline'."\n" + ."\n" + .'Default value: pbs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pbs', + 'default' => 'pbs', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the security group to which the E-HPC cluster belongs.'."\n" + ."\n" + .'You can call the [DescribeSecurityGroups](~~25556~~) operation to query available security groups in the current region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp13n61xsydodfyg****', + ], + ], + [ + 'name' => 'SecurityGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'If you do not use an existing security group, set the parameter to the name of a new security group. A default policy is applied to the new security group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-SecurityGroup', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the E-HPC cluster belongs.'."\n" + ."\n" + .'You can call the [DescribeVpcs](~~35739~~) operation to query available VPCs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-b3f3edefefeep0760yju****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vSwitch ID. E-HPC supports only VPC networks.'."\n" + ."\n" + .'You can call the [DescribeVSwitches](~~35748~~) operation to query available vSwitches.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + ], + [ + 'name' => 'VolumeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the shared storage. Set the value to `nas`, which indicates NAS file system.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nas', + 'default' => 'nas', + ], + ], + [ + 'name' => 'VolumeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the NAS file system. If you leave the parameter empty, a Performance NAS file system is created by default.'."\n" + ."\n" + .'You can call the [ListFileSystemWithMountTargets](~~204364~~) operation to query available mount targets.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '008b64****', + ], + ], + [ + 'name' => 'VolumeProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the protocol that is used by the NAS file system. Valid values:'."\n" + ."\n" + .'* NFS'."\n" + .'* SMB'."\n" + ."\n" + .'Default value: NFS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NFS', + 'default' => 'nfs', + ], + ], + [ + 'name' => 'VolumeMountpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mount target of the NAS file system. The mount target is of the VPC type. Take note of the following information:'."\n" + ."\n" + .'* If the VolumeId parameter is not specified, you can leave the VolumeMountpoint parameter empty. In this case, a mount target is created by default.'."\n" + .'* When the VolumeId parameter is specified, the VolumeMountpoint parameter is required. You can call the [ListFileSystemWithMountTargets](~~204364~~) operation to query available mount targets.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com', + ], + ], + [ + 'name' => 'VolumeMountOption', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mount options of the NFS file system that you want to mount by running the mount command.'."\n" + ."\n" + .'For more information, see [Mount an NFS file system on a Linux ECS instance](https://www.alibabacloud.com/help/en/nas/latest/mount-an-nfs-file-system-on-a-linux-ecs-instance#section-jyi-hyd-hbr).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-t nfs -o vers=4', + ], + ], + [ + 'name' => 'RemoteDirectory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The remote directory to which the NAS file system is mounted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NasMountpoint:/RemoteDirectory', + ], + ], + [ + 'name' => 'DeployMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode in which the E-HPC cluster is deployed. Valid values:'."\n" + ."\n" + .'* Standard: An account node, a scheduling node, a logon node, and multiple compute nodes are separately deployed.'."\n" + .'* Simple: A management node, which consists of an account node and a scheduling node, is deployed, while a logon node and multiple compute nodes are separately deployed.'."\n" + .'* Tiny: A management node and multiple compute nodes are deployed. The management node consists of an account node, a scheduling node, and a logon node. The compute nodes are separately deployed.'."\n" + ."\n" + .'Default value: Standard.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Simple', + ], + ], + [ + 'name' => 'HaEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the high availability feature. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n" + ."\n" + .'> If high availability is enabled, a primary management node and a secondary management node are used.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'EcsChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the nodes. Valid values:'."\n" + ."\n" + .'* PostPaid: pay-as-you-go.'."\n" + .'* PrePaid: subscription.'."\n" + ."\n" + .'If you set the parameter to PrePaid, auto-renewal is enabled by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'default' => 'PostPaid', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The root password of the logon node. The password must be 8 to 30 characters in length and contain at least three of the following items: uppercase letters, lowercase letters, digits, and special characters. Special characters include:'."\n" + ."\n" + .'`( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ‘ < > , . ? /`'."\n" + ."\n" + .'You must specify either Password or KeyPairName. If both are specified, the Password parameter prevails.'."\n" + ."\n" + .'> We recommend that you use HTTPS to call the API operation to prevent password leakage.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123****', + ], + ], + [ + 'name' => 'KeyPairName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the key pair.'."\n" + ."\n" + .'> For more information, see [Create an SSH key pair](~~51793~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the image. Valid values:'."\n" + ."\n" + .'* system: public image'."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n" + ."\n" + .'Default value: system.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'self', + 'default' => 'system', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image IDs.'."\n" + ."\n" + .'You can call the [ListImages](~~87213~~) and [ListCustomImages](~~87215~~) operations to query the images that are supported by E-HPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_02_64_20G_alibase_20170818****', + ], + ], + [ + 'name' => 'EcsOrder.Manager.Count', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the management nodes. Valid values: 1 and 2.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EcsOrder.Manager.InstanceType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => 'The instance type of the management nodes.'."\n" + ."\n" + .'You can call the [ListPreferredEcsTypes](~~188592~~) operation to query the recommended instance types.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'EcsOrder.Compute.Count', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of compute nodes in the cluster. Valid values: 0 to 99.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'EcsOrder.Compute.InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the compute nodes.'."\n" + ."\n" + .'You can call the [ListPreferredEcsTypes](~~188592~~) operation to query the recommended instance types.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'EcsOrder.Login.Count', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the logon nodes. Valid value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'EcsOrder.Login.InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the logon nodes.'."\n" + ."\n" + .'You can call the [ListPreferredEcsTypes](~~188592~~) operation to query the recommended instance types.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'SccClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Super Computing Cluster (SCC) instance ID.'."\n" + ."\n" + .'If you specify the parameter, the SCC instance is moved to a new SCC cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '00b648b****', + ], + ], + [ + 'name' => 'ComputeSpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The bidding method of the compute nodes. Valid values:'."\n" + ."\n" + .'* NoSpot: The compute nodes are pay-as-you-go instances.'."\n" + .'* SpotWithPriceLimit: The compute nodes are preemptible instances that have a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + ], + [ + 'name' => 'ComputeSpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum hourly price of the compute nodes. A maximum of three decimal places can be used in the value of the parameter. The parameter is valid only when the ComputeSpotStrategy parameter is set to SpotWithPriceLimit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0.034', + ], + ], + [ + 'name' => 'ComputeEnableHt', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable hyper-threading for the compute node. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The duration of the subscription. The unit of the duration is specified by the `PeriodUnit` parameter.'."\n" + ."\n" + .'* Valid values if PriceUnit is set to Year: 1, 2, and 3.'."\n" + .'* Valid values if PriceUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, and 9.'."\n" + .'* Valid value if PriceUnit is set to Hour: 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the subscription duration. Valid values:'."\n" + ."\n" + .'* Year'."\n" + .'* Month'."\n" + .'* Hour'."\n" + ."\n" + .'Default value: Month.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The auto-renewal period of the subscription compute nodes. The parameter takes effect when AutoRenew is set to true.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'InputFileUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the job file that is uploaded to an Object Storage Service (OSS) bucket.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://ehpc-tianshui.oss-cn-beijing.aliyuncs.com/test-u****/testlist_ehpc.sh', + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The queue to which the compute nodes are added.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'SystemDiskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the system disk. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: enhanced SSD (ESSD)'."\n" + .'* cloud: basic disk. Disks of this type are retired.'."\n" + ."\n" + .'Default value: cloud_ssd.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + ], + [ + 'name' => 'SystemDiskSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The system disk size. Unit: GB.'."\n" + ."\n" + .'Valid values: 40 to 500.'."\n" + ."\n" + .'Default value: 40.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + ], + [ + 'name' => 'RemoteVisEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable Virtual Network Computing (VNC). Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n" + ."\n" + .'You can call the [ListResourceGroups](~~158855~~) operation to obtain the ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxazb4ph****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but make sure that the value is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'WithoutElasticIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the logon node uses an elastic IP address (EIP). Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'SystemDiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance level of the ESSD to be used as the system disk. Default value: PL1. Valid values:'."\n" + ."\n" + .'* PL0: An ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: An ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: An ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: An ESSD delivers up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'Default value: PL1.'."\n" + ."\n" + .'For more information, see [ESSDs](~~122389~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL0', + ], + ], + [ + 'name' => 'IsComputeEss', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto scaling. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the E-HPC cluster.'."\n" + ."\n" + .'Default value: 1.0.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0', + ], + ], + [ + 'name' => 'Application', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The application information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'description' => 'The tag of the software.'."\n" + ."\n" + .'Valid values of N: 0 to 100.'."\n" + ."\n" + .'You can call the [ListSoftwares](~~87216~~) operation to query the tag of the software.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OpenMPI_11.1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AdditionalVolumes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information of the NAS file system.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'JobQueue' => [ + 'description' => 'The queue of the nodes to which the NAS file system is attached.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + 'VolumeId' => [ + 'description' => 'The ID of the NAS file system.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'extreme-00b88****', + ], + 'Roles' => [ + 'description' => 'The node information to which the NAS file system is attached.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The type of the nodes to which the NAS file system is attached.'."\n" + ."\n" + .'Valid values of N in AdditionalVolumes.N.Roles: 1 to 10'."\n" + ."\n" + .'Valid values of N in Roles.N.Name: 0 to 8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["Compute"]', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 8, + ], + 'VolumeMountpoint' => [ + 'description' => 'The mount target of the NAS file system.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0088****-sihc.cn-hangzhou.extreme.nas.aliyuncs.com', + ], + 'VolumeMountOption' => [ + 'description' => 'The mount options of the NAS file system.'."\n" + ."\n" + .'You can specify 1 to 10 vCPUs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-t nfs -o vers=4.0', + ], + 'RemoteDirectory' => [ + 'description' => 'The remote directory to which the NAS file system is mounted.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'VolumeType' => [ + 'description' => 'The type of the additional shared storage. Only NAS file systems are supported.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nas', + ], + 'LocalDirectory' => [ + 'description' => 'The local directory on which the NAS file system is mounted.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/ff', + ], + 'VolumeProtocol' => [ + 'description' => 'The type of the protocol that is used by the NAS file system. Valid value:'."\n" + ."\n" + .'* NFS'."\n" + .'* SMB'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n" + ."\n" + .'Default value: NFS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NFS', + ], + 'Location' => [ + 'description' => 'The type of the E-HPC cluster. Set the value to PublicCloud.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PublicCloud', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PostInstallScript', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information of the post-installation script.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => 'The parameter that is used to run the script after the cluster is created.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bashfile.sh', + ], + 'Url' => [ + 'description' => 'The URL that is used to download the script after the E-HPC cluster is created.'."\n" + ."\n" + .'Valid values of N: 0 to 16'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/opt/job.sh', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'Plugin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode configurations of the plug-in. This parameter takes effect only when the SchedulerType parameter is set to custom.'."\n" + ."\n" + .'The value must be a JSON string. The parameter contains the following parameters: pluginMod, pluginLocalPath, and pluginOssPath.'."\n" + ."\n" + .'* pluginMod: the plug-in mode. The following modes are supported:'."\n" + ."\n" + .' * oss: The plug-in is downloaded and decompressed from OSS to a local path that is specified by the pluginLocalPath parameter.'."\n" + .' * image: By default, the plug-in is stored in a pre-defined local path that is specified by the pluginLocalPath parameter.'."\n" + ."\n" + .'* pluginLocalPath: the local path where the plug-in is stored. We recommend that you select a shared directory in oss mode and a non-shared directory in image mode.'."\n" + ."\n" + .'* pluginOssPath: the remote path where the plug-in is stored in OSS. This parameter takes effect only when the pluginMod parameter is set to oss.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"pluginMod": "oss","pluginLocalPath": "/opt/plugin","pluginOssPath": "https://bucket.oss-cn-hangzhou.aliyuncs.com/plugin/plugin.tgz"}', + ], + ], + [ + 'name' => 'WithoutAgent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether not to install the agent.'."\n" + ."\n" + .'* true: does not install the agent.'."\n" + .'* false: installs the agent.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'WithoutNas', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether to use NAS as a shared storage. Valid values:'."\n" + ."\n" + .'* true: does not use NAS.'."\n" + .'* false: use NAS.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false'."\n", + ], + ], + [ + 'name' => 'RamRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the Resource Access Management (RAM) role.'."\n" + ."\n" + .'You can call the [ListRoles](~~28713~~) operation provided by RAM to query the instance RAM roles that you created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testRamRoleName', + ], + ], + [ + 'name' => 'NetworkInterfaceTrafficMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The communication model of the ENI. Valid values:'."\n" + ."\n" + .'* Standard: The TCP communication mode is used.'."\n" + .'* HighPerformance: uses the remote direct memory access (RDMA) communication mode with the Elastic RDMA Interface (ERI) enabled.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'DeploymentSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the deployment set in which to deploy the instance. You can obtain the deployment set ID by calling the [DescribeDeploymentSets](~~91313~~) operation. Only the deployment sets that use low latency policy are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp1frxuzdg87zh4pzq****', + ], + ], + [ + 'name' => 'RamNodeTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The node of the RAM role.', + 'type' => 'array', + 'items' => [ + 'description' => 'The node of the RAM role.'."\n" + ."\n" + .'Valid values of N: 0 to 4'."\n" + ."\n" + .'* If the DeployMode parameter is set to Standard, the following values are valid: scheduler, account, login, and compute. Separate multiple values with commas (,).'."\n" + .'* If the DeployMode parameter is set to Simple, the following values are valid: manager, login, and compute. Separate multiple values with commas (,).'."\n" + .'* If the DeployMode parameter is set to Tiny, the following values are valid: manager and compute.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'manager', + ], + 'required' => false, + 'example' => 'Standard', + 'maxItems' => 5, + 'minItems' => 0, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => 'The array of the tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The array of the tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + 'example' => 'scheduler', + ], + 'required' => false, + 'maxItems' => 20, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'AddOns', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The custom component service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The component name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cromwell', + ], + 'Version' => [ + 'description' => 'The version number of the component.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '85', + ], + 'DeployMode' => [ + 'description' => 'The deployment mode. Valid values: local and ecs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'local', + ], + 'DBType' => [ + 'description' => 'The type of the database engine. Valid values: Mysql, and null.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Mysql', + ], + 'ConfigFile' => [ + 'description' => 'The path to the configuration file.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/addon/cromwell/cromwell.conf', + ], + 'Port' => [ + 'description' => 'The access port of the custom component.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '10000', + ], + 'DefaultStart' => [ + 'description' => 'Indicates whether to auto-start the custom component. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C084****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n" + ."\n" + .'> CreateCluster is an asynchronous operation. A response is returned if the request succeeds. However, this does not mean that a cluster is created. You can call the [ListTasks](~~268225~~) operation to query the result of the task.'."\n", + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C084****', + ], + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'OrderError.InsufficientBalance', + 'errorMessage' => 'The account balance is insufficient. Please add funds first and try again.', + ], + [ + 'errorCode' => 'OrderError.InstHasUnpaidOrder', + 'errorMessage' => 'Your account has an unpaid order.', + ], + [ + 'errorCode' => 'OrderError.Arrearage', + 'errorMessage' => 'Your account balance is less than CNY 100. Please add funds to your account and try again.', + ], + [ + 'errorCode' => 'OrderError.NoCard', + 'errorMessage' => 'No credit card is bound to your account.', + ], + [ + 'errorCode' => 'OrderError.InvalidPayMethod', + 'errorMessage' => 'No valid default payment method is specified for your account.', + ], + [ + 'errorCode' => 'OrderError.NoRealNameAuthentication', + 'errorMessage' => 'You have not completed the real name authentication.', + ], + [ + 'errorCode' => 'OrderError.NoRealNameRegistration', + 'errorMessage' => 'Real name registration is required for instances launched in mainland China.', + ], + [ + 'errorCode' => 'OrderError.UserProfileIncomplete', + 'errorMessage' => 'You have not completed your user profile.', + ], + [ + 'errorCode' => 'InvalidVpc', + 'errorMessage' => 'The specified VPC is invalid.', + ], + [ + 'errorCode' => 'InvalidVolume', + 'errorMessage' => 'The specified volume is invalid.', + ], + [ + 'errorCode' => 'InvalidSoftware', + 'errorMessage' => 'The specified software is not supported.', + ], + [ + 'errorCode' => 'InvalidVolumeProtocal', + 'errorMessage' => 'The specified volume protocol is invalid.', + ], + [ + 'errorCode' => 'InvalidVolumeMountpoint', + 'errorMessage' => 'The specified volume mount point is invalid.', + ], + [ + 'errorCode' => 'MissingParams', + 'errorMessage' => 'The %s parameter is required.', + ], + ], + 403 => [ + [ + 'errorCode' => 'TooManyClusters', + 'errorMessage' => 'The number of user clusters exceeds the quota.', + ], + [ + 'errorCode' => 'TooManyComputes', + 'errorMessage' => 'The number of computing nodes exceeds the quota.', + ], + [ + 'errorCode' => 'TooManyLogins', + 'errorMessage' => 'The maximum number of logged on nodes is exceeded.', + ], + [ + 'errorCode' => 'TooManyScc', + 'errorMessage' => 'The maximum number of SCC instances is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceeded.PrivateIpAddress', + 'errorMessage' => 'Insufficient private IP addresses in vSwitch: %s.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'ImageNotSupported', + 'errorMessage' => 'The specified image is not supported.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + [ + 'errorCode' => 'VolumeNotFound', + 'errorMessage' => 'The specified volume does not exist.', + ], + [ + 'errorCode' => 'VpcNotFound', + 'errorMessage' => 'The specified VPC does not exist.', + ], + [ + 'errorCode' => 'KeyPairNotFound', + 'errorMessage' => 'The specified KeyPair does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'NasError', + 'errorMessage' => 'NAS API request failed.', + ], + [ + 'errorCode' => 'NasServiceNotOpen', + 'errorMessage' => 'The NAS service is not activated.', + ], + [ + 'errorCode' => 'EipError', + 'errorMessage' => 'The EIP API request failed.', + ], + [ + 'errorCode' => 'OrderError', + 'errorMessage' => 'An order request error occurred.', + ], + [ + 'errorCode' => 'FailToGenId', + 'errorMessage' => 'Generating cluster ID failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AckError', + 'errorMessage' => 'An error occurred while calling the ACK API operation.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F6757FA4-8FED-4602-B7F5-3550C084****\\",\\n \\"TaskId\\": \\"F6757FA4-8FED-4602-B7F5-3550C084****\\",\\n \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateClusterResponse>\\n <TaskId>F6757FA4-8FED-4602-B7F5-3550C084****</TaskId>\\n <RequestId>F6757FA4-8FED-4602-B7F5-3550C084****</RequestId>\\n <ClusterId>ehpc-hz-FYUr32****</ClusterId>\\n</CreateClusterResponse>","errorExample":""}]', + 'title' => 'CreateCluster', + 'description' => 'After you create an Elastic High Performance Computing (E-HPC) cluster, you are charged for the cluster resources that you use. We recommend that you learn about the billing methods of E-HPC in advance. For more information, see [Billing overview](~~57844~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeCluster' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. You can call the [ListClusters](~~87116~~) operation to query the list of clusters in a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-QKKVqO****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ClusterInfo' => [ + 'description' => 'The information about the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the cluster. Valid values:'."\n" + ."\n" + .'* uninit: The cluster is not initialized.'."\n" + .'* creating: The cluster is being created.'."\n" + .'* init: The cluster is being initialized.'."\n" + .'* running: The cluster is running.'."\n" + .'* exception: The cluster encounters an exception.'."\n" + .'* releasing: The cluster is being released.'."\n", + 'type' => 'string', + 'example' => 'creating', + ], + 'VpcId' => [ + 'description' => 'The VPC ID of the node.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1pxkcvmmz53ki89****', + ], + 'KeyPairName' => [ + 'description' => 'The name of the AccessKey pair.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'EcsChargeType' => [ + 'description' => 'The billing method of the nodes in the cluster. Valid values:'."\n" + ."\n" + .'* PostPaid: pay-as-you-go'."\n" + .'* PrePaid: subscription'."\n", + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'SecurityGroupId' => [ + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'example' => 'sg-bp1asugr34gzn****', + ], + 'SccClusterId' => [ + 'description' => 'The ID of the Super Computing Cluster (SCC) instance. If the cluster is not an SCC instance, a null string is returned.'."\n", + 'type' => 'string', + 'example' => '00b648b****', + ], + 'CreateTime' => [ + 'description' => 'The time at which the instance is created.'."\n", + 'type' => 'string', + 'example' => '2020-12-24T03:18:23.000Z', + ], + 'AccountType' => [ + 'description' => 'The server type of the account. Valid values:'."\n" + ."\n" + .'* nis'."\n" + .'* ldap'."\n", + 'type' => 'string', + 'example' => 'nis', + ], + 'VolumeProtocol' => [ + 'description' => 'The type of the protocol that is used by the file system. Valid values:'."\n" + ."\n" + .'* nfs'."\n" + .'* smb'."\n", + 'type' => 'string', + 'example' => 'nfs', + ], + 'Description' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cluster', + ], + 'VolumeId' => [ + 'description' => 'The ID of the File Storage NAS file system. NAS file systems cannot be automatically created.', + 'type' => 'string', + 'example' => '008b64****', + ], + 'HaEnable' => [ + 'description' => 'Specifies whether to enable the high availability feature.'."\n" + ."\n" + .'> If high availability is enabled, each management role in the cluster uses both primary and secondary instances.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'BaseOsTag' => [ + 'description' => 'The image of the cluster.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Name' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cluster', + ], + 'ImageId' => [ + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'centos_7_02_64_20G_alibase_20170818****', + ], + 'SchedulerType' => [ + 'description' => 'The type of the scheduler. Valid values:'."\n" + ."\n" + .'* pbs'."\n" + .'* slurm'."\n" + .'* opengridscheduler'."\n" + .'* deadline'."\n", + 'type' => 'string', + 'example' => 'pbs', + ], + 'SchedulerVersion' => [ + 'description' => 'The version of the scheduler.'."\n", + 'type' => 'string', + 'example' => '18.1.1', + ], + 'DeployMode' => [ + 'description' => 'The mode in which the cluster is deployed. Valid values:'."\n" + ."\n" + .'* Standard: An account node, a scheduling node, a logon node, and multiple compute nodes are separately deployed.'."\n" + .'* Advanced: Two high availability (HA) account nodes, two HA scheduler nodes, one logon node, and multiple compute nodes are separately deployed.'."\n" + .'* Simple: A management node, a logon node, and multiple compute nodes are deployed. The management node consists of an account node and a scheduling node. The logon node and compute nodes are separately deployed.'."\n" + .'* Tiny: The account node, scheduling node, and logon node are deployed on one node. The compute node is separately deployed.'."\n", + 'type' => 'string', + 'example' => 'Simple', + ], + 'ImageOwnerAlias' => [ + 'description' => 'The image type. Valid values:'."\n" + ."\n" + .'* system: public image'."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n" + .'* marketplace: Alibaba Cloud Marketplace image'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'OsTag' => [ + 'description' => 'The operating system tag of the image.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'VolumeMountpoint' => [ + 'description' => 'The mount target of the NAS file system. The mount target is of the VPC type. Mount targets cannot be automatically created for NAS file systems.'."\n", + 'type' => 'string', + 'example' => '008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com', + ], + 'RemoteDirectory' => [ + 'description' => 'The remote directory on which the file system is mounted.'."\n", + 'type' => 'string', + 'example' => 'NasMountpoint:/RemoteDirectory', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID. E-HPC can be deployed only in VPCs.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1e47optm9g58zcu****', + ], + 'ImageName' => [ + 'description' => 'The image name.'."\n", + 'type' => 'string', + 'example' => 'test_for_Image', + ], + 'VolumeType' => [ + 'description' => 'The type of the network shared storage. Valid value: NAS.'."\n", + 'type' => 'string', + 'example' => 'NAS', + ], + 'Location' => [ + 'description' => 'The location where the cluster is deployed. Valid values:'."\n" + ."\n" + .'* OnPremise: The node is deployed on a hybrid cloud.'."\n" + .'* PublicCloud: The cluster is deployed on a public cloud.'."\n", + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'Id' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'i-bp15de54eet1c43f****', + ], + 'ClientVersion' => [ + 'description' => 'The version of the E-HPC client.'."\n", + 'type' => 'string', + 'example' => '1.0.1', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-aek23szz5i2****', + ], + 'RamRoleName' => [ + 'description' => 'The name of the instance Resource Access Management (RAM) role.'."\n", + 'type' => 'string', + 'example' => 'AliyunEHPCFullAccess', + ], + 'RamNodeTypes' => [ + 'description' => 'The node type details of the instance RAM role.'."\n", + 'type' => 'string', + 'example' => '["manager", "compute"]', + ], + 'Applications' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApplicationInfo' => [ + 'description' => 'The array of the software in the cluster. The array contains the name and version of the software.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'description' => 'The tag of the software.'."\n", + 'type' => 'string', + 'example' => 'OpenMPI_1.8.7', + ], + 'Name' => [ + 'description' => 'The name of the software.'."\n", + 'type' => 'string', + 'example' => 'openmpi', + ], + 'Version' => [ + 'description' => 'The version of the software.'."\n", + 'type' => 'string', + 'example' => '1.10', + ], + ], + ], + ], + ], + ], + 'PostInstallScripts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PostInstallScriptInfo' => [ + 'description' => 'The list of post-installation scripts'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => 'The URL used to download the script.'."\n", + 'type' => 'string', + 'example' => 'example.com', + ], + 'Args' => [ + 'description' => 'The parameter used to run the script.'."\n", + 'type' => 'string', + 'example' => 'bash file.sh', + ], + ], + ], + ], + ], + ], + 'EcsInfo' => [ + 'description' => 'The list of ECS instance specifications and quantity.'."\n", + 'type' => 'object', + 'properties' => [ + 'Manager' => [ + 'description' => 'The information of management nodes.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => 'The instance type of the management nodes.'."\n", + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'Count' => [ + 'description' => 'The number of management nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Compute' => [ + 'description' => 'The list of compute nodes.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => 'The instance type of the compute nodes.'."\n", + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'Count' => [ + 'description' => 'The number of compute nodes in the cluster.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Login' => [ + 'description' => 'The list of logon nodes.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => 'The instance type of the logon nodes.'."\n", + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'Count' => [ + 'description' => 'The number of logon nodes in the cluster.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'ProxyMgr' => [ + 'description' => 'The list of proxy nodes on the cloud.'."\n" + ."\n" + .'This parameter is returned only when the cluster is deployed across hybrid environments and the hybrid-cloud proxy mode is enabled for the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => 'The instance type of the proxy node.'."\n", + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'Count' => [ + 'description' => 'The number of proxy nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'OnPremiseInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OnPremiseInfo' => [ + 'description' => 'The list of on-premises management nodes.'."\n" + ."\n" + .'This parameter is returned only when the cluster is deployed across hybrid environments and the hybrid-cloud proxy mode is enabled for the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the management node in the on-premises cluster. Valid values:'."\n" + ."\n" + .'* scheduler'."\n" + .'* account'."\n" + .'* account, scheduler'."\n", + 'type' => 'string', + 'example' => 'scheduler', + ], + 'HostName' => [ + 'description' => 'The hostname of the management node in the on-premises cluster.'."\n", + 'type' => 'string', + 'example' => 'testecs', + ], + 'IP' => [ + 'description' => 'The IP address of the management node in the on-premises cluster.'."\n", + 'type' => 'string', + 'example' => '192.168.*.*', + ], + ], + ], + ], + ], + ], + 'AddOnsInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AddOnsInfo' => [ + 'description' => 'The information about the custom component service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SoftwareId' => [ + 'description' => 'The software ID of the component.'."\n", + 'type' => 'string', + 'example' => 'CROMWELL_85', + ], + 'DeployMode' => [ + 'description' => 'The deployment mode of the custom component. Valid values:'."\n" + ."\n" + .'* local'."\n" + .'* ecs'."\n", + 'type' => 'string', + 'example' => 'local', + ], + 'Port' => [ + 'description' => 'The TCP port number of the custom component.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'Status' => [ + 'description' => 'The running status of the custom component. Valid values:'."\n" + ."\n" + .'* running'."\n" + .'* stopped'."\n" + .'* exception'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'URL' => [ + 'description' => 'The URL of the custom component service.'."\n", + 'type' => 'string', + 'example' => 'http://172.16.10.12:10000/', + ], + ], + ], + ], + ], + ], + 'ClusterVersion' => [ + 'description' => 'The version of the E-HPC cluster.'."\n", + 'type' => 'string', + 'example' => '1.0', + ], + 'WithoutAgent' => [ + 'description' => 'Specifies whether to not install the agent.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'false', + ], + 'Plugin' => [ + 'description' => 'The mode configurations of the plug-in. This parameter takes effect only when the SchedulerType parameter is set to custom.'."\n" + ."\n" + .'The value must be a JSON string. The parameter contains the following parameters: pluginMod, pluginLocalPath, and pluginOssPath.'."\n" + ."\n" + .'* pluginMod: the mode of the plug-in. The following modes are supported:'."\n" + ."\n" + .' * oss: The plug-in is downloaded and decompressed from OSS to a local path that is specified by the pluginLocalPath parameter.'."\n" + .' * image: By default, the plug-in is stored in a pre-defined local path that is specified by the pluginLocalPath parameter.'."\n" + ."\n" + .'* pluginLocalPath: the local path where the plug-in is stored. We recommend that you select a shared directory in the oss mode and a non-shared directory in the image mode.'."\n" + ."\n" + .'* pluginOssPath: the remote path where the plug-in is stored in OSS. This parameter takes effect only if you set the pluginMod parameter to oss.'."\n", + 'type' => 'string', + 'example' => '{\\"pluginMod\\":\\"image\\",\\"pluginLocalPath\\":\\"/opt/plugin\\"}', + ], + 'SchedulerPreInstall' => [ + 'description' => 'Specifies whether the scheduler is preinstalled for the image. Valid values:'."\n" + ."\n" + .'* true: The scheduler is preinstalled. When you create a node or scale out a cluster, you do not need to install the scheduler.'."\n" + .'* false: The scheduler is not preinstalled. When you create or add a cluster, you must install the scheduler.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'true', + ], + 'Domain' => [ + 'description' => 'The domain name of the on-premises E-HPC cluster.'."\n" + ."\n" + .'This parameter takes effect only when the AccoutType parameter is set to Idap.'."\n", + 'type' => 'string', + 'example' => 'ldap', + ], + 'OpenldapPar' => [ + 'description' => 'The parameter that is used to connect to the OpenLDAP server.'."\n", + 'type' => 'string', + 'example' => '{'."\n" + .' "LdapServerIp": "192.168.XX.XX",'."\n" + .' "BaseDn": "ehpctest",'."\n" + .' "FallbackHomeDir": "/home"'."\n" + .'}', + ], + 'WinAdPar' => [ + 'description' => 'The parameter that is used to connect to the Windows AD server.'."\n", + 'type' => 'string', + 'example' => '{ "AdUser": "Administrator", "AdUserPasswd": "xxxxxx", "AdDc": "ad-hybrid001.ehpcad.com", "AdIp": "192.168.XX.XX"}', + ], + 'Period' => [ + 'description' => 'The duration of the subscription. The unit of the duration is specified by the `PeriodUnit` parameter.'."\n" + ."\n" + .'* If you set PriceUnit to Year, the valid values of the Period parameter are 1, 2, and 3.'."\n" + .'* If you set PriceUnit to Month, the valid values of the Period parameter are 1, 2, 3, 4, 5, 6, 7, 8, and 9.'."\n" + .'* If you set PriceUnit to Hour, the valid value of the Period parameter is 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PeriodUnit' => [ + 'description' => 'The unit of the subscription duration. Valid value:'."\n" + ."\n" + .'* Year'."\n" + .'* Month'."\n" + .'* Hour'."\n" + ."\n" + .'Default value: Month.'."\n", + 'type' => 'string', + 'example' => 'Month', + ], + 'AutoRenewPeriod' => [ + 'description' => 'The auto-renewal period of the subscription compute nodes. The parameter takes effect when AutoRenew is set to true.'."\n" + ."\n" + .'* If PeriodUnit is set to Week, the valid values of the AutoRenewPeriod parameter are 1, 2, and 3.'."\n" + .'* If PeriodUnit is set to Month, the valid values of the AutoRenewPeriod parameter are 1, 2, 3, 6, and 12.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'AutoRenew' => [ + 'description' => 'Specifies whether to enable auto-renewal. The parameter takes effect only when EcsChargeType is set to PrePaid. Valid values:'."\n" + ."\n" + .'* true: enables auto-renewal.'."\n" + .'* false: disables auto-renewal.'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'ComputeSpotStrategy' => [ + 'description' => 'The bidding method of the compute node. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'ComputeSpotPriceLimit' => [ + 'description' => 'The maximum hourly price of the compute nodes. A maximum of three decimal places can be used in the value of the parameter. The parameter is valid only when the ComputeSpotStrategy parameter is set to SpotWithPriceLimit.'."\n", + 'type' => 'string', + 'example' => '0.56', + ], + 'Nodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodesInfo' => [ + 'description' => 'The information of the on-premises node in the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'description' => 'The role of the node in the on-premises cluster. Valid values:'."\n" + ."\n" + .'* Manager: management node'."\n" + .'* Login: logon node'."\n" + .'* Compute: compute node'."\n", + 'type' => 'string', + 'example' => 'Compute', + ], + 'HostName' => [ + 'description' => 'The hostname of the node in the on-premises cluster.'."\n", + 'type' => 'string', + 'example' => 'compute000', + ], + 'IpAddress' => [ + 'description' => 'The IP address of the node in the on-premises cluster.'."\n", + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'AccountType' => [ + 'description' => 'The service type of the domain account to which the node in the on-premises cluster belongs. Valid values:'."\n" + ."\n" + .'* nis'."\n" + .'* ldap'."\n" + ."\n" + .'Default value: nis.'."\n", + 'type' => 'string', + 'example' => 'nis', + ], + 'Dir' => [ + 'description' => 'The directory of the node in the on-premises cluster.'."\n", + 'type' => 'string', + 'example' => '/opt/sge/default/', + ], + 'SchedulerType' => [ + 'description' => 'The scheduler type of the node in the on-premises cluster. Valid values:'."\n" + ."\n" + .'* pbs'."\n" + .'* slurm'."\n" + .'* opengridscheduler'."\n" + .'* deadline'."\n" + ."\n" + .'Default value: pbs.'."\n", + 'type' => 'string', + 'example' => 'pbs', + ], + ], + ], + ], + ], + ], + 'InitialImage' => [ + 'description' => 'The image information of the operating systems.'."\n", + 'type' => 'object', + 'properties' => [ + 'OsTag' => [ + 'description' => 'An array of OS images that are supported by E-HPC.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.6_64', + ], + 'ImageOwnerAlias' => [ + 'description' => 'The type of the image. Valid values:'."\n" + ."\n" + .'* system: public image'."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n" + .'* marketplace: Alibaba Cloud Marketplace image'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'ImageId' => [ + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'centos_7_6_x64_20G_alibase_20211130.vhd', + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'NasError', + 'errorMessage' => 'NAS API request failed.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"ClusterInfo\\": {\\n \\"Status\\": \\"creating\\",\\n \\"VpcId\\": \\"vpc-bp1pxkcvmmz53ki89****\\",\\n \\"KeyPairName\\": \\"test\\",\\n \\"EcsChargeType\\": \\"PostPaid\\",\\n \\"SecurityGroupId\\": \\"sg-bp1asugr34gzn****\\",\\n \\"SccClusterId\\": \\"00b648b****\\",\\n \\"CreateTime\\": \\"2020-12-24T03:18:23.000Z\\",\\n \\"AccountType\\": \\"nis\\",\\n \\"VolumeProtocol\\": \\"nfs\\",\\n \\"Description\\": \\"cluster\\",\\n \\"VolumeId\\": \\"008b64****\\",\\n \\"HaEnable\\": false,\\n \\"BaseOsTag\\": \\"CentOS_7.2_64\\",\\n \\"Name\\": \\"cluster\\",\\n \\"ImageId\\": \\"centos_7_02_64_20G_alibase_20170818****\\",\\n \\"SchedulerType\\": \\"pbs\\",\\n \\"SchedulerVersion\\": \\"18.1.1\\",\\n \\"DeployMode\\": \\"Simple\\",\\n \\"ImageOwnerAlias\\": \\"system\\",\\n \\"OsTag\\": \\"CentOS_7.2_64\\",\\n \\"VolumeMountpoint\\": \\"008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"RemoteDirectory\\": \\"NasMountpoint:/RemoteDirectory\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchId\\": \\"vsw-bp1e47optm9g58zcu****\\",\\n \\"ImageName\\": \\"test_for_Image\\",\\n \\"VolumeType\\": \\"NAS\\",\\n \\"Location\\": \\"PublicCloud\\",\\n \\"Id\\": \\"i-bp15de54eet1c43f****\\",\\n \\"ClientVersion\\": \\"1.0.1\\",\\n \\"ZoneId\\": \\"cn-hangzhou-k\\",\\n \\"ResourceGroupId\\": \\"rg-aek23szz5i2****\\",\\n \\"RamRoleName\\": \\"AliyunEHPCFullAccess\\",\\n \\"RamNodeTypes\\": \\"[\\\\\\"manager\\\\\\", \\\\\\"compute\\\\\\"]\\",\\n \\"Applications\\": {\\n \\"ApplicationInfo\\": [\\n {\\n \\"Tag\\": \\"OpenMPI_1.8.7\\",\\n \\"Name\\": \\"openmpi\\",\\n \\"Version\\": \\"1.10\\"\\n }\\n ]\\n },\\n \\"PostInstallScripts\\": {\\n \\"PostInstallScriptInfo\\": [\\n {\\n \\"Url\\": \\"example.com\\",\\n \\"Args\\": \\"bash file.sh\\"\\n }\\n ]\\n },\\n \\"EcsInfo\\": {\\n \\"Manager\\": {\\n \\"InstanceType\\": \\"ecs.n1.tiny\\",\\n \\"Count\\": 1\\n },\\n \\"Compute\\": {\\n \\"InstanceType\\": \\"ecs.n1.tiny\\",\\n \\"Count\\": 1\\n },\\n \\"Login\\": {\\n \\"InstanceType\\": \\"ecs.n1.tiny\\",\\n \\"Count\\": 1\\n },\\n \\"ProxyMgr\\": {\\n \\"InstanceType\\": \\"ecs.n1.tiny\\",\\n \\"Count\\": 1\\n }\\n },\\n \\"OnPremiseInfo\\": {\\n \\"OnPremiseInfo\\": [\\n {\\n \\"Type\\": \\"scheduler\\",\\n \\"HostName\\": \\"testecs\\",\\n \\"IP\\": \\"192.168.*.*\\"\\n }\\n ]\\n },\\n \\"AddOnsInfo\\": {\\n \\"AddOnsInfo\\": [\\n {\\n \\"SoftwareId\\": \\"CROMWELL_85\\",\\n \\"DeployMode\\": \\"local\\",\\n \\"Port\\": 10000,\\n \\"Status\\": \\"running\\",\\n \\"URL\\": \\"http://172.16.10.12:10000/\\"\\n }\\n ]\\n },\\n \\"ClusterVersion\\": \\"1.0\\",\\n \\"WithoutAgent\\": 0,\\n \\"Plugin\\": \\"{\\\\\\\\\\\\\\"pluginMod\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"image\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"pluginLocalPath\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"/opt/plugin\\\\\\\\\\\\\\"}\\",\\n \\"SchedulerPreInstall\\": 0,\\n \\"Domain\\": \\"ldap\\",\\n \\"OpenldapPar\\": \\"{\\\\n\\\\t\\\\\\"LdapServerIp\\\\\\": \\\\\\"192.168.XX.XX\\\\\\",\\\\n\\\\t\\\\\\"BaseDn\\\\\\": \\\\\\"ehpctest\\\\\\",\\\\n\\\\t\\\\\\"FallbackHomeDir\\\\\\": \\\\\\"/home\\\\\\"\\\\n}\\",\\n \\"WinAdPar\\": \\"{\\\\t\\\\\\"AdUser\\\\\\": \\\\\\"Administrator\\\\\\",\\\\t\\\\\\"AdUserPasswd\\\\\\": \\\\\\"xxxxxx\\\\\\",\\\\t\\\\\\"AdDc\\\\\\": \\\\\\"ad-hybrid001.ehpcad.com\\\\\\",\\\\t\\\\\\"AdIp\\\\\\": \\\\\\"192.168.XX.XX\\\\\\"}\\",\\n \\"Period\\": \\"1\\",\\n \\"PeriodUnit\\": \\"Month\\",\\n \\"AutoRenewPeriod\\": \\"1\\",\\n \\"AutoRenew\\": \\"false\\",\\n \\"ComputeSpotStrategy\\": \\"NoSpot\\",\\n \\"ComputeSpotPriceLimit\\": \\"0.56\\",\\n \\"Nodes\\": {\\n \\"NodesInfo\\": [\\n {\\n \\"Role\\": \\"Compute\\",\\n \\"HostName\\": \\"compute000\\",\\n \\"IpAddress\\": \\"192.168.XX.XX\\",\\n \\"AccountType\\": \\"nis\\",\\n \\"Dir\\": \\"/opt/sge/default/\\",\\n \\"SchedulerType\\": \\"pbs\\"\\n }\\n ]\\n },\\n \\"InitialImage\\": {\\n \\"OsTag\\": \\"CentOS_7.6_64\\",\\n \\"ImageOwnerAlias\\": \\"system\\",\\n \\"ImageId\\": \\"centos_7_6_x64_20G_alibase_20211130.vhd\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <ClusterInfo>\\n <Status>creating</Status>\\n <VpcId>vpc-bp1pxkcvmmz53ki89****</VpcId>\\n <KeyPairName>test</KeyPairName>\\n <EcsChargeType>PostPaid</EcsChargeType>\\n <SecurityGroupId>sg-bp1asugr34gzn****</SecurityGroupId>\\n <SccClusterId>00b648b****</SccClusterId>\\n <CreateTime>2020-12-24T03:18:23.000Z</CreateTime>\\n <AccountType>nis</AccountType>\\n <VolumeProtocol>nfs</VolumeProtocol>\\n <Description>cluster</Description>\\n <VolumeId>008b64****</VolumeId>\\n <HaEnable>false</HaEnable>\\n <BaseOsTag>CentOS_7.2_64</BaseOsTag>\\n <Name>cluster</Name>\\n <ImageId>centos_7_02_64_20G_alibase_20170818****</ImageId>\\n <SchedulerType>pbs</SchedulerType>\\n <DeployMode>Simple</DeployMode>\\n <ImageOwnerAlias>system</ImageOwnerAlias>\\n <OsTag>CentOS_7.2_64</OsTag>\\n <VolumeMountpoint>008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com</VolumeMountpoint>\\n <RemoteDirectory>NasMountpoint:/RemoteDirectory</RemoteDirectory>\\n <RegionId>cn-hangzhou</RegionId>\\n <VSwitchId>vsw-bp1e47optm9g58zcu****</VSwitchId>\\n <ImageName>test_for_Image</ImageName>\\n <VolumeType>NAS</VolumeType>\\n <Location>PublicCloud</Location>\\n <Id>i-bp15de54eet1c43f****</Id>\\n <ClientVersion>1.0.1</ClientVersion>\\n <Applications>\\n <Tag>OpenMPI_1.8.7</Tag>\\n <Name>openmpi</Name>\\n <Version>1.10</Version>\\n </Applications>\\n <PostInstallScripts>\\n <Url>example.com</Url>\\n <Args>bash file.sh</Args>\\n </PostInstallScripts>\\n <EcsInfo>\\n <Manager>\\n <InstanceType>ecs.n1.tiny</InstanceType>\\n <Count>1</Count>\\n </Manager>\\n <Compute>\\n <InstanceType>ecs.n1.tiny</InstanceType>\\n <Count>1</Count>\\n </Compute>\\n <Login>\\n <InstanceType>ecs.n1.tiny</InstanceType>\\n <Count>1</Count>\\n </Login>\\n <ProxyMgr>\\n <InstanceType>ecs.n1.tiny</InstanceType>\\n <Count>1</Count>\\n </ProxyMgr>\\n </EcsInfo>\\n <OnPremiseInfo>\\n <Type>scheduler</Type>\\n <HostName>testecs</HostName>\\n <IP>192.168.*.*</IP>\\n </OnPremiseInfo>\\n </ClusterInfo>\\n</DescribeClusterResponse>","errorExample":""}]', + 'title' => 'DescribeCluster', + 'summary' => 'Queries the details of a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyClusterAttributes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75892', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster that you want to modify.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new cluster name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cluster1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new cluster description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-description', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new image type of the cluster. Valid values:'."\n" + ."\n" + .'* system: public image'."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n" + .'* marketplace: Alibaba Cloud Marketplace image'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'self', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the images.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_06_64_20G_alibase_2019071****', + ], + ], + [ + 'name' => 'RamRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the instance RAM role.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testRamRoleName', + ], + ], + [ + 'name' => 'RamNodeTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The type of the node to which you want to bind the RAM role.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the node to which you want to bind the RAM role.'."\n" + ."\n" + .'* Valid values if the DeployMode parameter is set to Standard: scheduler, account, login, and compute. Separate multiple values with commas (,).'."\n" + .'* Valid values if the DeployMode parameter is set to Simple: manager, login, and compute. Separate multiple values with commas (,).'."\n" + .'* Valid values if the DeployMode parameter is set to Tiny: manager and compute.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'manager,compute', + ], + 'required' => false, + 'maxItems' => 5, + 'minItems' => 0, + ], + ], + [ + 'name' => 'WinAdPar', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The parameters that are used to connect to the Windows AD server.'."\n", + 'type' => 'object', + 'properties' => [ + 'AdUser' => [ + 'description' => 'The Windows AD server administrator.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'administrator', + ], + 'AdUserPasswd' => [ + 'description' => 'The administrator password of the Windows AD server.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxxx', + ], + 'AdDc' => [ + 'description' => 'The domain name of the Windows AD server.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpcad.com', + ], + 'AdIp' => [ + 'description' => 'The IP address of the Windows AD server.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.2', + ], + 'FallbackHomeDir' => [ + 'description' => 'The home directory of the Linux server.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/home', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7336', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'InvalidImage', + 'errorMessage' => 'The image ID is invalid.', + ], + [ + 'errorCode' => 'ImageNotMatched', + 'errorMessage' => 'The image is not matched.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7336\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyClusterAttributesResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7336</RequestId>\\r\\n</ModifyClusterAttributesResponse>","errorExample":""}]', + 'title' => 'ModifyClusterAttributes', + 'summary' => 'Modifies the basic information of a cluster, including the name, description, and image.', + 'description' => '## Usage notes'."\n" + ."\n" + .'Before you call this operation, you can call the [DescribeCluster](~~87126~~) operation to query details of the selected cluster.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListClusters' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Clusters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ClusterInfoSimple' => [ + 'description' => 'The list of clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'example' => 'vpc-b3f3edefefeep0760yju****', + ], + 'Status' => [ + 'description' => 'The status of the cluster. Valid values:'."\n" + ."\n" + .'* uninit: The cluster is not initialized.'."\n" + .'* creating: The cluster is being created.'."\n" + .'* init: The cluster is being initialized.'."\n" + .'* running: The cluster is running.'."\n" + .'* exception: The cluster encounters an exception.'."\n" + .'* releasing: The cluster is being released.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'CreateTime' => [ + 'description' => 'The time when the instance was created.'."\n", + 'type' => 'string', + 'example' => '2020-10-30T07:39:20.000Z', + ], + 'IsComputeEss' => [ + 'description' => 'Indicates whether a scaling group was enabled. Valid values:'."\n" + ."\n" + .'* true: A scaling group is enabled.'."\n" + .'* false: No scaling group is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ComputeSpotStrategy' => [ + 'description' => 'The bidding method of the compute nodes. Valid values:'."\n" + ."\n" + .'* NoSpot: The instances of the compute node are pay-as-you-go instances.'."\n" + .'* SpotWithPriceLimit: The instances of the compute node are preemptible instances. These types of instances have a specified maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instances of the compute node are preemptible instances. The price of these instances is based on the current market price.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'AccountType' => [ + 'description' => 'The server type of the account. Valid values:'."\n" + ."\n" + .'* nis'."\n" + .'* ldap'."\n", + 'type' => 'string', + 'example' => 'nis', + ], + 'Count' => [ + 'description' => 'The number of compute nodes in the cluster.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'EhpcVersion' => [ + 'description' => 'The version of E-HPC.'."\n", + 'type' => 'string', + 'example' => '1.0.0', + ], + 'Description' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'example' => 'clusterdescription', + ], + 'BaseOsTag' => [ + 'description' => 'The operating system tag of the base image. The tag was used only by the management node.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Name' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'ImageId' => [ + 'description' => 'The ID of the image.'."\n", + 'type' => 'string', + 'example' => 'wi_1607_x64_dtc_zh_40G_alibase****', + ], + 'ComputeSpotPriceLimit' => [ + 'description' => 'The maximum hourly price for the ECS instance under the compute node. The return value can be accurate to three decimal places.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.034', + ], + 'SchedulerType' => [ + 'description' => 'The type of the scheduler. Valid values:'."\n" + ."\n" + .'* pbs'."\n" + .'* slurm'."\n" + .'* opengridscheduler'."\n" + .'* deadline'."\n", + 'type' => 'string', + 'example' => 'pbs', + ], + 'DeployMode' => [ + 'description' => 'The mode in which the cluster was deployed. Valid values:'."\n" + ."\n" + .'* Standard: An account node, a scheduling node, a logon node, and multiple compute nodes are separately deployed.'."\n" + .'* Advanced: Two high availability (HA) account nodes, two HA scheduler nodes, one logon node, and multiple compute nodes are separately deployed.'."\n" + .'* Simple: A management node, a logon node, and multiple compute nodes are deployed. The management node consists of an account node and a scheduling node. The logon node and compute nodes are separately deployed.'."\n" + .'* Tiny: A management node and multiple compute nodes are deployed. The management node consists of an account node, a scheduling node, and a logon node. The compute nodes are separately deployed.'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'NodeSuffix' => [ + 'description' => 'The suffix of the node.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'ImageOwnerAlias' => [ + 'description' => 'The type of the image. Valid values:'."\n" + ."\n" + .'* system: public image'."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n" + .'* marketplace: Alibaba Cloud Marketplace image'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'OsTag' => [ + 'description' => 'The operating system tag of the image.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'NodePrefix' => [ + 'description' => 'The prefix of the node.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the compute nodes.'."\n", + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceChargeType' => [ + 'description' => 'The billing method of the nodes in the cluster. Valid values:'."\n" + ."\n" + .'* PostPaid: pay-as-you-go'."\n" + .'* PrePaid: subscription'."\n", + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-c', + ], + 'LoginNodes' => [ + 'description' => 'The list of logon nodes.'."\n", + 'type' => 'string', + 'example' => '{"Id": "i-bp13x4is8pvdhws7e****"}', + ], + 'Id' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-jeJki6****', + ], + 'Location' => [ + 'description' => 'The location where the cluster was deployed. Valid values:'."\n" + ."\n" + .'* OnPremise: The cluster is deployed on a hybrid cloud.'."\n" + .'* PublicCloud: The cluster is deployed on a public cloud.'."\n", + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'ClientVersion' => [ + 'description' => 'The version of the client.'."\n", + 'type' => 'string', + 'example' => '1.0.64', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.You can call the ListResourceGroups operation to query the IDs of resource groups.', + 'type' => 'string', + 'example' => 'rg-acfmxazb4ph****', + ], + 'Managers' => [ + 'description' => 'The list of management nodes.'."\n", + 'type' => 'object', + 'properties' => [ + 'OperatingCount' => [ + 'description' => 'The number of nodes that are being used in the queue. This includes those that are being initialized, installed, or released.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExceptionCount' => [ + 'description' => 'The number of abnormal nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StoppedCount' => [ + 'description' => 'The number of stopped nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Total' => [ + 'description' => 'The total number of management nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NormalCount' => [ + 'description' => 'The number of normal nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Computes' => [ + 'description' => 'The information about compute nodes.'."\n", + 'type' => 'object', + 'properties' => [ + 'OperatingCount' => [ + 'description' => 'The number of nodes that are being used in the queue. This includes those that are being initialized, installed, or released.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExceptionCount' => [ + 'description' => 'The number of abnormal nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StoppedCount' => [ + 'description' => 'The number of stopped nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Total' => [ + 'description' => 'The total number of nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NormalCount' => [ + 'description' => 'The number of normal nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'TotalResources' => [ + 'description' => 'The statistics of all resources in the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'The number of GPU cards. Unit: cards.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'The number of CPU cores. Unit: cores.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => 'The memory size. Unit: MiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'UsedResources' => [ + 'description' => 'The number of consumed resources in the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'The number of GPU cards. Unit: cards.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'The number of CPU cores. Unit: cores.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => 'The memory size. Unit: MiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'HasPlugin' => [ + 'description' => 'Indicates whether plug-ins were used in the cluster. Valid values:'."\n" + ."\n" + .'* true: Plug-ins are used.'."\n" + .'* false: Plug-ins are not used.'."\n" + ."\n" + .'Default value: false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'The role does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Clusters\\": {\\n \\"ClusterInfoSimple\\": [\\n {\\n \\"VpcId\\": \\"vpc-b3f3edefefeep0760yju****\\",\\n \\"Status\\": \\"running\\",\\n \\"CreateTime\\": \\"2020-10-30T07:39:20.000Z\\",\\n \\"IsComputeEss\\": false,\\n \\"ComputeSpotStrategy\\": \\"NoSpot\\",\\n \\"AccountType\\": \\"nis\\",\\n \\"Count\\": 3,\\n \\"EhpcVersion\\": \\"1.0.0\\",\\n \\"Description\\": \\"clusterdescription\\",\\n \\"BaseOsTag\\": \\"CentOS_7.2_64\\",\\n \\"Name\\": \\"test\\",\\n \\"ImageId\\": \\"wi_1607_x64_dtc_zh_40G_alibase****\\",\\n \\"ComputeSpotPriceLimit\\": 0.034,\\n \\"SchedulerType\\": \\"pbs\\",\\n \\"DeployMode\\": \\"Standard\\",\\n \\"NodeSuffix\\": \\"name\\",\\n \\"ImageOwnerAlias\\": \\"system\\",\\n \\"OsTag\\": \\"CentOS_7.2_64\\",\\n \\"NodePrefix\\": \\"test\\",\\n \\"InstanceType\\": \\"ecs.n1.tiny\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"VSwitchId\\": \\"vsw-bp1lfcjbfb099rrjn****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-c\\",\\n \\"LoginNodes\\": \\"{\\\\\\"Id\\\\\\": \\\\\\"i-bp13x4is8pvdhws7e****\\\\\\"}\\",\\n \\"Id\\": \\"ehpc-hz-jeJki6****\\",\\n \\"Location\\": \\"PublicCloud\\",\\n \\"ClientVersion\\": \\"1.0.64\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxazb4ph****\\",\\n \\"Managers\\": {\\n \\"OperatingCount\\": 1,\\n \\"ExceptionCount\\": 0,\\n \\"StoppedCount\\": 0,\\n \\"Total\\": 2,\\n \\"NormalCount\\": 1\\n },\\n \\"Computes\\": {\\n \\"OperatingCount\\": 1,\\n \\"ExceptionCount\\": 0,\\n \\"StoppedCount\\": 0,\\n \\"Total\\": 2,\\n \\"NormalCount\\": 1\\n },\\n \\"TotalResources\\": {\\n \\"Gpu\\": 0,\\n \\"Cpu\\": 1,\\n \\"Memory\\": 1024\\n },\\n \\"UsedResources\\": {\\n \\"Gpu\\": 0,\\n \\"Cpu\\": 1,\\n \\"Memory\\": 1024\\n },\\n \\"HasPlugin\\": false\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListClustersResponse>\\n <PageSize>1</PageSize>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <PageNumber>1</PageNumber>\\n <TotalCount>1</TotalCount>\\n <Clusters>\\n <VpcId>vpc-b3f3edefefeep0760yju****</VpcId>\\n <Status>running</Status>\\n <CreateTime>2020-10-30T07:39:20.000Z</CreateTime>\\n <IsComputeEss>false</IsComputeEss>\\n <ComputeSpotStrategy>NoSpot</ComputeSpotStrategy>\\n <AccountType>nis</AccountType>\\n <Count>3</Count>\\n <EhpcVersion>1.0.0</EhpcVersion>\\n <Description>clusterdescription</Description>\\n <BaseOsTag>CentOS_7.2_64</BaseOsTag>\\n <Name>test</Name>\\n <ImageId>wi_1607_x64_dtc_zh_40G_alibase****</ImageId>\\n <ComputeSpotPriceLimit>0.034</ComputeSpotPriceLimit>\\n <SchedulerType>pbs</SchedulerType>\\n <DeployMode>Standard</DeployMode>\\n <NodeSuffix>name</NodeSuffix>\\n <ImageOwnerAlias>system</ImageOwnerAlias>\\n <OsTag>CentOS_7.2_64</OsTag>\\n <NodePrefix>test</NodePrefix>\\n <InstanceType>ecs.n1.tiny</InstanceType>\\n <RegionId>cn-hangzhou</RegionId>\\n <InstanceChargeType>PostPaid</InstanceChargeType>\\n <VSwitchId>vsw-bp1lfcjbfb099rrjn****</VSwitchId>\\n <ZoneId>cn-hangzhou-c</ZoneId>\\n <LoginNodes>{\\"Id\\": \\"i-bp13x4is8pvdhws7e****\\"}</LoginNodes>\\n <Id>ehpc-hz-jeJki6****</Id>\\n <Location>PublicCloud</Location>\\n <ClientVersion>1.0.64</ClientVersion>\\n <Managers>\\n <OperatingCount>1</OperatingCount>\\n <ExceptionCount>0</ExceptionCount>\\n <StoppedCount>0</StoppedCount>\\n <Total>2</Total>\\n <NormalCount>1</NormalCount>\\n </Managers>\\n <Computes>\\n <OperatingCount>1</OperatingCount>\\n <ExceptionCount>0</ExceptionCount>\\n <StoppedCount>0</StoppedCount>\\n <Total>2</Total>\\n <NormalCount>1</NormalCount>\\n </Computes>\\n <TotalResources>\\n <Gpu>0</Gpu>\\n <Cpu>1</Cpu>\\n <Memory>1024</Memory>\\n </TotalResources>\\n <UsedResources>\\n <Gpu>0</Gpu>\\n <Cpu>1</Cpu>\\n <Memory>1024</Memory>\\n </UsedResources>\\n <HasPlugin>false</HasPlugin>\\n </Clusters>\\n</ListClustersResponse>","errorExample":""}]', + 'title' => 'ListClusters', + 'summary' => 'Queries all Elastic High Performance Computing (E-HPC) clusters of the current account in each region.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListClustersMeta' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page. Valid values: 1 to 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DD517102-B314-4665-BDAC-A32DE7834D02', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Clusters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ClusterInfoSimple' => [ + 'description' => 'The list of clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the cluster. Valid values:'."\n" + ."\n" + .'* uninit: The cluster is not initialized.'."\n" + .'* creating: The cluster is being created.'."\n" + .'* init: The cluster is being initialized.'."\n" + .'* running: The cluster is running.'."\n" + .'* exception: The cluster encounters an exception.'."\n" + .'* releasing: The cluster is being released.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'example' => 'vpc-b3f3edefefeep0760yju****', + ], + 'SchedulerType' => [ + 'description' => 'The type of the scheduler. Valid values:'."\n" + ."\n" + .'* pbs'."\n" + .'* slurm'."\n" + .'* opengridscheduler'."\n" + .'* deadline'."\n", + 'type' => 'string', + 'example' => 'pbs', + ], + 'DeployMode' => [ + 'description' => 'The mode in which the cluster is deployed. Valid values:'."\n" + ."\n" + .'* Standard: An account node, a scheduling node, a logon node, and multiple compute nodes are separately deployed.'."\n" + .'* Advanced: Two high availability (HA) account nodes, two HA scheduler nodes, one logon node, and multiple compute nodes are separately deployed.'."\n" + .'* Simple: A management node, a logon node, and multiple compute nodes are deployed. The management node consists of an account node and a scheduling node. The logon node and compute nodes are separately deployed.'."\n" + .'* Tiny: A management node and multiple compute nodes are deployed. The management node consists of an account node, a scheduling node, and a logon node. The compute nodes are separately deployed.'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'IsComputeEss' => [ + 'description' => 'Indicates whether a scaling group is enabled. Valid values:'."\n" + ."\n" + .'* true: A scaling group is enabled.'."\n" + .'* false: No scaling group is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'OsTag' => [ + 'description' => 'The image tag of the operating system.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'AccountType' => [ + 'description' => 'The server type of the account. Valid values:'."\n" + ."\n" + .'* nis'."\n" + .'* ldap'."\n", + 'type' => 'string', + 'example' => 'nis', + ], + 'Description' => [ + 'description' => 'The description of the cluster.'."\n", + 'type' => 'string', + 'example' => 'clusterdescription', + ], + 'Name' => [ + 'description' => 'The name of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cluster1', + ], + 'Id' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-jeJki6****', + ], + 'Location' => [ + 'description' => 'The location where the cluster is deployed. Valid values:'."\n" + ."\n" + .'* OnPremise: The cluster is deployed on a hybrid cloud.'."\n" + .'* PublicCloud: The cluster is deployed on a public cloud.'."\n", + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'ClientVersion' => [ + 'description' => 'The version of the client.'."\n", + 'type' => 'string', + 'example' => '1.0.64', + ], + 'HasPlugin' => [ + 'description' => 'Indicates whether the cluster uses a plug-in. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'EhpcVersion' => [ + 'type' => 'string', + 'description' => 'The version of E-HPC.'."\n", + 'example' => '1.0.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"DD517102-B314-4665-BDAC-A32DE7834D02\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Clusters\\": {\\n \\"ClusterInfoSimple\\": [\\n {\\n \\"Status\\": \\"running\\",\\n \\"VpcId\\": \\"vpc-b3f3edefefeep0760yju****\\",\\n \\"SchedulerType\\": \\"pbs\\",\\n \\"DeployMode\\": \\"Standard\\",\\n \\"IsComputeEss\\": false,\\n \\"OsTag\\": \\"CentOS_7.2_64\\",\\n \\"AccountType\\": \\"nis\\",\\n \\"Description\\": \\"clusterdescription\\",\\n \\"Name\\": \\"cluster1\\",\\n \\"Id\\": \\"ehpc-hz-jeJki6****\\",\\n \\"Location\\": \\"PublicCloud\\",\\n \\"ClientVersion\\": \\"1.0.64\\",\\n \\"HasPlugin\\": false,\\n \\"EhpcVersion\\": \\"1.0.0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListClustersMetaResponse>\\n <PageSize>10</PageSize>\\n <RequestId>DD517102-B314-4665-BDAC-A32DE7834D02</RequestId>\\n <PageNumber>1</PageNumber>\\n <TotalCount>1</TotalCount>\\n <Clusters>\\n <Status>running</Status>\\n <VpcId>vpc-b3f3edefefeep0760yju****</VpcId>\\n <SchedulerType>pbs</SchedulerType>\\n <DeployMode>Standard</DeployMode>\\n <IsComputeEss>false</IsComputeEss>\\n <OsTag>CentOS_7.2_64</OsTag>\\n <AccountType>nis</AccountType>\\n <Description>clusterdescription</Description>\\n <Name>cluster1</Name>\\n <Id>ehpc-hz-jeJki6****</Id>\\n <Location>PublicCloud</Location>\\n <ClientVersion>1.0.64</ClientVersion>\\n <HasPlugin>false</HasPlugin>\\n </Clusters>\\n</ListClustersMetaResponse>","errorExample":""}]', + 'title' => 'ListClustersMeta', + 'summary' => 'Queries the list of cluster metadata.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartCluster' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster that you want to start.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => '76E1ADE7-D15A-457F-AAFD-06C5A5F052D0', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '76E1ADE7-D15A-457F-AAFD-06C5A5F052D0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"76E1ADE7-D15A-457F-AAFD-06C5A5F0****\\",\\n \\"RequestId\\": \\"76E1ADE7-D15A-457F-AAFD-06C5A5F0****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartClusterResponse>\\n <TaskId>76E1ADE7-D15A-457F-AAFD-06C5A5F0****</TaskId>\\n <RequestId>76E1ADE7-D15A-457F-AAFD-06C5A5F0****</RequestId>\\n</StartClusterResponse>","errorExample":""}]', + 'title' => 'StartCluster', + 'summary' => 'Starts a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopCluster' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75918', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the list of clusters in a region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopClusterResponse>\\n <TaskId>04F0F334-1335-436C-A1D7-6C044FE7****</TaskId>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n</StopClusterResponse>","errorExample":""}]', + 'title' => 'StopCluster', + 'summary' => 'Stops a cluster.', + 'description' => 'If you stop a subscription compute node, its billing is not affected. If you stop a pay-as-you-go compute node for which you have enabled the *economical mode*, you are no longer charged for its computing resources. For more information, see [Economical mode](~~63353~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RecoverCluster' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID. The cluster must be in the Exception state.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the ID and status of a cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'OsTag', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag of the system image.'."\n" + ."\n" + .'You can call the [ListImages](~~87213~~) and [ListCustomImages](~~87215~~) operations to query the image tags supported by Elastic High Performance Computing (E-HPC).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service type of the domain account. Valid values:'."\n" + ."\n" + .'* nis'."\n" + .'* ldap'."\n" + ."\n" + .'Default value: nis.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nis', + ], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the scheduler. Valid values:'."\n" + ."\n" + .'* pbs'."\n" + .'* slurm'."\n" + .'* opengridscheduler'."\n" + .'* deadline'."\n" + ."\n" + .'Default value: pbs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pbs', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the image. Valid values:'."\n" + ."\n" + .'* system: public image'."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n" + ."\n" + .'Default value: system.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image ID.'."\n" + ."\n" + .'You can call the [ListImages](~~87213~~) and [ListCustomImages](~~87215~~) operations to query the images that are supported by E-HPC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'm-bp18133n0335yq****', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the E-HPC client. The default value is the latest version of the client.'."\n" + ."\n" + .'You can call the [ListCurrentClientVersion](~~87223~~) operation to query the latest version of the E-HPC client.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0.76', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => '18FB21E3-F423-4B84-BB63-D8887A29****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '18FB21E3-F423-4B84-BB63-D8887A29****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'OrderError.InsufficientBalance', + 'errorMessage' => 'The account balance is insufficient. Please add funds first and try again.', + ], + [ + 'errorCode' => 'OrderError.InstHasUnpaidOrder', + 'errorMessage' => 'Your account has an unpaid order.', + ], + [ + 'errorCode' => 'OrderError.Arrearage', + 'errorMessage' => 'Your account balance is less than CNY 100. Please add funds to your account and try again.', + ], + [ + 'errorCode' => 'OrderError.NoCard', + 'errorMessage' => 'No credit card is bound to your account.', + ], + [ + 'errorCode' => 'OrderError.InvalidPayMethod', + 'errorMessage' => 'No valid default payment method is specified for your account.', + ], + [ + 'errorCode' => 'OrderError.NoRealNameAuthentication', + 'errorMessage' => 'You have not completed the real name authentication.', + ], + [ + 'errorCode' => 'OrderError.NoRealNameRegistration', + 'errorMessage' => 'Real name registration is required for instances launched in mainland China.', + ], + [ + 'errorCode' => 'OrderError.UserProfileIncomplete', + 'errorMessage' => 'You have not completed your user profile.', + ], + [ + 'errorCode' => 'InvalidVpc', + 'errorMessage' => 'The specified VPC is invalid.', + ], + [ + 'errorCode' => 'InvalidVolume', + 'errorMessage' => 'The specified volume is invalid.', + ], + [ + 'errorCode' => 'InvalidSoftware', + 'errorMessage' => 'The specified software is not supported.', + ], + [ + 'errorCode' => 'InvalidVolumeProtocal', + 'errorMessage' => 'The specified volume protocol is invalid.', + ], + [ + 'errorCode' => 'InvalidVolumeMountpoint', + 'errorMessage' => 'The specified volume mount point is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'TooManyClusters', + 'errorMessage' => 'The number of user clusters exceeds the quota.', + ], + [ + 'errorCode' => 'TooManyComputes', + 'errorMessage' => 'The number of computing nodes exceeds the quota.', + ], + [ + 'errorCode' => 'TooManyLogins', + 'errorMessage' => 'The maximum number of logged on nodes is exceeded.', + ], + [ + 'errorCode' => 'TooManyScc', + 'errorMessage' => 'The maximum number of SCC instances is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceeded.PrivateIpAddress', + 'errorMessage' => 'Insufficient private IP addresses in vSwitch: %s.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'ImageNotSupported', + 'errorMessage' => 'The specified image is not supported.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + [ + 'errorCode' => 'VolumeNotFound', + 'errorMessage' => 'The specified volume does not exist.', + ], + [ + 'errorCode' => 'VpcNotFound', + 'errorMessage' => 'The specified VPC does not exist.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'NasError', + 'errorMessage' => 'NAS API request failed.', + ], + [ + 'errorCode' => 'EipError', + 'errorMessage' => 'The EIP API request failed.', + ], + [ + 'errorCode' => 'OrderError', + 'errorMessage' => 'An order request error occurred.', + ], + [ + 'errorCode' => 'FailToGenId', + 'errorMessage' => 'Generating cluster ID failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"18FB21E3-F423-4B84-BB63-D8887A29****\\",\\n \\"RequestId\\": \\"18FB21E3-F423-4B84-BB63-D8887A29****\\"\\n}","errorExample":""},{"type":"xml","example":"<RecoverClusterResponse>\\n <TaskId>18FB21E3-F423-4B84-BB63-D8887A29****</TaskId>\\n <RequestId>18FB21E3-F423-4B84-BB63-D8887A29****</RequestId>\\n</RecoverClusterResponse> ","errorExample":""}]', + 'title' => 'RecoverCluster', + 'summary' => 'Resets and restores a cluster.', + 'description' => 'You can call the operation to reset and restore a cluster only when the cluster is in the Exception state. You can call the [ListClusters](~~87116~~) operation to query the ID and status of a cluster. We recommend that you export all job data before you restore a cluster. When you reset and restore a cluster, take note of the following impacts:'."\n" + ."\n" + .'* The system disks of all nodes are changed. By default, new system disks are configured based on the settings that you specified when the cluster was created.'."\n" + .'* The data on the system disks and data disks of all cluster nodes is lost. The data includes user information, job information, scheduler queue information, and configuration data of auto-scaling queues. However, the data on File Storage NAS file systems is retained.'."\n" + .'* The self-managed queues in the cluster are deleted. All nodes are retained and migrated to the default queue of the cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteCluster' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '75793', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to obtain cluster IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-QKKVqO****', + ], + ], + [ + 'name' => 'ReleaseInstance', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to release Elastic Compute Service (ECS) instances that are created by using Elastic High Performance Computing (E-HPC).'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'enum' => [ + 'true', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'F1AB6D8D-E185-4D94-859C-7CE7B8B7****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F1AB6D8D-E185-4D94-859C-7CE7B8B7****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"F1AB6D8D-E185-4D94-859C-7CE7B8B7****\\",\\n \\"RequestId\\": \\"F1AB6D8D-E185-4D94-859C-7CE7B8B7****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteClusterResponse>\\n <TaskId>F1AB6D8D-E185-4D94-859C-7CE7B8B7****</TaskId>\\n <RequestId>F1AB6D8D-E185-4D94-859C-7CE7B8B7****</RequestId>\\n</DeleteClusterResponse>","errorExample":""}]', + 'title' => 'DeleteCluster', + 'summary' => 'Releases a cluster.', + 'description' => 'After a cluster is released, the pay-as-you-go nodes and the subscription nodes that are expired are automatically released. The subscription nodes that are expired are retained. If you need to release subscription nodes that are not expired, change the billing method to pay-as-you-go. Before you release a cluster, make sure that you no longer use the cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateHybridCluster' => [ + 'summary' => 'Creates a hybrid cloud cluster.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the cluster. The name must be 2 to 64 characters in length, and can contain only letters, digits, hyphens (-), and underscores (\\_). It must start with a letter.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hybridcluster', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the E-HPC cluster. The description must be 2 to 256 characters in length and cannot start with `http://` or` https://`.'."\n" + ."\n" + .'This parameter is empty by default.', + 'type' => 'string', + 'required' => false, + 'example' => 'TestDescription', + ], + ], + [ + 'name' => 'EhpcVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of E-HPC. By default, the latest version is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the client. By default, the latest version is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0.64', + ], + ], + [ + 'name' => 'OsTag', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image tag of the operating system. You can call the [ListImages](~~87213~~) operation to query the image tag.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the domain account service. Valid values:'."\n" + ."\n" + .'* nis'."\n" + .'* ldap'."\n" + ."\n" + .'Default value: nis.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nis', + ], + ], + [ + 'name' => 'Location', + 'in' => 'query', + 'schema' => [ + 'description' => 'The location where the cluster resides. Set the value to OnPremise.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OnPremise', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'You can select an existing security group by its ID.'."\n" + ."\n" + .'> If you specify this parameter, you cannot specify the `SecurityGroupName` parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp13n61xsydodfyg****', + ], + ], + [ + 'name' => 'SecurityGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'If you do not use an existing security group, set the parameter to the name of a new security group. A default policy is applied to the new security group.'."\n" + ."\n" + .'> If you specify this parameter, you cannot specify the `SecurityGroupId` parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-SecurityGroup', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the E-HPC cluster belongs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-b3f3edefefeep0760yju****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch to which the instance connects to.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + ], + [ + 'name' => 'EcsOrder.Manager.InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the management node. Only Proxy Mode is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'EcsOrder.Compute.InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the compute nodes.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'VolumeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the file system. Only NAS file systems are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NAS', + 'default' => 'nas', + ], + ], + [ + 'name' => 'VolumeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the file system. NAS file systems cannot be automatically created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '008b64****', + ], + ], + [ + 'name' => 'VolumeProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the protocol that is used by the NAS file system. Only NFS is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NFS', + 'default' => 'nfs', + ], + ], + [ + 'name' => 'VolumeMountpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mount target of the NAS file system. The mount target is of the VPC type. Mount targets cannot be automatically created for NAS file systems.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com', + ], + ], + [ + 'name' => 'RemoteDirectory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The remote directory to which the file system is mounted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/RemoteDirectory', + ], + ], + [ + 'name' => 'OnPremiseVolumeProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the protocol that is used by the on-premises file system. Only NFS is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NFS', + ], + ], + [ + 'name' => 'OnPremiseVolumeMountPoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mount target of the on-premises file system.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RemoteNasDomain.com', + ], + ], + [ + 'name' => 'OnPremiseVolumeRemotePath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mount path of the on-premises file system.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => ' /RemoteDirectory', + ], + ], + [ + 'name' => 'OnPremiseVolumeLocalPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path in which the on-premises file system is mounted on the nodes on the cloud.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/OnCloudDirectory', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The root password of the logon node. The password must be 8 to 30 characters in length and contain at least three of the following items: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported: `() ~ ! @ # $ % ^ & * - = + | { } [ ] : ; ‘ < > , . ? /`'."\n" + ."\n" + .'> We recommend that you use HTTPS to call the API operation to prevent password leakage.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123****', + ], + ], + [ + 'name' => 'KeyPairName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the key pair. The name must be 2 to 128 characters in length, and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). It must start with a letter and cannot start with http:// or https://.[](http://https://。、（:）、（\\_）（-）。)'."\n" + ."\n" + .'> To use an SSH key pair, see [Create an SSH key pair](~~51793~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The default queue of the scale-out nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxazb4ph****', + ], + ], + [ + 'name' => 'HybridClusterOpMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode in which the proxy node manages the offline nodes. Valid values:'."\n" + ."\n" + .'* SSH: indicates management via SSH logon.'."\n" + .'* CA: indicates management through Cloud Assistant.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SSH', + ], + ], + [ + 'name' => 'SchedulerPreInstall', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the scheduler is preinstalled for the image. Valid values:'."\n" + ."\n" + .'* true: The scheduler is preinstalled. When you create or add a node, you do not need to install the scheduler.'."\n" + .'* false: The scheduler is not preinstalled. When you create or add a cluster, you must install the scheduler.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ComputeSpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The preemption policy of the compute nodes. Valid values:'."\n" + ."\n" + .'* NoSpot: The compute nodes are pay-as-you-go instances.'."\n" + .'* SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + ], + [ + 'name' => 'ComputeSpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum hourly price for the ECS instance under the compute node. A maximum of three decimal places can be used in the value of the parameter. The parameter is valid only when the ComputeSpotStrategy parameter is set to SpotWithPriceLimit.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.034', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the image. Valid values:'."\n" + ."\n" + .'* system: public image'."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n" + .'* marketplace: Alibaba Cloud Marketplace image'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the images.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'wi_1607_x64_dtc_zh_40G_alibase****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How do I ensure the idempotence of a request?](~~25693~~)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'MultiOs', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the cluster supports multiple operating systems. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the nodes in the local cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The array of node information.'."\n", + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => [ + 'description' => 'The scheduler type of the on-premises node in the cluster. Valid values:'."\n" + ."\n" + .'* pbs'."\n" + .'* slurm'."\n" + .'* opengridscheduler'."\n" + .'* deadline'."\n" + ."\n" + .'Default value: pbs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pbs', + ], + 'IpAddress' => [ + 'description' => 'The IP address of the on-premises node in the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '00b648b****', + ], + 'HostName' => [ + 'description' => 'The hostname of the on-premises node in the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + 'Role' => [ + 'description' => 'The role of the on-premises node in the cluster. Valid values:'."\n" + ."\n" + .'* Manager: management node'."\n" + .'* Login: logon node'."\n" + .'* Compute: compute node'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Compute', + ], + 'AccountType' => [ + 'description' => 'The service type of the domain account to which the on-premises node in the cluster belongs. Valid values:'."\n" + ."\n" + .'* nis'."\n" + .'* ldap'."\n" + ."\n" + .'Default value: nis.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nis', + ], + 'Dir' => [ + 'description' => 'The directory of the on-premises node in the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/opt/sge/default/', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Application', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'An array that consists of the information about the software.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'description' => 'The tag of the software.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OpenMPI_11.1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PostInstallScript', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of post-installation script information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => 'The parameter that is used to run the script after the cluster is created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'bash file.sh', + ], + 'Url' => [ + 'description' => 'The full path of the post-installation script.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/opt/job.sh', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'Plugin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode configurations of the plug-in. This parameter takes effect only when the SchedulerType parameter is set to custom.'."\n" + ."\n" + .'The value must be a JSON string. The parameter contains the following parameters: pluginMod, pluginLocalPath, and pluginOssPath.'."\n" + ."\n" + .'* pluginMod: the mode of the plug-in. The following modes are supported:'."\n" + ."\n" + .' * oss: The plug-in is downloaded and decompressed from OSS to a local path. The local path is specified by the pluginLocalPath parameter.'."\n" + .' * image: By default, the plug-in is stored in a pre-defined local path. The local path is specified by the pluginLocalPath parameter.'."\n" + ."\n" + .'* pluginLocalPath: the local path where the plug-in is stored. We recommend that you select a shared directory in oss mode and a non-shared directory in image mode.'."\n" + ."\n" + .'* pluginOssPath: the remote path where the plug-in is stored in OSS. This parameter takes effect only when the pluginMod parameter is set to oss.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"pluginMod": "oss","pluginLocalPath": "/opt/plugin","pluginOssPath": "https://bucket.oss-cn-hangzhou.aliyuncs.com/plugin/plugin.tgz"}', + ], + ], + [ + 'name' => 'OpenldapPar', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The parameter that is used to connect to the OpenLDAP server.'."\n", + 'type' => 'object', + 'properties' => [ + 'LdapServerIp' => [ + 'description' => 'The IP address of the LDAP server.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.2', + ], + 'BaseDn' => [ + 'description' => 'The BaseDN of the LDAP server.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpctest', + ], + 'FallbackHomeDir' => [ + 'description' => 'The home directory of the Linux server.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/home', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'WinAdPar', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The parameter that is used to connect to the Windows AD server.'."\n", + 'type' => 'object', + 'properties' => [ + 'AdUser' => [ + 'description' => 'The AD user.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Administrator', + ], + 'AdUserPasswd' => [ + 'description' => 'The password of the AD user.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxx', + ], + 'AdDc' => [ + 'description' => 'The name of the AD domain.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ad-hybrid001.ehpcad.com', + ], + 'AdIp' => [ + 'description' => 'The IP address of the AD domain.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C0842122', + ], + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C0842122', + ], + 'ClusterId' => [ + 'description' => 'The ID of cluster.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'OrderError.InsufficientBalance', + 'errorMessage' => 'The account balance is insufficient. Please add funds first and try again.', + ], + [ + 'errorCode' => 'OrderError.InstHasUnpaidOrder', + 'errorMessage' => 'Your account has an unpaid order.', + ], + [ + 'errorCode' => 'OrderError.Arrearage', + 'errorMessage' => 'Your account balance is less than CNY 100. Please add funds to your account and try again.', + ], + [ + 'errorCode' => 'OrderError.NoCard', + 'errorMessage' => 'No credit card is bound to your account.', + ], + [ + 'errorCode' => 'OrderError.InvalidPayMethod', + 'errorMessage' => 'No valid default payment method is specified for your account.', + ], + [ + 'errorCode' => 'OrderError.NoRealNameAuthentication', + 'errorMessage' => 'You have not completed the real name authentication.', + ], + [ + 'errorCode' => 'OrderError.NoRealNameRegistration', + 'errorMessage' => 'Real name registration is required for instances launched in mainland China.', + ], + [ + 'errorCode' => 'OrderError.UserProfileIncomplete', + 'errorMessage' => 'You have not completed your user profile.', + ], + [ + 'errorCode' => 'InvalidVpc', + 'errorMessage' => 'The specified VPC is invalid.', + ], + [ + 'errorCode' => 'InvalidVolume', + 'errorMessage' => 'The specified volume is invalid.', + ], + [ + 'errorCode' => 'InvalidSoftware', + 'errorMessage' => 'The specified software is not supported.', + ], + [ + 'errorCode' => 'InvalidVolumeProtocal', + 'errorMessage' => 'The specified volume protocol is invalid.', + ], + [ + 'errorCode' => 'InvalidVolumeMountpoint', + 'errorMessage' => 'The specified volume mount point is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'TooManyClusters', + 'errorMessage' => 'The number of user clusters exceeds the quota.', + ], + [ + 'errorCode' => 'TooManyComputes', + 'errorMessage' => 'The number of computing nodes exceeds the quota.', + ], + [ + 'errorCode' => 'TooManyLogins', + 'errorMessage' => 'The maximum number of logged on nodes is exceeded.', + ], + [ + 'errorCode' => 'TooManyScc', + 'errorMessage' => 'The maximum number of SCC instances is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceeded.PrivateIpAddress', + 'errorMessage' => 'Insufficient private IP addresses in vSwitch: %s.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'ImageNotSupported', + 'errorMessage' => 'The specified image is not supported.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + [ + 'errorCode' => 'VolumeNotFound', + 'errorMessage' => 'The specified volume does not exist.', + ], + [ + 'errorCode' => 'VpcNotFound', + 'errorMessage' => 'The specified VPC does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'NasError', + 'errorMessage' => 'NAS API request failed.', + ], + [ + 'errorCode' => 'NasServiceNotOpen', + 'errorMessage' => 'The NAS service is not activated.', + ], + [ + 'errorCode' => 'EipError', + 'errorMessage' => 'The EIP API request failed.', + ], + [ + 'errorCode' => 'OrderError', + 'errorMessage' => 'An order request error occurred.', + ], + [ + 'errorCode' => 'FailToGenId', + 'errorMessage' => 'Generating cluster ID failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F6757FA4-8FED-4602-B7F5-3550C0842122\\",\\n \\"TaskId\\": \\"F6757FA4-8FED-4602-B7F5-3550C0842122\\",\\n \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateHybridClusterResponse>\\r\\n <RequestId>F6757FA4-8FED-4602-B7F5-3550C0842122</RequestId>\\r\\n <TaskId>F6757FA4-8FED-4602-B7F5-3550C0842122</TaskId>\\r\\n <ClusterId>ehpc-hz-FYUr32****</ClusterId>\\r\\n</CreateHybridClusterResponse>","errorExample":""}]', + 'title' => 'CreateHybridCluster', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddLocalNodes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The information of the local node. A JSON string that contains the HostName, IpAddress, CpuCores, and Memory (Unit: MB) of the local node.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"HostName":"test-HostName","IpAddress":"192.168.**.**"},{"CpuCores":2,"Memory":1024}]', + ], + ], + [ + 'name' => 'Queue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The queue to which to add the local node.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test.q', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The local nodes in the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[{"HostName":"test-HostName","IpAddress":"192.168.**.**"},{"CpuCores":2,"Memory":1024}]', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'InvalidOpt', + 'errorMessage' => 'The specified operation is invalid. Please try again later. If the problem still exists, submit a ticket.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'VolumeNotFound', + 'errorMessage' => 'The specified volume does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"[{\\\\\\"HostName\\\\\\":\\\\\\"test-HostName\\\\\\",\\\\\\"IpAddress\\\\\\":\\\\\\"192.168.**.**\\\\\\"},{\\\\\\"CpuCores\\\\\\":2,\\\\\\"Memory\\\\\\":1024}]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddLocalNodesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <InstanceIds>[{\\"HostName\\":\\"test-HostName\\",\\"IpAddress\\":\\"192.168.**.**\\"},{\\"CpuCores\\":2,\\"Memory\\":1024}]</InstanceIds>\\n</AddLocalNodesResponse>","errorExample":""}]', + 'title' => 'AddLocalNodes', + 'summary' => 'Adds local nodes to a specified cluster on hybrid cloud or cluster on the cloud.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetHybridClusterConfig' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Node', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the on-premises compute node. You can call this operation to query the configurations of the on-premises compute node.'."\n" + ."\n" + .'By default, the operation queries the configurations of a cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testNode', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterConfig' => [ + 'description' => 'The configurations returned.'."\n" + ."\n" + .'* If the parameter Node is null, you can obtain the configurations of the hybrid cloud cluster.'."\n" + .'* If the parameter Node is a specified on-premises compute node, you can obtain the configurations of the on-premises compute node.'."\n" + ."\n" + .'This parameter is returned in the ini format. You can use this parameter to configure on-premises cluster nodes.'."\n", + 'type' => 'string', + 'example' => 'ClNjaGcyI6W119Cg****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'InvalidOpt', + 'errorMessage' => 'The specified operation is invalid. Please try again later. If the problem still exists, submit a ticket.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClusterConfig\\": \\"ClNjaGcyI6W119Cg****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<AddLocalNodesResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n <ClusterConfig>ClNjaGcyI6W119Cg****</ClusterConfig>\\r\\n</AddLocalNodesResponse>","errorExample":""}]', + 'title' => 'GetHybridClusterConfig', + 'summary' => 'Queries the configurations of a specified hybrid cloud cluster or a specified compute node.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SyncUsers' => [ + 'summary' => 'Synchronizes local cluster users to a hybrid cloud cluster in hybrid-cloud proxy mode.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'You can call the [ListRegions](~~188593~~) operation to query the list of regions where E-HPC is supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the list of E-HPC clusters.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-gh5WKb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The parameters are invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + ], + [ + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError.Account.UserSynFailure', + 'errorMessage' => 'synchronize users failed: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<SyncUsersResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n</SyncUsersResponse>","errorExample":""}]', + 'title' => 'SyncUsers', + ], + 'ListPreferredEcsTypes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The bidding policy of the ECS instance. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + 'default' => 'NoSpot', + ], + ], + [ + 'name' => 'InstanceChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the ECS instances. Valid values:'."\n" + ."\n" + .'* PostPaid'."\n" + .'* PrePaid'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'default' => 'PostPaid', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SupportSpotInstance' => [ + 'description' => 'Indicates whether preemptible instances are supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Series' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SeriesInfo' => [ + 'description' => 'The list of recommended ECS instances. Each SeriesInfo element contains the recommended ECS instance types for various nodes in the E-HPC cluster.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SeriesName' => [ + 'description' => 'The name of the instance series. Valid values:'."\n" + ."\n" + .'* SeriesHighCompute'."\n" + .'* SeriesHighMem'."\n" + .'* SeriesGPU'."\n" + .'* SeriesAll'."\n", + 'type' => 'string', + 'example' => 'SeriesAll', + ], + 'SeriesId' => [ + 'description' => 'The ID of the ECS instance series. Valid values:'."\n" + ."\n" + .'* HighCompute: compute-optimized instance families'."\n" + .'* HighMem: memory-optimized instance families'."\n" + .'* GPU: GPU-accelerated instance families'."\n" + .'* All: all instance families'."\n", + 'type' => 'string', + 'example' => 'All', + ], + 'Roles' => [ + 'description' => 'Recommended instance types for nodes in an E-HPC cluser.'."\n", + 'type' => 'object', + 'properties' => [ + 'Manager' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceTypeId' => [ + 'description' => 'The list of recommended ECS instance types for management nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of recommended ECS instance types for management nodes.'."\n", + 'type' => 'string', + 'example' => '[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]', + ], + ], + ], + ], + 'Compute' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceTypeId' => [ + 'description' => 'The list of recommended ECS instance types for compute nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of recommended ECS instance types for compute nodes.'."\n", + 'type' => 'string', + 'example' => '[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]', + ], + ], + ], + ], + 'Login' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceTypeId' => [ + 'description' => 'The list of recommended ECS instance types for logon nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of recommended ECS instance types for logon nodes.'."\n", + 'type' => 'string', + 'example' => '[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]', + ], + ], + ], + ], + ], + ], + ], + 'description' => 'The list of recommended ECS instances. Each SeriesInfo element contains the recommended ECS instance types for various nodes in the E-HPC cluster.', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SupportSpotInstance\\": true,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Series\\": {\\n \\"SeriesInfo\\": [\\n {\\n \\"SeriesName\\": \\"SeriesAll\\",\\n \\"SeriesId\\": \\"All\\",\\n \\"Roles\\": {\\n \\"Manager\\": {\\n \\"InstanceTypeId\\": [\\n \\"[ \\\\\\"ecs.sn1ne.2xlarge\\\\\\", \\\\\\"ecs.sn1ne.4xlarge\\\\\\", \\\\\\"ecs.n1.tiny\\\\\\" ]\\"\\n ]\\n },\\n \\"Compute\\": {\\n \\"InstanceTypeId\\": [\\n \\"[ \\\\\\"ecs.sn1ne.2xlarge\\\\\\", \\\\\\"ecs.sn1ne.4xlarge\\\\\\", \\\\\\"ecs.n1.tiny\\\\\\" ]\\"\\n ]\\n },\\n \\"Login\\": {\\n \\"InstanceTypeId\\": [\\n \\"[ \\\\\\"ecs.sn1ne.2xlarge\\\\\\", \\\\\\"ecs.sn1ne.4xlarge\\\\\\", \\\\\\"ecs.n1.tiny\\\\\\" ]\\"\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListPreferredEcsTypesResponse>\\n <SupportSpotInstance>true</SupportSpotInstance>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <Series>\\n <SeriesName>SeriesAll</SeriesName>\\n <SeriesId>All</SeriesId>\\n <Roles>\\n <Manager>[ \\"ecs.sn1ne.2xlarge\\", \\"ecs.sn1ne.4xlarge\\", \\"ecs.n1.tiny\\" ]</Manager>\\n <Compute>[ \\"ecs.sn1ne.2xlarge\\", \\"ecs.sn1ne.4xlarge\\", \\"ecs.n1.tiny\\" ]</Compute>\\n <Login>[ \\"ecs.sn1ne.2xlarge\\", \\"ecs.sn1ne.4xlarge\\", \\"ecs.n1.tiny\\" ]</Login>\\n </Roles>\\n </Series>\\n</ListPreferredEcsTypesResponse>","errorExample":""}]', + 'title' => 'ListPreferredEcsTypes', + 'summary' => 'Queries the Elastic Compute Service (ECS) instance types recommended by Elastic High Performance Computing (E-HPC).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListAvailableEcsTypes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The preemption policy of the ECS instances. Valid values:'."\n" + ."\n" + .'* NoSpot: The ECS instances are pay-as-you-go instances.'."\n" + .'* SpotWithPriceLimit: The ECS instances are preemptible instances that have a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + 'default' => 'NoSpot', + ], + ], + [ + 'name' => 'InstanceChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the ECS instances. Valid values:'."\n" + ."\n" + .'* PostPaid: pay-as-you-go'."\n" + .'* PrePaid: subscription'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'default' => 'PostPaid', + ], + ], + [ + 'name' => 'ShowSoldOut', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the ECS instances are sold out. Valid values:'."\n" + ."\n" + .'* false: available'."\n" + .'* true: sold out'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SupportSpotInstance' => [ + 'description' => 'Specifies whether preemptible instances are supported. Valid values:'."\n" + ."\n" + .'* false: not supported'."\n" + .'* true: supported'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D9DD3AF8-1F91-4075-8669-55D10E45****', + ], + 'InstanceTypeFamilies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceTypeFamilyInfo' => [ + 'description' => 'The instance family to which the instance type belongs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Generation' => [ + 'description' => 'The instance family.'."\n", + 'type' => 'string', + 'example' => 'ecs-3', + ], + 'InstanceTypeFamilyId' => [ + 'description' => 'The ID of the instance family. For more information, see [Instance families](~~25378~~).'."\n", + 'type' => 'string', + 'example' => 'ecs.n4', + ], + 'Types' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TypesInfo' => [ + 'description' => 'The list of instance types.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the ECS instance. Valid values:'."\n" + ."\n" + .'* SoldOut'."\n" + .'* Available'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'InstanceTypeId' => [ + 'description' => 'The ID of the ECS instance type.'."\n", + 'type' => 'string', + 'example' => 'ecs.n4.xlarge', + ], + 'InstanceBandwidthRx' => [ + 'description' => 'The maximum inbound internal bandwidth. Unit: Kbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10240000', + ], + 'GPUSpec' => [ + 'description' => 'The GPU type of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'NVIDIA V100', + ], + 'InstanceBandwidthTx' => [ + 'description' => 'The maximum outbound internal bandwidth. Unit: Kbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10240000', + ], + 'InstancePpsRx' => [ + 'description' => 'The inbound packet forwarding rate over the internal network. Unit: pps.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9000000', + ], + 'InstancePpsTx' => [ + 'description' => 'The outbound packet forwarding rate over the internal network. Unit: pps.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9000000', + ], + 'GPUAmount' => [ + 'description' => 'The number of GPUs of an ECS instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CpuCoreCount' => [ + 'description' => 'The number of vCPUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'MemorySize' => [ + 'description' => 'The memory size of the ECS instance. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'EniQuantity' => [ + 'description' => 'The maximum number of elastic network interfaces (ENIs) that can be bound to an ECS instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ZoneIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The list of zone IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SupportSpotInstance\\": false,\\n \\"RequestId\\": \\"D9DD3AF8-1F91-4075-8669-55D10E45****\\",\\n \\"InstanceTypeFamilies\\": {\\n \\"InstanceTypeFamilyInfo\\": [\\n {\\n \\"Generation\\": \\"ecs-3\\",\\n \\"InstanceTypeFamilyId\\": \\"ecs.n4\\",\\n \\"Types\\": {\\n \\"TypesInfo\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"InstanceTypeId\\": \\"ecs.n4.xlarge\\",\\n \\"InstanceBandwidthRx\\": 10240000,\\n \\"GPUSpec\\": \\"NVIDIA V100\\",\\n \\"InstanceBandwidthTx\\": 10240000,\\n \\"InstancePpsRx\\": 9000000,\\n \\"InstancePpsTx\\": 9000000,\\n \\"GPUAmount\\": 2,\\n \\"CpuCoreCount\\": 4,\\n \\"MemorySize\\": 8,\\n \\"EniQuantity\\": 2,\\n \\"ZoneIds\\": {\\n \\"ZoneId\\": [\\n \\"cn-hangzhou-b\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListAvailableEcsTypesResponse>\\n<SupportSpotInstance>false</SupportSpotInstance>\\n<RequestId>D9DD3AF8-1F91-4075-8669-55D10E45****</RequestId>\\n<InstanceTypeFamilies>\\n <InstanceTypeFamilyInfo>\\n <InstanceTypeFamilyId>ecs.n4</InstanceTypeFamilyId>\\n <Generation>ecs-3</Generation>\\n <Types>\\n <TypesInfo>\\n <Status>Available</Status>\\n <InstancePpsTx>9000000</InstancePpsTx>\\n <MemorySize>8</MemorySize>\\n <GPUSpec>NVIDIA V100</GPUSpec>\\n <CpuCoreCount>4</CpuCoreCount>\\n <InstancePpsRx>9000000</InstancePpsRx>\\n <InstanceTypeId>ecs.n4.xlarge</InstanceTypeId>\\n <EniQuantity>2</EniQuantity>\\n <InstanceBandwidthRx>10240000</InstanceBandwidthRx>\\n <GPUAmount>2</GPUAmount>\\n <InstanceBandwidthTx>10240000</InstanceBandwidthTx>\\n <ZoneIds>\\n <ZoneId>cn-hangzhou-b</ZoneId>\\n </ZoneIds>\\n </TypesInfo>\\n </Types>\\n </InstanceTypeFamilyInfo>\\n</InstanceTypeFamilies>\\n</ListAvailableEcsTypesResponse>","errorExample":""}]', + 'title' => 'ListAvailableEcsTypes', + 'summary' => 'Queries available Elastic Compute Service (ECS) instance types.', + 'extraInfo' => ' ', + ], + 'GetIfEcsTypeSupportHtConfig' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Elastic Compute Service (ECS) instance type.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecs.g6.large', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '80CA7A93-7291-4402-B63D-86DF334E0A1F', + ], + 'DefaultHtEnabled' => [ + 'description' => 'Indicates whether Hyper-Threading is enabled by default. Valid values:'."\n" + ."\n" + .'* true: Hyper-Threading is enabled by default.'."\n" + .'* false: Hyper-Threading is disabled by default.'."\n" + ."\n" + .'> By default, Hyper-Threading is not enabled for Super Computing Cluster (SCC) instance families but is enabled for other instance families.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceType' => [ + 'description' => 'The ECS instance type.'."\n", + 'type' => 'string', + 'example' => 'ecs.g6.large', + ], + 'SupportHtConfig' => [ + 'description' => 'Indicates whether hyper-threading is supported. Valid values:'."\n" + ."\n" + .'* true: Hyper-threading is supported.'."\n" + .'* false: Hyper-threading is not supported.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"80CA7A93-7291-4402-B63D-86DF334E0A1F\\",\\n \\"DefaultHtEnabled\\": true,\\n \\"InstanceType\\": \\"ecs.g6.large\\",\\n \\"SupportHtConfig\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetIfEcsTypeSupportHtConfigResponse>\\n <RequestId>80CA7A93-7291-4402-B63D-86DF334E0A1F</RequestId> \\n <DefaultHtEnabled>true</DefaultHtEnabled>\\n <SupportHtConfig>true</SupportHtConfig>\\n <InstanceType>ecs.g6.large</InstanceType>\\n</GetIfEcsTypeSupportHtConfigResponse>","errorExample":""}]', + 'title' => 'GetIfEcsTypeSupportHtConfig', + 'summary' => 'Queries whether hyper-threading can be enabled or disabled for an instance type.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListImages' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BaseOsTag', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image tag of the operating system. The tag is used only for management nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type.'."\n" + ."\n" + .'* If a value is passed to the parameter, the list of images that are supported by the specified instance type is queried.'."\n" + .'* If no value is passed to the parameter, the list of images that are supported by all instance types is queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.medium', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'OsTags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OsInfo' => [ + 'description' => 'The list of images that are supported by E-HPC.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => 'The version of the operating system.'."\n", + 'type' => 'string', + 'example' => '7.2', + ], + 'BaseOsTag' => [ + 'description' => 'The image tag of the operating system. The tag is used only for management nodes.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Platform' => [ + 'description' => 'The operating system. Valid values:'."\n" + ."\n" + .'* CentOS'."\n" + .'* windows'."\n", + 'type' => 'string', + 'example' => 'CentOS', + ], + 'OsTag' => [ + 'description' => 'The tag that is added to the image.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'ImageId' => [ + 'description' => 'The ID of the image.'."\n", + 'type' => 'string', + 'example' => 'm-bp1h8aoe73p71iow****', + ], + 'Architecture' => [ + 'description' => 'The architecture of the operating system. Valid values:'."\n" + ."\n" + .'* i386'."\n" + .'* x86\\_64'."\n", + 'type' => 'string', + 'example' => 'i386', + ], + 'OSName' => [ + 'description' => 'The name of the image.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'OSNameEn' => [ + 'description' => 'The name of the image in English.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"OsTags\\": {\\n \\"OsInfo\\": [\\n {\\n \\"Version\\": \\"7.2\\",\\n \\"BaseOsTag\\": \\"CentOS_7.2_64\\",\\n \\"Platform\\": \\"CentOS\\",\\n \\"OsTag\\": \\"CentOS_7.2_64\\",\\n \\"ImageId\\": \\"m-bp1h8aoe73p71iow****\\",\\n \\"Architecture\\": \\"i386\\",\\n \\"OSName\\": \\"CentOS_7.2_64\\",\\n \\"OSNameEn\\": \\"CentOS_7.2_64\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListImagesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n <OsTags>\\n <Version>7.2</Version>\\n <BaseOsTag>CentOS_7.2_64</BaseOsTag>\\n <Platform>CentOS</Platform>\\n <OsTag>CentOS_7.2_64</OsTag>\\n <ImageId>m-bp1h8aoe73p71iow****</ImageId>\\n <Architecture>i386</Architecture>\\n <OSName>CentOS_7.2_64</OSName>\\n <OSNameEn>CentOS_7.2_64</OSNameEn>\\n </OsTags>\\n</ListImagesResponse>","errorExample":""}]', + 'title' => 'ListImages', + 'summary' => 'Queries the list of images that can be installed in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListCustomImages' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image source. Valid values:'."\n" + ."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'self', + ], + ], + [ + 'name' => 'BaseOsTag', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image tag of the operating system. The tag is used only for management nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the Elastic Compute Service (ECS) instance. If you do not specify the instance type, the community images that are supported by all instance types are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'* If you specify a value for this parameter, all community images in the region where the cluster resides are queried.'."\n" + .'* If you do not specify a value for this parameter, the community images that are supported by all clusters are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Images' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ImageInfo' => [ + 'description' => 'The list of community images, including custom images and shared images.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '> This parameter is not publicly available.'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'PostInstallScript' => [ + 'description' => '> This parameter is not publicly available.'."\n", + 'type' => 'string', + 'example' => 'example.sh', + ], + 'Description' => [ + 'description' => 'The description of the image.'."\n", + 'type' => 'string', + 'example' => 'ExampleDescription', + ], + 'Size' => [ + 'description' => 'The size of the image. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'ImageOwnerAlias' => [ + 'description' => 'The type of the image. Valid values:'."\n" + ."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n", + 'type' => 'string', + 'example' => 'self', + ], + 'ImageName' => [ + 'description' => 'The name of the image.'."\n", + 'type' => 'string', + 'example' => 'CHESS5V5.0.27', + ], + 'SkuCode' => [ + 'description' => '> This parameter is not publicly available.'."\n", + 'type' => 'string', + 'example' => 'ECS', + ], + 'PricingCycle' => [ + 'description' => '> This parameter is not publicly available.'."\n", + 'type' => 'string', + 'example' => 'Month', + ], + 'ImageId' => [ + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'm-bp181x855551ww5yq****', + ], + 'ProductCode' => [ + 'description' => '> This parameter is not publicly available.'."\n", + 'type' => 'string', + 'example' => 'cmjj028279', + ], + 'Uid' => [ + 'description' => '> This parameter is not publicly available.'."\n", + 'type' => 'string', + 'example' => '127****', + ], + 'BaseOsTag' => [ + 'description' => 'The image tag of the operating system.'."\n", + 'type' => 'object', + 'properties' => [ + 'Platform' => [ + 'description' => 'The OS. Valid values:'."\n" + ."\n" + .'* CentOS'."\n" + .'* windows'."\n", + 'type' => 'string', + 'example' => 'CentOS', + ], + 'OsTag' => [ + 'description' => 'The tags of the image.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Version' => [ + 'description' => 'The version of the operating system.'."\n", + 'type' => 'string', + 'example' => '7.2', + ], + 'Architecture' => [ + 'description' => 'The architecture of the operating system. Valid values:'."\n" + ."\n" + .'* i386'."\n" + .'* x86\\_64'."\n", + 'type' => 'string', + 'example' => 'i386', + ], + ], + ], + 'OsTag' => [ + 'description' => 'An array of system images that are supported by E-HPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'Platform' => [ + 'description' => 'The OS.'."\n", + 'type' => 'string', + 'example' => 'CentOS', + ], + 'OsTag' => [ + 'description' => 'The tag of the image.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Version' => [ + 'description' => 'The version of the operating system.'."\n", + 'type' => 'string', + 'example' => '7.2', + ], + 'Architecture' => [ + 'description' => 'The architecture of the operating system. Valid values:'."\n" + ."\n" + .'* i386'."\n" + .'* x86\\_64'."\n", + 'type' => 'string', + 'example' => 'x86_64', + ], + 'BaseOsTag' => [ + 'description' => 'The image tag of the operating system.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"Images\\": {\\n \\"ImageInfo\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"PostInstallScript\\": \\"example.sh\\",\\n \\"Description\\": \\"ExampleDescription\\",\\n \\"Size\\": 40,\\n \\"ImageOwnerAlias\\": \\"self\\",\\n \\"ImageName\\": \\"CHESS5V5.0.27\\",\\n \\"SkuCode\\": \\"ECS\\",\\n \\"PricingCycle\\": \\"Month\\",\\n \\"ImageId\\": \\"m-bp181x855551ww5yq****\\",\\n \\"ProductCode\\": \\"cmjj028279\\",\\n \\"Uid\\": \\"127****\\",\\n \\"BaseOsTag\\": {\\n \\"Platform\\": \\"CentOS\\",\\n \\"OsTag\\": \\"CentOS_7.2_64\\",\\n \\"Version\\": \\"7.2\\",\\n \\"Architecture\\": \\"i386\\"\\n },\\n \\"OsTag\\": {\\n \\"Platform\\": \\"CentOS\\",\\n \\"OsTag\\": \\"CentOS_7.2_64\\",\\n \\"Version\\": \\"7.2\\",\\n \\"Architecture\\": \\"x86_64\\",\\n \\"BaseOsTag\\": \\"CentOS_7.2_64\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCustomImagesResponse>\\n<RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n<Images>\\n <ImageInfo>\\n <Status>Available</Status>\\n <ImageOwnerAlias>self</ImageOwnerAlias>\\n <ImageName>CHESS5V5.0.27</ImageName>\\n <Description>ExampleDescription</Description>\\n <Size>40</Size>\\n <ImageId>m-bp181x855551ww5yq****</ImageId>\\n <BaseOsTag>\\n <Architecture>i386</Architecture>\\n <Platform>CentOS</Platform>\\n <Version>7.2</Version>\\n <OsTag>CentOS_7.2_64</OsTag>\\n </BaseOsTag>\\n <OsTag>\\n <Architecture>x86_64</Architecture>\\n <Platform>CentOS</Platform>\\n <Version>7.2</Version>\\n <OsTag>CentOS_7.2_64</OsTag>\\n <BaseOsTag>CentOS_7.2_64</BaseOsTag>\\n </OsTag>\\n </ImageInfo>\\n</Images>\\n</ListCustomImagesResponse>","errorExample":""}]', + 'title' => 'ListCustomImages', + 'summary' => 'Queries custom images and shared images supported by Elastic High Performance Computing (E-HPC).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListCommunityImages' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BaseOsTag', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag of the base operating system (BOS).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the Elastic Compute Service (ECS) instance. If you do not specify the instance type, the community images that are supported by all instance types are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster. If the cluster supports multiple operating systems, all community images in the region where the cluster resides are queried.'."\n" + ."\n" + .'If you do not specify the cluster ID, the community images that are supported by all clusters are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Images' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ImageInfo' => [ + 'description' => 'The list of custom images and shared images that are supported by the E-HPC.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The state of the image. Valid values:'."\n" + ."\n" + .'* UnAvailable'."\n" + .'* Available'."\n" + .'* Creating'."\n" + .'* CreateFailed'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'PostInstallScript' => [ + 'description' => 'The script that is run after the image is installed.'."\n", + 'type' => 'string', + 'example' => 'example.sh', + ], + 'Description' => [ + 'description' => 'The description of the image.'."\n", + 'type' => 'string', + 'example' => 'ExampleDescription', + ], + 'Size' => [ + 'description' => 'The size of the image. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'ImageOwnerAlias' => [ + 'description' => 'The image type. Valid values:'."\n" + ."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n", + 'type' => 'string', + 'example' => 'self', + ], + 'ImageName' => [ + 'description' => 'The image name.'."\n", + 'type' => 'string', + 'example' => 'linux_CentOS7.2_OceanBase_OBD_1ECS-3OB_3.0', + ], + 'SkuCode' => [ + 'description' => 'The stock keeping unit (SKU) of the image. Valid values:'."\n" + ."\n" + .'* ECS: pay-as-you-go'."\n" + .'* package: subscription'."\n", + 'type' => 'string', + 'example' => 'ECS', + ], + 'PricingCycle' => [ + 'description' => 'The billing unit of the image. Valid values:'."\n" + ."\n" + .'* Hour'."\n" + .'* Month'."\n" + .'* Year'."\n", + 'type' => 'string', + 'example' => 'Month', + ], + 'ImageId' => [ + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'm-bp181x855551ww5yq****', + ], + 'ProductCode' => [ + 'description' => 'The product code in Alibaba Cloud Marketplace.'."\n", + 'type' => 'string', + 'example' => 'cmjj028279', + ], + 'Uid' => [ + 'description' => 'The owner of the image.'."\n", + 'type' => 'string', + 'example' => '127****', + ], + 'BaseOsTag' => [ + 'description' => 'The tag of the BOS image.'."\n", + 'type' => 'object', + 'properties' => [ + 'Platform' => [ + 'description' => 'The distribution of the operating system. Valid values:'."\n" + ."\n" + .'* CentOS'."\n" + .'* Ubuntu'."\n" + .'* SUSE'."\n" + .'* OpenSUSE'."\n" + .'* Debian'."\n" + .'* CoreOS'."\n" + .'* Aliyun'."\n" + .'* Windows Server 2003'."\n" + .'* Windows Server 2008'."\n" + .'* Windows Server 2012'."\n" + .'* Others Linux'."\n" + .'* Customized Linux'."\n", + 'type' => 'string', + 'example' => 'CentOS', + ], + 'OsTag' => [ + 'description' => 'The operating system tag of the image.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Version' => [ + 'description' => 'The version of the operating system.'."\n", + 'type' => 'string', + 'example' => '7.2', + ], + 'Architecture' => [ + 'description' => 'The architecture of the operating system. Valid values:'."\n" + ."\n" + .'* i386'."\n" + .'* x86\\_64'."\n", + 'type' => 'string', + 'example' => 'x86_64', + ], + ], + ], + 'OsTag' => [ + 'description' => 'An array of OS images that are supported by E-HPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'Platform' => [ + 'description' => 'The OS.'."\n", + 'type' => 'string', + 'example' => 'CentOS', + ], + 'OsTag' => [ + 'description' => 'The operating system tag of the image.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Version' => [ + 'description' => 'The version of the operating system.'."\n", + 'type' => 'string', + 'example' => '7.2', + ], + 'Architecture' => [ + 'description' => 'The architecture of the operating system. Valid values:'."\n" + ."\n" + .'* i386'."\n" + .'* x86\\_64'."\n", + 'type' => 'string', + 'example' => 'x86_64', + ], + 'BaseOsTag' => [ + 'description' => 'The tag of the BOS image.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Images\\": {\\n \\"ImageInfo\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"PostInstallScript\\": \\"example.sh\\",\\n \\"Description\\": \\"ExampleDescription\\",\\n \\"Size\\": 40,\\n \\"ImageOwnerAlias\\": \\"self\\",\\n \\"ImageName\\": \\"linux_CentOS7.2_OceanBase_OBD_1ECS-3OB_3.0\\",\\n \\"SkuCode\\": \\"ECS\\",\\n \\"PricingCycle\\": \\"Month\\",\\n \\"ImageId\\": \\"m-bp181x855551ww5yq****\\",\\n \\"ProductCode\\": \\"cmjj028279\\",\\n \\"Uid\\": \\"127****\\",\\n \\"BaseOsTag\\": {\\n \\"Platform\\": \\"CentOS\\",\\n \\"OsTag\\": \\"CentOS_7.2_64\\",\\n \\"Version\\": \\"7.2\\",\\n \\"Architecture\\": \\"x86_64\\"\\n },\\n \\"OsTag\\": {\\n \\"Platform\\": \\"CentOS\\",\\n \\"OsTag\\": \\"CentOS_7.2_64\\",\\n \\"Version\\": \\"7.2\\",\\n \\"Architecture\\": \\"x86_64\\",\\n \\"BaseOsTag\\": \\"CentOS_7.2_64\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCommunityImagesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <Images>\\n <Status>Available</Status>\\n <PostInstallScript>example.sh</PostInstallScript>\\n <Description>ExampleDescription</Description>\\n <Size>40</Size>\\n <ImageOwnerAlias>self</ImageOwnerAlias>\\n <ImageName>linux_CentOS7.2_OceanBase_OBD_1ECS-3OB_3.0</ImageName>\\n <SkuCode>ECS</SkuCode>\\n <PricingCycle>Month</PricingCycle>\\n <ImageId>m-bp181x855551ww5yq****</ImageId>\\n <ProductCode>cmjj028279</ProductCode>\\n <Uid>127****</Uid>\\n <BaseOsTag>\\n <Platform>CentOS</Platform>\\n <OsTag>CentOS_7.2_64</OsTag>\\n <Version>7.2</Version>\\n <Architecture>x86_64</Architecture>\\n </BaseOsTag>\\n <OsTag>\\n <Platform>CentOS</Platform>\\n <OsTag>CentOS_7.2_64</OsTag>\\n <Version>7.2</Version>\\n <Architecture>x86_64</Architecture>\\n <BaseOsTag>CentOS_7.2_64</BaseOsTag>\\n </OsTag>\\n </Images>\\n</ListCommunityImagesResponse>","errorExample":""}]', + 'title' => 'ListCommunityImages', + 'summary' => 'Queries a list of community images.', + ], + 'DescribeImagePrice' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of an image.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'm-bp198jigq7l1ga11****', + ], + ], + [ + 'name' => 'PriceUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the subscription duration. Valid values:'."\n" + ."\n" + .'* Day'."\n" + .'* Month'."\n" + .'* Year'."\n" + ."\n" + .'Default value: Day.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Day', + ], + ], + [ + 'name' => 'SkuCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The stock keeping unit (SKU) of the image. Valid value: package.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'package', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The subscription duration of the read-only instance. Valid values:'."\n" + ."\n" + .'* If PriceUnit is set to Day, the valid values of the Period parameter are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, and 30.'."\n" + .'* If PriceUnit is set to Month, the valid values of the Period parameter are 1, 2, 3, 4, 5, 6, 7, 8, and 9.'."\n" + .'* If PriceUnit is set to Year, the valid values of the Period parameter are 1, 2, and 3.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Amount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of images that you want to purchase. Valid values: 1 to 1000.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the order. The order can be set only as a purchase order. Valid value: INSTANCE-BUY.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCE-BUY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Amount' => [ + 'description' => 'The number of instances that are purchased.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '47ca3ac4-2a03-48f1-8bf2-ba6de0f3****', + ], + 'DiscountPrice' => [ + 'description' => 'The discount.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'TradePrice' => [ + 'description' => 'The final price of the image.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'OriginalPrice' => [ + 'description' => 'The original price of the image.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'ImageId' => [ + 'description' => 'The ID of the custom image.'."\n", + 'type' => 'string', + 'example' => 'm-bp198jigq7l1ga11****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Amount\\": 1,\\n \\"RequestId\\": \\"47ca3ac4-2a03-48f1-8bf2-ba6de0f3****\\",\\n \\"DiscountPrice\\": 0,\\n \\"TradePrice\\": 0.8,\\n \\"OriginalPrice\\": 0.8,\\n \\"ImageId\\": \\"m-bp198jigq7l1ga11****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeImagePriceResponse>\\n <Amount>1</Amount>\\n <RequestId>47ca3ac4-2a03-48f1-8bf2-ba6de0f3****</RequestId>\\n <DiscountPrice>0</DiscountPrice>\\n <TradePrice>0.8</TradePrice>\\n <OriginalPrice>0.8</OriginalPrice>\\n <ImageId>m-bp198jigq7l1ga11****</ImageId>\\n</DescribeImagePriceResponse>","errorExample":""}]', + 'title' => 'DescribeImagePrice', + 'summary' => 'Queries the price of an Alibaba Cloud Marketplace image.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddUsers' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '75784', + 'abilityTreeNodes' => [ + 'FEATUREehpcG9MMN3', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to obtain the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The users. You can specify 1 to 100 users.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The array of user information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Password' => [ + 'description' => 'The password of the new user. The password must be 8 to 30 characters in length and must contain at least three of the following character types:'."\n" + ."\n" + .'* Uppercase letter'."\n" + .'* Lowercase letter'."\n" + .'* Digit'."\n" + .'* Special character: `()~!@#$%^&*-_+=|{}[]:;\'/<>,.?/`'."\n" + ."\n" + .'> We recommend that you use HTTPS to call this operation to avoid password leaks.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1@a2****', + ], + 'Name' => [ + 'description' => 'The username of the new user. The username must be 6 to 30 characters in length, and can contain letters, digits and periods (.). The username must start with a letter.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'user1', + ], + 'Group' => [ + 'description' => 'The permission group of the new user. Valid values:'."\n" + ."\n" + .'* users: ordinary permissions, which are suitable for ordinary users that need only to submit and debug jobs.'."\n" + .'* wheel: sudo permissions, which are suitable for administrators who need to manage clusters. In addition to submitting and debugging jobs, you can also run sudo commands to install software and restart nodes.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'users', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use asynchronous message links to add the users.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AgentError.Account.GetentPasswdFailure', + 'errorMessage' => 'Failed to get the user list: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserAlreadyExist', + 'errorMessage' => 'The specified user already exists in domain: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserAddFailure', + 'errorMessage' => 'Failed to add user to domain: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.DomainNotExist', + 'errorMessage' => 'The specified domain does not exist: %s.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddUsersResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n</AddUsersResponse>","errorExample":""}]', + 'title' => 'AddUsers', + 'summary' => 'Adds users to a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListUsers' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n" + ."\n" + .'Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => 'The page number returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Users' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UserInfo' => [ + 'description' => 'The list of users.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => 'user1', + ], + 'AddTime' => [ + 'description' => 'The time when the user was created.'."\n", + 'type' => 'string', + 'example' => '2018-07-18T17:46:47', + ], + 'Group' => [ + 'description' => 'The name of the permission group. Valid values:'."\n" + ."\n" + .'* users: an ordinary permission group. It is applicable to ordinary users that need only to submit and debug jobs.'."\n" + .'* wheel: a sudo permission group. It is applicable to the administrator who needs to manage the cluster. In addition to submitting and debugging jobs, users who have sudo permissions can run sudo commands to install software and restart nodes.'."\n", + 'type' => 'string', + 'example' => 'wheel', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + ], + [ + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AgentError.Account.DomainNotExist', + 'errorMessage' => 'The specified domain does not exist: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.GetentPasswdFailure', + 'errorMessage' => 'Failed to get the user list: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.GetUserListFailure', + 'errorMessage' => 'Get user list fail: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Users\\": {\\n \\"UserInfo\\": [\\n {\\n \\"Name\\": \\"user1\\",\\n \\"AddTime\\": \\"2018-07-18T17:46:47\\",\\n \\"Group\\": \\"wheel\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListUsersResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n <TotalCount>1</TotalCount>\\r\\n <PageNumber>1</PageNumber>\\r\\n <PageSize>1</PageSize>\\r\\n <Users>\\r\\n <UserInfo>\\r\\n <Name>user1</Name>\\r\\n <Group>users</Group>\\r\\n </UserInfo>\\r\\n <UserInfo>\\r\\n <Name>user2</Name>\\r\\n <Group>wheel</Group>\\r\\n </UserInfo>\\r\\n </Users>\\r\\n</ListUsersResponse>","errorExample":""}]', + 'title' => 'ListUsers', + 'summary' => 'Queries all users of a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListUsersAsync' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster. You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-vu7c2WkVGx', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.\\'."\n" + .'Pages start from page 1.\\'."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries returned per page.\\'."\n" + .'Valid values: 1 to 50.\\'."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AsyncId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the asynchronous task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 't-hz02xltxaex1q80', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9A05F620-ED46-4A57-95F1-C67D6D3C5DD2', + ], + 'PageNumber' => [ + 'description' => 'The number of the page returned. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of users.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Users' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UserInfo' => [ + 'description' => 'The list of users.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => 'testuser', + ], + 'AddTime' => [ + 'description' => 'The time when the user was created.'."\n", + 'type' => 'string', + 'example' => '2022-09-28T09:05:26.000Z', + ], + 'Group' => [ + 'description' => 'The user groups.'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'wheel', + ], + 'UserId' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1000', + ], + 'GroupId' => [ + 'description' => 'The user group ID.'."\n", + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + ], + 'AsyncId' => [ + 'description' => 'The ID of the asynchronous task.'."\n", + 'type' => 'string', + 'example' => 't-sh03egi3mls****', + ], + 'AsyncStatus' => [ + 'description' => 'The status of the asynchronous task.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + ], + [ + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AgentError.Account.DomainNotExist', + 'errorMessage' => 'The specified domain does not exist: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.GetentPasswdFailure', + 'errorMessage' => 'Failed to get the user list: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.GetUserListFailure', + 'errorMessage' => 'Get user list fail: %s', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"9A05F620-ED46-4A57-95F1-C67D6D3C5DD2\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Users\\": {\\n \\"UserInfo\\": [\\n {\\n \\"Name\\": \\"testuser\\",\\n \\"AddTime\\": \\"2022-09-28T09:05:26.000Z\\",\\n \\"Group\\": \\"wheel\\",\\n \\"UserId\\": \\"1000\\",\\n \\"GroupId\\": \\"10\\"\\n }\\n ]\\n },\\n \\"AsyncId\\": \\"t-sh03egi3mls****\\",\\n \\"AsyncStatus\\": \\"Success\\"\\n}","errorExample":""},{"type":"xml","example":"<ListUsersAsyncResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>1</PageSize>\\n <RequestId>76CCF155-5F9B-5FC1-8DF8-579A61F69D99</RequestId>\\n <PageNumber>1</PageNumber>\\n <AsyncId>t-sh03egi3mls****</AsyncId>\\n <AsyncStatus>Success</AsyncStatus>\\n <Users>\\n <UserInfo>\\n <Group>wheel</Group>\\n <UserId>1000</UserId>\\n <Name>testuser</Name>\\n <GroupId>10</GroupId>\\n </UserInfo>\\n </Users>\\n</ListUsersAsyncResponse>","errorExample":""}]', + 'title' => 'ListUsersAsync', + 'summary' => 'Queries the users in a cluster.', + ], + 'ModifyUserGroups' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75895', + 'abilityTreeNodes' => [ + 'FEATUREehpcG9MMN3', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to obtain the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The users. You can specify 1 to 100 users.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The array of user information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The username.'."\n" + ."\n" + .'You can call the [ListUsers](~~188572~~) operation to query the usernames in the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user11', + ], + 'Group' => [ + 'description' => 'The user group to be changed. Valid values:'."\n" + ."\n" + .'* users: ordinary permissions, which are suitable for ordinary users that need only to submit and debug jobs.'."\n" + .'* wheel: sudo permissions, which are suitable for administrators who need to manage clusters. In addition to submitting and debugging jobs, you can also run sudo commands to install software and restart nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'users', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use asynchronous message links to change the user group.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'InvalidOpt', + 'errorMessage' => 'The specified operation is invalid. Please try again later. If the problem still exists, submit a ticket.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AgentError.Account.DomainNotExist', + 'errorMessage' => 'The specified domain does not exist: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.GetentPasswdFailure', + 'errorMessage' => 'Failed to get the user list: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserAlreadyExist', + 'errorMessage' => 'The specified user already exists in domain: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserAddFailure', + 'errorMessage' => 'Failed to add user to domain: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserNotExist', + 'errorMessage' => 'The specified user is not found in the domain: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserModifyGroupFailure', + 'errorMessage' => 'Failed to modify user groups in domain: %s.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyUserGroupsResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n</ModifyUserGroupsResponse>","errorExample":""}]', + 'title' => 'ModifyUserGroups', + 'summary' => 'Changes the user group to which users belong.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyUserPasswords' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75897', + 'abilityTreeNodes' => [ + 'FEATUREehpcG9MMN3', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to obtain the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The users. You can specify 1 to 100 users.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The array of user information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Password' => [ + 'description' => 'The new password for the user. The password must be 8 to 30 characters in length and contain at least three of the following character types:'."\n" + ."\n" + .'* Uppercase letter'."\n" + .'* Lowercase letter'."\n" + .'* Digit'."\n" + .'* Special character: `()~!@#$%^&*-_+=|{}[]:;\'/<>,.?/`'."\n" + ."\n" + .'> We recommend that you use HTTPS to call this operation to avoid password leaks.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1@a****', + ], + 'Name' => [ + 'description' => 'The username of the user whose password you want to change.'."\n" + ."\n" + .'You can call the [ListUsers](~~188572~~) operation to query the usernames in the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'user1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the asynchronous mode for this request.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'InvalidOpt', + 'errorMessage' => 'The specified operation is invalid. Please try again later. If the problem still exists, submit a ticket.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AgentError.Account.DomainNotExist', + 'errorMessage' => 'The specified domain does not exist: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.GetentPasswdFailure', + 'errorMessage' => 'Failed to get the user list: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserNotExist', + 'errorMessage' => 'The specified user is not found in the domain: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserChangePasswordFailure', + 'errorMessage' => 'Failed to modify user password in domain: %s.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyUserPasswordsResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n</ModifyUserPasswordsResponse>","errorExample":""}]', + 'title' => 'ModifyUserPasswords', + 'summary' => 'Changes the passwords of users.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteUsers' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '75803', + 'abilityTreeNodes' => [ + 'FEATUREehpcG9MMN3', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to obtain the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the user.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The array of user information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the user N that you want to delete. Valid values of N: 1 to 100.'."\n" + ."\n" + .'You can call the [ListUsers](~~188572~~) operation to query the users of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the asynchronous mode for this request.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AgentError.Account.DomainNotExist', + 'errorMessage' => 'The specified domain does not exist: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.GetentPasswdFailure', + 'errorMessage' => 'Failed to get the user list: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserNotExist', + 'errorMessage' => 'The specified user is not found in the domain: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserDeleteFailure', + 'errorMessage' => 'Failed to delete user from domain: %s.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteUsersResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n</DeleteUsersResponse>","errorExample":""}]', + 'title' => 'DeleteUsers', + 'summary' => 'Deletes users from a cluster.', + 'description' => 'If you delete a user, only its information is deleted. The files stored in the /home directory for the user are retained. For example, if you delete a user named user1, the files in the `/home/user1/` directory of the cluster are not deleted. However, a deleted user cannot be recovered. Even if you create another user that has the same name, the data retained for the deleted user is not reused.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddNodes' => [ + 'summary' => 'Adds one or more compute nodes to an E-HPC cluster.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the image. Valid values:'."\n" + ."\n" + .'* system: public image'."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n" + .'* marketplace: Alibaba Cloud Marketplace image'."\n" + ."\n" + .'Default value: system.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'system', + 'default' => 'system', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the image that is specified for the compute nodes. The image must meet the following requirements:'."\n" + ."\n" + .'* The operating system that is specified by the image must be the same as that of the existing cluster nodes. For example, if the operating system of the cluster nodes is CentOS, you can select only a CentOS image.'."\n" + ."\n" + .'> If you add nodes to a hybrid cloud cluster that supports multiple operating systems, you can select a Windows Server image or a CentOS image when the operating system of nodes is Windows.'."\n" + ."\n" + .'* The major version of the image specified for the compute nodes that you want to add is the same as that of the image of the cluster. For example, if the version of the cluster image is CentOS 7.x, the version of the image specified for the compute nodes must be CentOS 7.x.'."\n" + ."\n" + .'You can call the [ListImages](~~87213~~) and [ListCustomImages](~~87215~~) operations to query the image ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_06_64_20G_alibase_20190711.vhd', + ], + ], + [ + 'name' => 'Count', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of compute nodes that you want to add. Valid values: 1 to 99. The value of this parameter is greater than that of the MinCount parameter.'."\n" + ."\n" + .'* If the number of available ECS instances is less than the value of the MinCount parameter, the compute nodes cannot be added.'."\n" + .'* If the number of available ECS instances is greater than the value of the MinCount parameter and less than that of the Count parameter, the compute nodes are added based on the value of the MinCount parameter.'."\n" + .'* If the number of available ECS instances is greater than the value of the Count parameter, the compute nodes are added based on the value of the Count parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the compute nodes. The default value is the instance type that was specified when you created the E-HPC cluster or the last time when you added compute nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'ComputeSpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The preemption policy of the compute nodes. The parameter only takes effect when EcsChargeType is set to PostPaid. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is a regular pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The policy applies to preemptible instances for which a maximum hourly price is specified.'."\n" + .'* SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + ], + [ + 'name' => 'ComputeSpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum hourly price of the compute nodes. The value can be accurate to three decimal places. The parameter only takes effect when SpotStrategy is set to SpotWithPriceLimit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0.68', + ], + ], + [ + 'name' => 'EcsChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the compute nodes. Valid values:'."\n" + ."\n" + .'* PostPaid: pay-as-you-go'."\n" + .'* PrePaid: subscription'."\n" + ."\n" + .'Default value: PostPaid.'."\n" + ."\n" + .'If the parameter is set to PrePaid, auto-renewal is enabled by default. After the E-HPC cluster is released, auto-renewal is disabled.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'default' => 'PostPaid', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => 'The duration of the subscription. The unit of the duration is specified by the PeriodUnit parameter. The parameter only takes effect when InstanceChargeType is set to PrePaid. Valid values:'."\n" + ."\n" + .'* Valid values when PeriodUnit is set to Week: 1, 2, 3, and 4.'."\n" + .'* Valid values when PeriodUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unit of the subscription period of the resource. Valid values:'."\n" + ."\n" + .'* Week'."\n" + .'* Month'."\n" + ."\n" + .'Default value: Month.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto-renewal. The parameter takes effect only when EcsChargeType is set to PrePaid. Valid values:'."\n" + ."\n" + .'* true: enables auto-renewal'."\n" + .'* false: disables auto-renewal'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The auto-renewal period of the subscription compute nodes. The parameter takes effect when AutoRenew is set to true.'."\n" + ."\n" + .'* Valid values when PeriodUnit is set to Week: 1, 2, and 3.'."\n" + .'* Valid values when PeriodUnit is set to Month: 1, 2, 3, 6, and 12.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The queue to which the compute nodes are added.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'CreateMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mode in which the compute nodes are added. Valid values:'."\n" + ."\n" + .'* manual: The compute nodes are manually added.'."\n" + .'* autoscale: The compute nodes are automatically added.'."\n" + ."\n" + .'Default value: manual.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'manual', + ], + ], + [ + 'name' => 'SystemDiskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the system disk. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: SSD'."\n" + .'* cloud_essd: enhanced SSD (ESSD)'."\n" + .'* cloud: basic disk. Disks of this type are retired.'."\n" + ."\n" + .'Default value: cloud_efficiency.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + ], + [ + 'name' => 'SystemDiskSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The size of the system disk. Unit: GiB.'."\n" + ."\n" + .'Valid values: 40 to 500.'."\n" + ."\n" + .'Default value: 40.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the zone.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + ], + [ + 'name' => 'HostNamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the hostname. You can specify the parameter to manage the compute nodes in an efficient manner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + ], + [ + 'name' => 'HostNameSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The suffix of the hostname. You can specify the parameter to manage the compute nodes in an efficient manner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'ComputeEnableHt', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable hyper-threading for the compute node. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AllocatePublicAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to allocate a public IP address to the compute nodes. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'InternetChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the elastic IP address (EIP). Valid values:'."\n" + ."\n" + .'* PayByBandwidth: pay-by-bandwidth'."\n" + .'* PayByTraffic: pay-by-traffic'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PayByTraffic', + 'default' => 'PayByTraffic', + ], + ], + [ + 'name' => 'InternetMaxBandWidthIn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:'."\n" + ."\n" + .'* If the purchased outbound public bandwidth is less than or equal to 10 Mbit/s, the valid values of the parameter are 1 to 10 and the default value is 10.'."\n" + .'* If the purchased outbound public bandwidth is greater than 10 Mbit/s, the valid values of this parameter are 1 to the amount of the outbound bandwidth that is purchased.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '0', + ], + ], + [ + 'name' => 'InternetMaxBandWidthOut', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100.'."\n" + ."\n" + .'Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '0', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How do I ensure the idempotence of a request?](~~25693~~)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'SystemDiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance level of the ESSD to be used as the system disk. Default value: PL1. Valid values:'."\n" + ."\n" + .'* PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'Default value: PL1.'."\n" + ."\n" + .'For more information about ESSD performance parameters, see [ESSD](~~122389~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL0', + ], + ], + [ + 'name' => 'MinCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum number of the compute nodes that you want to add. Valid values: 1 to 99. The value of the parameter is less than that of the Count parameter.'."\n" + ."\n" + .'* If the number of available ECS instances is less than the value of the MinCount parameter, the compute nodes cannot be added.'."\n" + .'* If the number of available ECS instances is greater than the value of the MinCount parameter and less than that of the Count parameter, the compute nodes are added based on the value of the MinCount parameter.'."\n" + .'* If the number of available ECS instances is greater than the value of the Count parameter, the compute nodes are added based on the value of the Count parameter.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Sync', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to set this operation as a synchronous operation. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DataDisks', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of data disks.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DataDiskSize' => [ + 'description' => 'The size of the data disk. Unit: GB.'."\n" + ."\n" + .'Valid values: 40 to 500.'."\n" + ."\n" + .'Default value: 40.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + 'DataDiskCategory' => [ + 'description' => 'The type of the data disk. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: SSD'."\n" + .'* cloud_essd: ESSD'."\n" + .'* cloud: basic disk'."\n" + ."\n" + .'Default value: cloud_efficiency.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_efficiency', + ], + 'DataDiskDeleteWithInstance' => [ + 'description' => 'Specifies whether the data disk is released when the node is released. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: true.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'DataDiskPerformanceLevel' => [ + 'description' => 'The performance level of the ESSD used as the data disk. The parameter only takes effect only when the DataDisks.N.DataDiskCategory parameter is set to cloud_essd. Valid values:'."\n" + ."\n" + .'* PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'Default value: PL1.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'DataDiskEncrypted' => [ + 'description' => 'Specifies whether to encrypt the data disk. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'DataDiskKMSKeyId' => [ + 'description' => 'The KMS key ID of the data disk.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40826X', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'ComputeSpotDuration', + 'in' => 'query', + 'schema' => [ + 'title' => '抢占式实例的保留时长，单位为小时。取值范围：0~6。'."\n" + .'- 保留时长2~6正在邀测中，如需开通请提交工单。'."\n" + .'- 取值为0，则为无保护期模式。'."\n" + .'默认值：1。', + 'description' => 'The protection period of the preemptible instance. Unit: hours. Valid values: 0 and 1. A value of 0 indicates that the preemptible instance has no protection period.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '6', + 'minimum' => '0', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ComputeSpotInterruptionBehavior', + 'in' => 'query', + 'schema' => [ + 'title' => '抢占实例中断模式。目前仅支持Terminate（默认）直接释放实例。', + 'description' => 'The interruption mode of the preemptible instance. Default value: Terminate. Set the value to Terminate, which indicates that the instance is released.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Terminate', + 'default' => 'Terminate', + ], + ], + [ + 'name' => 'NetworkInterfaceTrafficMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The communication mode of the ENI. Valid values:'."\n" + ."\n" + .'* Standard: uses the TCP communication mode.'."\n" + .'* HighPerformance: enables the Elastic RDMA Interface (ERI) and uses the remote direct memory access (RDMA) communication mode.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'DnsConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The information about Domain Name System (DNS) settings.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"{\\"DnsType\\":\\"PrivateZone\\",\\"DnsName\\":\\"xxxxx\\"}"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The instance IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Instance ID. '."\n" + .'> If the AddNodes operation is asynchronous (the Sync parameter in the request is set to False), the result will be returned immediately upon a successful request, without waiting for the instance creation to complete. Therefore, the InstanceIds content will be empty. You can obtain the InstanceId through [ListNodes](~~87161~~).', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'InvaildSystemDiskSize', + 'errorMessage' => 'The system disk size must be greater than or equal to image size.', + ], + ], + 403 => [ + [ + 'errorCode' => 'TooManyComputes', + 'errorMessage' => 'The number of computing nodes exceeds the quota.', + ], + [ + 'errorCode' => 'TooManyLogins', + 'errorMessage' => 'The maximum number of logged on nodes is exceeded.', + ], + [ + 'errorCode' => 'TooManyScc', + 'errorMessage' => 'The maximum number of SCC instances is exceeded.', + ], + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'ImageNotSupported', + 'errorMessage' => 'The specified image is not supported.', + ], + [ + 'errorCode' => 'InvalidOpt', + 'errorMessage' => 'The specified operation is invalid. Please try again later.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'VolumeNotFound', + 'errorMessage' => 'The specified volume does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + [ + 'errorCode' => 'KeyPairNotFound', + 'errorMessage' => 'The specified KeyPair does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'EipError', + 'errorMessage' => 'The EIP API request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"B745C159-3155-4B94-95D0-4B73D4D2****\\",\\n \\"RequestId\\": \\"B745C159-3155-4B94-95D0-4B73D4D2****\\",\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"null\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddNodesResponse>\\n<TaskId>B745C159-3155-4B94-95D0-4B73D4D2****</TaskId>\\n<RequestId>B745C159-3155-4B94-95D0-4B73D4D2****</RequestId>\\n<InstanceIds>\\n <InstanceId>null</InstanceId>\\n</InstanceIds>\\n</AddNodesResponse>","errorExample":""}]', + 'title' => 'AddNodes', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'translator' => 'machine', + ], + 'ApplyNodes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87126~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image ID of the compute nodes to be added. The parameter takes effect only when the TargetImageId parameter is not specified.'."\n" + ."\n" + .'You can call the [ListImages](~~87213~~) and [ListCustomImages](~~87215~~) operations to query the image ID.'."\n" + ."\n" + .'> If you add multiple compute nodes, the TargetImageId parameter takes effect only on the nodes for which the TargetImageId parameter is specified.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_06_64_20G_alibase_20190711.vhd', + ], + ], + [ + 'name' => 'ComputeSpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The preemption policy of the compute nodes. Valid values:'."\n" + ."\n" + .'* NoSpot: The compute nodes are pay-as-you-go instances.'."\n" + .'* SpotWithPriceLimit: The compute nodes are preemptible instances that have a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + ], + [ + 'name' => 'ComputeSpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum hourly price of the compute nodes. The value is a floating-point number that supports up to three decimal places. The parameter takes effect only when ComputeSpotStrategy is set to SpotWithPriceLimit.'."\n" + ."\n" + .'If ComputeSpotPriceLimit and InstanceTypeModel.N.MaxPrice are specified at the same time, compute nodes are created based on the smaller value of the two parameters.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.68', + ], + ], + [ + 'name' => 'SystemDiskType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the system disk. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: SSD'."\n" + .'* cloud_essd: enhanced SSD (ESSD)'."\n" + .'* cloud: basic disk. Disks of this type are retired.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + ], + [ + 'name' => 'SystemDiskSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The size of the system disk. Unit: GB.'."\n" + ."\n" + .'Valid values: 40 to 500.'."\n" + ."\n" + .'Default value: 40.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + ], + [ + 'name' => 'HostNamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the hostname. You can specify the parameter to manage the compute nodes in an efficient manner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + ], + [ + 'name' => 'HostNameSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The suffix of the hostname. You can specify the parameter to manage the compute nodes in an efficient manner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'AllocatePublicAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to allocate a public IP address to the compute nodes. Valid values:'."\n" + ."\n" + .'* true: A public IP address is allocated to the compute nodes.'."\n" + .'* false: A public IP address is not allocated to the compute nodes.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'InternetChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the elastic IP address (EIP). Valid values:'."\n" + ."\n" + .'* PayByBandwidth: pay-by-bandwidth'."\n" + .'* PayByTraffic: pay-by-traffic'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PayByTraffic', + 'default' => 'PayByTraffic', + ], + ], + [ + 'name' => 'InternetMaxBandWidthIn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:'."\n" + ."\n" + .'* If the purchased outbound public bandwidth is less than or equal to 10 Mbit/s, the valid values of the parameter are 1 to 10 and the default value is 10.'."\n" + .'* If the purchased outbound public bandwidth is greater than 10 Mbit/s, the valid values of this parameter are 1 to the amount of the outbound bandwidth that is purchased. The default value is the value of the InternetMaxBandWidthOut parameter.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '0', + ], + ], + [ + 'name' => 'InternetMaxBandWidthOut', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100.'."\n" + ."\n" + .'Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '0', + ], + ], + [ + 'name' => 'Cores', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of vCPUs. The parameter is required when the ResourceAmountType parameter is set to Cores.'."\n" + ."\n" + .'You can set vCPU and Memory to query node specifications. For example, you can query the available compute nodes that have 2 vCPUs and 16 GB of memory by setting vCPU to 2 and Memory to 16. You can also query compute nodes by node specification and zone. Query results are sorted by price. The nodes that have the lowest price are created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The memory capacity. The parameter is required when the ResourceAmountType parameter is set to Cores. Unit: GB.'."\n" + ."\n" + .'You can set vCPU and Memory to query node specifications. For example, you can query the available compute nodes that have 2 vCPUs and 16 GB of memory by setting vCPU to 2 and Memory to 16. You can also query compute nodes by node specification and zone. Query results are sorted by price. The nodes that have the lowest price are created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '16', + ], + ], + [ + 'name' => 'InstanceFamilyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The level of the instance family. The parameter takes effect only when Cores and Memory are specified. Valid values:'."\n" + ."\n" + .'* EntryLevel'."\n" + .'* EnterpriseLevel'."\n" + .'* CreditEntryLevel For more information, see [Overview of burstable instances](~~59977~~).'."\n" + ."\n" + .'Default value: EnterpriseLevel.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'EntryLevel', + ], + ], + [ + 'name' => 'TargetCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The amount of the resource that you want to add. The specific number depends on the value of the ResourceAmountType parameter:'."\n" + ."\n" + .'* If ResourceAmountType is set to Instance, the value range of TargetCapacity is 1 to 200.'."\n" + .'* If ResourceAmountType is set to Cores, the value range of TargetCapacity is 1 to 1,000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'ResourceAmountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource that you want to add. Valid values:'."\n" + ."\n" + .'* Instances: the ECS instances that are used as compute nodes'."\n" + .'* Cores: vCPU and memory'."\n" + ."\n" + .'Default value: Instances.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Instances', + ], + ], + [ + 'name' => 'PriorityStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application policy of the preemptible nodes. Valid values:'."\n" + ."\n" + .'* LowPriceResourcePlanning: Preemptible nodes are created based on the unit prices of vCPUs in ascending order. Preemptible nodes are created first when multiple preemptible instance types are specified.'."\n" + .'* CapacityOptResourcePlanning: Preemptible nodes are created based on the prices and release rates in ascending order.'."\n" + .'* CustomizedResourcePlanning: Nodes are added based on the predefined value of the ZoneIds.N parameter. Instances of a zone that has a higher priority are used first.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'LowPriceResourcePlanning', + ], + ], + [ + 'name' => 'StrictSatisfiedTargetCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to meet the requirements of the TargetCapacity parameter. Valid values:'."\n" + ."\n" + .'* true: If the available resources are fewer than the resources that you want to add, no compute nodes are created and an error is returned. If the available resources are more than the resources that you want to add, the following cases may occur:'."\n" + ."\n" + .' * If StrictResourceProvision is set to true, check the inventory of the resources. Compute nodes are created based on the value of the TargetCapacity parameter only when the available resources are sufficient. Otherwise, no compute nodes are created.'."\n" + .' * If StrictResourceProvision is set to false, check the inventory of the resources. Compute nodes are created only when the available resources are sufficient. However, some compute nodes may fail to be created because resources become insufficient after the inventory query.'."\n" + ."\n" + .'* false: If the available resources are insufficient, compute nodes are created based on the inventory of the resources.'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SystemDiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => 'The performance level of the ESSD that you want to use as the system disk. Valid values:'."\n" + ."\n" + .'* PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: A single ESSD can deliver up to 50,000 IOPS of random read/write.'."\n" + .'* PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'Default value: PL0. For more information, see [ESSDs](~~122389~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL0', + ], + ], + [ + 'name' => 'StrictResourceProvision', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to strictly meet the requirements of the TargetCapacity parameter. The parameter takes effect only when StrictSatisfiedTargetCapacity is set to true. Valid values:'."\n" + ."\n" + .'* true: Check the inventory of the resources. Compute nodes are created based on the value of the TargetCapacity parameter only when the available resources are sufficient. Otherwise, no compute nodes are created.'."\n" + .'* false: Check the inventory of the resources. Compute nodes are created only when the available resources are sufficient. However, some compute nodes may fail to be created because resources become insufficient after the inventory query.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Round', + 'in' => 'query', + 'schema' => [ + 'description' => 'The total number of batches to create nodes. Valid values: 1 to 10.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval between two consecutive batches. Valid values: 60 to 600. Unit: seconds.'."\n" + ."\n" + .'Default value: 60.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '600', + 'minimum' => '60', + 'example' => '60', + 'default' => '60', + ], + ], + [ + 'name' => 'ZoneInfos', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The details of the zones. You can specify up to 10 zones.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch. Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vsw-bp1e47optm9g58zcu****', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone to which the node belongs. Valid values of N: 1 to 10.'."\n" + ."\n" + .'> Each zone ID must be unique.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou-b', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'InstanceTypeModel', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the preemptible instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MaxPrice' => [ + 'description' => 'The maximum hourly price that you can pay for the preemptible node. The value is a floating-point number that supports up to three decimal places.'."\n" + ."\n" + .'The parameter takes effect only when ComputeSpotStrategy is set to SpotWithPriceLimit.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.034', + ], + 'TargetImageId' => [ + 'description' => 'The image ID of the compute node. You must select a Windows image.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'win2016_1607_x64_dtc_zh-cn_40G_alibase_20210516.vhd', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the compute node. The default value is the instance type that was specified when you created the cluster or the last time you added compute nodes.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The details about the tags that are added to the nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain http:// or https://.'."\n" + ."\n" + .'Valid values of N: 1 to 20.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => 'The tag value. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with acs: or contain http:// or https://.'."\n" + ."\n" + .'Valid values of N: 1 to 20.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 19, + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The queue to which the compute nodes are added.'."\n" + ."\n" + .'You can call the [ListQueues](~~92176~~) operation to query the queue name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user data of the instance. The user data must be Base64-encoded. The raw data can be up to 16 KB in size. Linux operating systems support shell scripts. Windows operating systems support bat and Powershell scripts. Before you perform Base64 encoding, make sure that the content to be encoded includes \\[bat] or \\[powershell] as the first row.'."\n" + ."\n" + .'> We recommend that you do not pass in confidential information, such as passwords or private keys, in plaintext as user data. This is because the system does not encrypt UserData values when API requests are transmitted. If you must pass in confidential information, we recommend that you encrypt and encode the information in Base64, and then decode and decrypt the information in the same way inside the instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ZWNobyBoZWxsbyBlY3Mh'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'SatisfiedAmount' => [ + 'description' => 'The number of the compute nodes that are created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TaskId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'Detail' => [ + 'description' => 'The detailed result of the request.'."\n", + 'type' => 'string', + 'example' => 'Resources Application is satisfied. Creating...', + ], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The instance IDs.'."\n" + ."\n" + .'> AddNodes is an asynchronous API operation. If a request succeeds, a response is immediately generated before ECS instances are created. Therefore, the value of this parameter is null. You can call the [ListNodes](~~87161~~) operation to query the IDs of the ECS instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance IDs.'."\n" + ."\n" + .'> AddNodes is an asynchronous API operation. If a request succeeds, a response is immediately generated before ECS instances are created. Therefore, the value of the parameter is null. You can call the [ListNodes](~~87161~~) operation to query the ID of the ECS instance.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'InvalidVswitch', + 'errorMessage' => 'The vSwitch parameter is invalid, or the number of available IP addresses is insufficient.', + ], + [ + 'errorCode' => 'InvalidImage', + 'errorMessage' => 'The image ID is invalid.', + ], + [ + 'errorCode' => 'InvaildSystemDiskSize', + 'errorMessage' => 'The system disk size must be greater than or equal to image size.', + ], + [ + 'errorCode' => 'InvalidInstanceType.NotSupported', + 'errorMessage' => 'The instance type is invalid.', + ], + [ + 'errorCode' => 'InvalidZoneId.ValueNotSupported', + 'errorMessage' => 'The specified ZoneId is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'TooManyComputes', + 'errorMessage' => 'The number of computing nodes exceeds the quota.', + ], + [ + 'errorCode' => 'TooManyLogins', + 'errorMessage' => 'The maximum number of logged on nodes is exceeded.', + ], + [ + 'errorCode' => 'TooManyScc', + 'errorMessage' => 'The maximum number of SCC instances is exceeded.', + ], + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'ImageNotSupported', + 'errorMessage' => 'The specified image is not supported.', + ], + [ + 'errorCode' => 'InvalidCapacityNum.ValueNotSupported', + 'errorMessage' => 'The specified TargetCapacity is invalid.', + ], + [ + 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', + 'errorMessage' => 'The resource is out of stock.', + ], + [ + 'errorCode' => 'ResourceTargetAmount.NotSatisfied', + 'errorMessage' => 'The resource application is not satisfied.', + ], + [ + 'errorCode' => 'RecommendEmpty.PriceNotSatisfied', + 'errorMessage' => 'The price limit is not satisfied.', + ], + [ + 'errorCode' => 'QuotaExceed.PayasyougoInstance', + 'errorMessage' => 'The pay-as-you-go instance exceeds the quota.', + ], + [ + 'errorCode' => 'RecommendEmpty.InstanceTypeNoStock', + 'errorMessage' => 'The instanceTypes are out of usage.', + ], + [ + 'errorCode' => 'RecommendEmpty.InstanceTypeNotAuthorized', + 'errorMessage' => 'The recommend instanceTypes are not authorized.', + ], + [ + 'errorCode' => 'InvalidOpt', + 'errorMessage' => 'The specified operation is invalid. Please try again later.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'VolumeNotFound', + 'errorMessage' => 'The specified volume does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + [ + 'errorCode' => 'VswitchNotFound', + 'errorMessage' => 'The specified vSwitch does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'EipError', + 'errorMessage' => 'The EIP API request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B745C159-3155-4B94-95D0-4B73D4D2****\\",\\n \\"SatisfiedAmount\\": 10,\\n \\"TaskId\\": \\"B745C159-3155-4B94-95D0-4B73D4D2****\\",\\n \\"Detail\\": \\"Resources Application is satisfied. Creating...\\",\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"null\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ApplyNodes>\\n<TaskId>B745C159-3155-4B94-95D0-4B73D4D2****</TaskId>\\n<SatisfiedAmount>10</SatisfiedAmount>\\n<RequestId>B745C159-3155-4B94-95D0-4B73D4D2****</RequestId>\\n<InstanceIds>\\n <InstanceId>null</InstanceId>\\n</InstanceIds>\\n<Detail>Resources Application is satisfied. Creating...</Detail>\\n</ApplyNodes>","errorExample":""}]', + 'title' => 'ApplyNodes', + 'summary' => 'Adds pay-as-you-go or preemptible compute nodes to a cluster.', + 'description' => '## [](#)Description'."\n" + ."\n" + .'You can call the ApplyNodes operation to specify the number of compute nodes, the number of vCPUs, and the memory size when you add nodes to a cluster.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddExistedNodes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the image that is specified for the compute nodes. The image must meet the following requirements:'."\n" + ."\n" + .'* The operating system that is specified for the image must be the same as that of the existing cluster nodes. For example, if the operating system of the cluster nodes is CentOS, you can select only a CentOS image.'."\n" + ."\n" + .'> If you add nodes to a hybrid cloud cluster that supports multiple operating systems, you can select a Windows Server image or a CentOS image when the operating system of the cluster nodes is Windows.'."\n" + ."\n" + .'* The major version of the image specified for the compute nodes that you want to add must be the same as that of the image of the cluster. For example, if the version of the cluster image is CentOS 7.x, the version of the image specified for the compute nodes must be CentOS 7.x.'."\n" + ."\n" + .'You can call the [ListImages](~~87213~~) and [ListCustomImages](~~87215~~) operations to query the image ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'centos_7_06_64_20G_alibase_20190711.vhd', + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The queue in the cluster to which the node is to be added.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the images. Valid values:'."\n" + ."\n" + .'* system: public image.'."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n" + .'* marketplace: Alibaba Cloud Marketplace image'."\n" + ."\n" + .'Default value: system.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'system', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the node that you want to add.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The Nth node ID. N starts from 1. Valid values: 1 to 100.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i-bp16mxn6mt3t7ftk****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'TooManyComputes', + 'errorMessage' => 'The number of computing nodes exceeds the quota.', + ], + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'InvalidOpt', + 'errorMessage' => 'The specified operation is invalid. Please try again later. If the problem still exists, submit a ticket.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'ImageNotSupported', + 'errorMessage' => 'The specified image is not supported.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'VolumeNotFound', + 'errorMessage' => 'The specified volume does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddExistedNodesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n <TaskId>04F0F334-1335-436C-A1D7-6C044FE7****</TaskId>\\n</AddExistedNodesResponse>","errorExample":""}]', + 'title' => 'AddExistedNodes', + 'summary' => 'Adds one or more existing ECS instances as compute nodes to a specified cluster.', + 'description' => '* The compute nodes to be added are in the Stopped state.'."\n" + .'* After the compute nodes are added to the cluster, the operating systems of the nodes are replaced with the operating system specified by the ImageId parameter.'."\n" + .'* The hosts of the compute nodes must be different from those of the existing compute nodes in the cluster. Otherwise, the add operation fails.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListNodes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the node. Valid values:'."\n" + ."\n" + .'* Manager: management node'."\n" + .'* Login: logon node'."\n" + .'* Compute: compute node'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Manager', + 'default' => 'Compute', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the node. You can perform a fuzzy search. MySQL regular expressions are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test-HostName', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 100.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting method of the node list. Valid values:'."\n" + ."\n" + .'* Forward: sorts the nodes in chronological order.'."\n" + .'* Backward: sorts the nodes in reverse chronological order.'."\n" + ."\n" + .'Default value: Forward.'."\n" + ."\n" + .'> This parameter is used together with the SortBy parameter. If you set SortBy to AddedTime and set Sequence to Forward, nodes are queried in ascending order of time that they are added.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Forward', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting method of the node list. Valid values:'."\n" + ."\n" + .'* AddedTime: sorts the nodes by the time that they are added.'."\n" + .'* HostName: sorts the nodes by their host names.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AddedTime', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'description' => 'The filter options of the node list.'."\n" + ."\n" + .'Format: {"status":"node_status"}. Replace node_status with the node status. Valid values of node_status:'."\n" + ."\n" + .'* uninit: The node is being installed.'."\n" + .'* exception: An exception occurred on the node.'."\n" + .'* running: The node is running.'."\n" + .'* initing: The node is being initialized.'."\n" + .'* releasing: The node is being released.'."\n" + .'* untracking: The node is not added to the cluster.'."\n" + .'* stopped: The node is stopped.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"status":"running"}', + ], + ], + [ + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => 'The private IP address of the node.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172.16.**.**', + ], + ], + [ + 'name' => 'HostNamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the hostname. You can query nodes that have a specified prefix.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + ], + [ + 'name' => 'HostNameSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The suffix of the hostname. You can query nodes that have a specified suffix.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '89A1AC0F-4A6C-4F3D-98F9-BEF9A823****', + ], + 'PageNumber' => [ + 'description' => 'The page number returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Nodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeInfo' => [ + 'description' => 'The list of nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The VPC ID of the node.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1gnu8br4ay7beb2w****', + ], + 'Status' => [ + 'description' => 'The status of the node. Valid values:'."\n" + ."\n" + .'* uninit: The node is being installed.'."\n" + .'* exception: An exception occurred on the node.'."\n" + .'* running: The node is running.'."\n" + .'* initing: The node is being initialized.'."\n" + .'* releasing: The node is being released.'."\n" + .'* untracking: The node is not added to the cluster.'."\n" + .'* stopped: The node is stopped.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'HtEnabled' => [ + 'description' => 'Indicates whether hyper-threading is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Expired' => [ + 'description' => 'Indicates whether the subscription node expired. For a pay-as-you-go node, false is returned.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ImageOwnerAlias' => [ + 'description' => 'The type of the image. Valid values:'."\n" + ."\n" + .'* system: public image'."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n" + .'* marketplace: Alibaba Cloud Marketplace image'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'LockReason' => [ + 'description' => 'The reason why the node is locked. Valid values:'."\n" + ."\n" + .'* financial: The instance is locked due to overdue payments.'."\n" + .'* security: The node is locked for security reasons.'."\n" + .'* recycling: The preemptible instance is locked and pending release.'."\n" + .'* dedicatedhostfinancial: The ECS instance is locked due to overdue payments of the dedicated host.'."\n" + ."\n" + .'By default, an empty string is returned.'."\n", + 'type' => 'string', + 'example' => 'financial', + ], + 'HostName' => [ + 'description' => 'The name of the task node.'."\n", + 'type' => 'string', + 'example' => 'test-HostName', + ], + 'InstanceType' => [ + 'description' => 'The instance types of the node.'."\n", + 'type' => 'string', + 'example' => 'ecs.c5.large', + ], + 'PublicIpAddress' => [ + 'description' => 'The public IP address of the server.'."\n", + 'type' => 'string', + 'example' => '172.16.**.**', + ], + 'SpotStrategy' => [ + 'description' => 'The bidding method of the compute nodes.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'CreatedByEhpc' => [ + 'description' => 'Indicates whether the node is created by using E-HPC.'."\n" + ."\n" + .'* true: The node is created by using E-HPC.'."\n" + .'* false: The node is not created by using E-HPC.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1e47optm9g58zcu****', + ], + 'IpAddress' => [ + 'description' => 'The IP address of the node.'."\n", + 'type' => 'string', + 'example' => '172.16.**.**', + ], + 'ExpiredTime' => [ + 'description' => 'The time when the subscription node expires. For a pay-as-you-go node, a null value is returned.'."\n", + 'type' => 'string', + 'example' => '2020-06-09T06:22:02.000Z', + ], + 'Version' => [ + 'description' => 'The version of the client that is used for the cluster.'."\n", + 'type' => 'string', + 'example' => '1.0.78', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'AddTime' => [ + 'description' => 'The time when the node is added to the cluster.'."\n", + 'type' => 'string', + 'example' => '2020-06-09T06:22:02.000Z', + ], + 'ImageId' => [ + 'description' => 'The ID of the custom image.'."\n", + 'type' => 'string', + 'example' => 'centos_7_06_64_20G_alibase_20190711.vhd', + ], + 'Location' => [ + 'description' => 'The location where the node is deployed. Valid values:'."\n" + ."\n" + .'* OnPremise: The node is deployed on your data center.'."\n" + .'* PublicCloud: The node is deployed on the public cloud.'."\n", + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'Id' => [ + 'description' => 'The node ID.'."\n", + 'type' => 'string', + 'example' => 'i-bp15707mys2rsy0j****', + ], + 'CreateMode' => [ + 'description' => 'The mode in which the compute nodes are added. Valid values:'."\n" + ."\n" + .'* manual: The node is manually added.'."\n" + .'* autoscale: The node is automatically added.'."\n", + 'type' => 'string', + 'example' => 'manual', + ], + 'Roles' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Role' => [ + 'description' => 'The type of the node. Valid values:'."\n" + ."\n" + .'* Scheduler: primary scheduling node'."\n" + .'* SchedulerBackup: secondary scheduling node'."\n" + .'* Account: primary domain server node'."\n" + .'* AccountBackup: secondary domain server node'."\n" + .'* Login: logon node'."\n" + .'* Compute: compute node'."\n" + ."\n" + .'Scheduling nodes and domain server nodes are management nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the node. Valid values:'."\n" + ."\n" + .'* Scheduler: primary scheduling node'."\n" + .'* SchedulerBackup: secondary scheduling node'."\n" + .'* Account: primary domain server node'."\n" + .'* AccountBackup: secondary domain server node'."\n" + .'* Login: logon node'."\n" + .'* Compute: compute node'."\n" + ."\n" + .'Scheduling nodes and domain server nodes are management nodes.'."\n", + 'type' => 'string', + 'example' => '[“Compute”]', + ], + ], + ], + ], + 'TotalResources' => [ + 'description' => 'The statistics of the resources used by the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'The number of GPUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => 'The memory capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'UsedResources' => [ + 'description' => 'The usage of the compute nodes in the cluster. For other types of nodes, an empty value is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'The number of GPUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Memory' => [ + 'description' => 'The memory capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'StateInSched' => [ + 'description' => 'The status of the node displayed on the scheduler. The status varies with the scheduler.'."\n", + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"89A1AC0F-4A6C-4F3D-98F9-BEF9A823****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Nodes\\": {\\n \\"NodeInfo\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1gnu8br4ay7beb2w****\\",\\n \\"Status\\": \\"running\\",\\n \\"HtEnabled\\": true,\\n \\"Expired\\": false,\\n \\"ImageOwnerAlias\\": \\"system\\",\\n \\"LockReason\\": \\"financial\\",\\n \\"HostName\\": \\"test-HostName\\",\\n \\"InstanceType\\": \\"ecs.c5.large\\",\\n \\"PublicIpAddress\\": \\"172.16.**.**\\",\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"CreatedByEhpc\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchId\\": \\"vsw-bp1e47optm9g58zcu****\\",\\n \\"IpAddress\\": \\"172.16.**.**\\",\\n \\"ExpiredTime\\": \\"2020-06-09T06:22:02.000Z\\",\\n \\"Version\\": \\"1.0.78\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"AddTime\\": \\"2020-06-09T06:22:02.000Z\\",\\n \\"ImageId\\": \\"centos_7_06_64_20G_alibase_20190711.vhd\\",\\n \\"Location\\": \\"PublicCloud\\",\\n \\"Id\\": \\"i-bp15707mys2rsy0j****\\",\\n \\"CreateMode\\": \\"manual\\",\\n \\"Roles\\": {\\n \\"Role\\": [\\n \\"[“Compute”]\\"\\n ]\\n },\\n \\"TotalResources\\": {\\n \\"Gpu\\": 0,\\n \\"Cpu\\": 1,\\n \\"Memory\\": 1024\\n },\\n \\"UsedResources\\": {\\n \\"Gpu\\": 0,\\n \\"Cpu\\": 0,\\n \\"Memory\\": 0\\n },\\n \\"StateInSched\\": \\"active\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListNodesResponse>\\n <PageSize>1</PageSize>\\n <RequestId>89A1AC0F-4A6C-4F3D-98F9-BEF9A823****</RequestId>\\n <PageNumber>1</PageNumber>\\n <TotalCount>1</TotalCount>\\n <Nodes>\\n <VpcId>vpc-bp1gnu8br4ay7beb2w****</VpcId>\\n <Status>running</Status>\\n <HtEnabled>true</HtEnabled>\\n <Expired>false</Expired>\\n <ImageOwnerAlias>system</ImageOwnerAlias>\\n <LockReason>financial</LockReason>\\n <HostName>test-HostName</HostName>\\n <InstanceType>ecs.c5.large</InstanceType>\\n <PublicIpAddress>172.16.**.**</PublicIpAddress>\\n <SpotStrategy>NoSpot</SpotStrategy>\\n <CreatedByEhpc>true</CreatedByEhpc>\\n <RegionId>cn-hangzhou</RegionId>\\n <VSwitchId>vsw-bp1e47optm9g58zcu****</VSwitchId>\\n <IpAddress>172.16.**.**</IpAddress>\\n <ExpiredTime>2020-06-09T06:22:02.000Z</ExpiredTime>\\n <Version>1.0.78</Version>\\n <ZoneId>cn-hangzhou-b</ZoneId>\\n <AddTime>2020-06-09T06:22:02.000Z</AddTime>\\n <ImageId>centos_7_06_64_20G_alibase_20190711.vhd</ImageId>\\n <Location>PublicCloud</Location>\\n <Id>i-bp15707mys2rsy0j****</Id>\\n <CreateMode>manual</CreateMode>\\n <Roles>[“Compute”]</Roles>\\n <TotalResources>\\n <Gpu>0</Gpu>\\n <Cpu>1</Cpu>\\n <Memory>1024</Memory>\\n </TotalResources>\\n <UsedResources>\\n <Gpu>0</Gpu>\\n <Cpu>0</Cpu>\\n <Memory>0</Memory>\\n </UsedResources>\\n <StateInSched>active</StateInSched>\\n </Nodes>\\n</ListNodesResponse>","errorExample":""}]', + 'title' => 'ListNodes', + 'summary' => 'Queries the list of nodes in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListNodesNoPaging' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the node. Valid values:'."\n" + ."\n" + .'* Manager: management node'."\n" + .'* Login: logon node'."\n" + .'* Compute: compute node'."\n" + ."\n" + .'Default value: Compute.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Compute', + 'default' => 'Compute', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the node. You can perform a fuzzy search. MySQL regular expressions are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Compute0', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting method of the node list. Valid values:'."\n" + ."\n" + .'* Forward: sorts the nodes in chronological order.'."\n" + .'* Backward: sorts the nodes in reverse chronological order.'."\n" + ."\n" + .'Default value: Forward.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Forward', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Nodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeInfo' => [ + 'description' => 'The list of nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the node. Valid values:'."\n" + ."\n" + .'* uninit: The node is being installed.'."\n" + .'* exception: An exception occurred on the node.'."\n" + .'* running: The node is running.'."\n" + .'* initing: The node is being initialized.'."\n" + .'* releasing: The node is being released.'."\n" + .'* untracking: The node is not added to the cluster.'."\n" + .'* stopped: The node is stopped.'."\n", + 'type' => 'string', + 'example' => 'untracking', + ], + 'HostName' => [ + 'description' => 'The node name.'."\n", + 'type' => 'string', + 'example' => 'compute0', + ], + 'InstanceType' => [ + 'description' => 'The node type.'."\n", + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'ImageId' => [ + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'centos_7_02_64_20G_alibase_20170818****', + ], + 'Id' => [ + 'description' => 'The node ID.'."\n", + 'type' => 'string', + 'example' => 'i-bp13p7vlcb1uihfv****', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"Nodes\\": {\\n \\"NodeInfo\\": [\\n {\\n \\"Status\\": \\"untracking\\",\\n \\"HostName\\": \\"compute0\\",\\n \\"InstanceType\\": \\"ecs.n1.tiny\\",\\n \\"ImageId\\": \\"centos_7_02_64_20G_alibase_20170818****\\",\\n \\"Id\\": \\"i-bp13p7vlcb1uihfv****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListNodesNoPagingResponse>\\n<RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n<Nodes>\\n <NodeInfo>\\n <Status>untracking</Status>\\n <ImageId>centos_7_02_64_20G_alibase_20170818****</ImageId>\\n <Id>i-bp13p7vlcb1uihfv****</Id>\\n <InstanceType>ecs.n1.tiny</InstanceType>\\n <HostName>compute0</HostName>\\n </NodeInfo>\\n</Nodes>\\n</ListNodesNoPagingResponse>","errorExample":""}]', + 'title' => 'ListNodesNoPaging', + 'summary' => 'Queries the information of all nodes in a specified cluster on one page.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartNodes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75916', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role of the node. Valid values:'."\n" + ."\n" + .'* Manager: management node'."\n" + .'* Login: logon node'."\n" + .'* Compute: compute node'."\n" + ."\n" + .'Default value: Compute'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Compute', + 'default' => 'Compute', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the Nth node. Valid values of N: 1 to 100.'."\n" + ."\n" + .'Make sure that the node is in the Stopped state. You can call the [ListNodes](~~87161~~) operation to query the status of the node.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp13p7vlcb1uihfv****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'InvalidNodeStatus', + 'errorMessage' => 'The operation failed due to invalid node status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ComputeNotFound', + 'errorMessage' => 'The specified compute node does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'EipError', + 'errorMessage' => 'The EIP API request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartNodesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n <TaskId>04F0F334-1335-436C-A1D7-6C044FE7****</TaskId>\\n</StartNodesResponse>","errorExample":""}]', + 'title' => 'StartNodes', + 'summary' => 'Starts one or more nodes in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopNodes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75921', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => 'The role of the node. Valid values:'."\n" + ."\n" + .'* Manager: management node'."\n" + .'* Login: logon node'."\n" + .'* Compute: compute node'."\n" + ."\n" + .'Default value: Compute'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Compute', + 'default' => 'Compute', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the Nth node that you want to stop. Valid values of N: 1 to 100'."\n" + ."\n" + .'You can call the [ListNodes](~~87161~~) operation to query the IDs of the compute nodes.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'i-bp13p7vlcb1uihf****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'InvalidNodeStatus', + 'errorMessage' => 'The operation failed due to invalid node status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ComputeNotFound', + 'errorMessage' => 'The specified compute node does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'EipError', + 'errorMessage' => 'The EIP API request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartNodesResponse>\\n <TaskId>04F0F334-1335-436C-A1D7-6C044FE7****</TaskId>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n</StartNodesResponse>","errorExample":""}]', + 'title' => 'StopNodes', + 'summary' => 'Stops one or more nodes in an Elastic High Performance Computing (E-HPC) cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ResetNodes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75904', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the compute node that you want to reset. Valid values of N: 1 to 100'."\n" + ."\n" + .'You can call the [ListNodes](~~87161~~) operation to query the IDs of the compute nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp13p7vlcb1uihfv****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'InvalidNodeStatus', + 'errorMessage' => 'The operation failed due to invalid node status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'VolumeNotFound', + 'errorMessage' => 'The specified volume does not exist.', + ], + [ + 'errorCode' => 'ComputeNotFound', + 'errorMessage' => 'The specified compute node does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'EipError', + 'errorMessage' => 'The EIP API request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<ResetNodesResponse>\\n <TaskId>04F0F334-1335-436C-A1D7-6C044FE7****</TaskId>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n</ResetNodesResponse>","errorExample":""}]', + 'title' => 'ResetNodes', + 'summary' => 'Resets one or more compute nodes.', + 'description' => 'After a node is reset, the operating system and software return to their initial states. To ensure that jobs run as expected, we recommend that you do not reset running nodes unless you need to perform crash recovery.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteNodes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '75800', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ReleaseInstance', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to release the instances that are created by using E-HPC.'."\n" + ."\n" + .'Default value: true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'Sync', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to directly delete the node. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the compute node that you want to delete. Valid values of N: 1 to 100.'."\n" + ."\n" + .'You can call the [DescribeCluster](~~87126~~) operation to query the IDs of the nodes in the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp13p7vlcb1uihfv****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The ID of the task.'."\n" + ."\n" + .'* If you set the Sync parameter to true, the DeleteNodes operation is synchronous. Valid value: Not Available.'."\n" + .'* If you set the Sync parameter to false, the DeleteNodes operation is asynchronous. You can call the [ListTasks](~~268225~~) operation to query the result of the task.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'InvalidNodeStatus', + 'errorMessage' => 'The operation failed due to invalid node status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ComputeNotFound', + 'errorMessage' => 'The specified compute node does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'EipError', + 'errorMessage' => 'The EIP API request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteNodesResponse>\\n <TaskId>04F0F334-1335-436C-A1D7-6C044FE7****</TaskId>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n</DeleteNodesResponse>","errorExample":""}]', + 'title' => 'DeleteNodes', + 'summary' => 'Deletes one or more compute nodes from a cluster.', + 'description' => 'Before you delete a compute node, we recommend that you export all job data from the node to prevent data loss.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddQueue' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '75782', + 'abilityTreeNodes' => [ + 'FEATUREehpcAB36B2', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the queue. The name must be 1 to 63 characters in length and start with a letter. It can contain letters, digits, and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'NetworkInterfaceTrafficMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The communication mode of the elastic network interface (ENI). Valid values:'."\n" + ."\n" + .'* Standard: uses the TCP communication mode.'."\n" + .'* HighPerformance: uses the remote direct memory access (RDMA) communication mode with Elastic RDMA Interface (ERI) enabled.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'DeploymentSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The deployment set ID. You can obtain the deployment set ID by calling the [DescribeDeploymentSets](~~91313~~) operation. Only the deployment sets that use low latency policy are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp1frxuzdg87zh4pzq****', + ], + ], + [ + 'name' => 'UseESS', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use scaling groups of Auto Scaling.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7ABFF29F-BD9C-4663-AD5D-E620FA48****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7ABFF29F-BD9C-4663-AD5D-E620FA48****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddQueueResponse>\\n <RequestId>7ABFF29F-BD9C-4663-AD5D-E620FA48****</RequestId>\\n</AddQueueResponse>","errorExample":""}]', + 'title' => 'AddQueue', + 'summary' => 'Creates a queue for a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListQueues' => [ + 'summary' => 'Queries the queues of a specified cluster.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable asynchronous query.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'C6E5005C-00B0-4F27-98BB-95AB88016C22', + ], + 'Queues' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'QueueInfo' => [ + 'description' => 'The queried cluster queues.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the queue.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of queue. Valid values:'."\n" + ."\n" + .'* Execution: Queues in which jobs can be executed.'."\n" + .'* Router: Queues in which jobs cannot be executed. The received jobs in the queues must be forwarded to the bound Execution queues for execution.'."\n", + 'type' => 'string', + 'example' => 'Execution', + ], + 'HostNamePrefix' => [ + 'description' => 'The prefix of the hostname.'."\n", + 'type' => 'string', + 'example' => 'compute', + ], + 'QueueName' => [ + 'description' => 'The name of the queue.'."\n", + 'type' => 'string', + 'example' => 'workq', + ], + 'EnableAutoGrow' => [ + 'description' => 'Indicates whether auto scale-out is enabled for the queue. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the queue belongs.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmxp7uc24****', + ], + 'ImageId' => [ + 'description' => 'The ID of the image.'."\n", + 'type' => 'string', + 'example' => 'centos_7_06_64_20G_alibase_20****.vhd', + ], + 'HostNameSuffix' => [ + 'description' => 'The suffix of the hostname.'."\n", + 'type' => 'string', + 'example' => '01', + ], + 'SpotStrategy' => [ + 'description' => 'The preemption policy of the compute nodes. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is a regular pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is a preemptible instance for which you specify the maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bid price.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'SpotInstanceTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => 'The information about the preemptible instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the preemptible instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => 'The instance type of the preemptible instance.'."\n", + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'SpotPriceLimit' => [ + 'description' => 'The maximum hourly price of the instance. The price can be accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.062', + ], + ], + ], + ], + ], + ], + 'ComputeInstanceType' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceType' => [ + 'description' => 'The instance type of the compute nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance type of compute node.'."\n", + 'type' => 'string', + 'example' => 'ecs.c7.xlarge', + ], + ], + ], + ], + 'DeploymentSetId' => [ + 'description' => 'The ID of the deployment set to which to deploy the instance. You can call the [DescribeDeploymentSets](~~91313~~) operation to query the deployment set ID. Only the deployment sets that use low latency policies are supported.'."\n", + 'type' => 'string', + 'example' => 'ds-bp1frxuzdg87zh4pzq****', + ], + 'UseESS' => [ + 'description' => 'Specifies whether to use scaling groups of Auto Scaling.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'NetworkInterfaceTrafficMode' => [ + 'description' => 'The communication mode of the elastic network interface (ENI). Valid values:'."\n" + ."\n" + .'* Standard: The TCP communication mode is used.'."\n" + .'* HighPerformance: The Elastic RDMA Interface (ERI) is enabled and the remote direct memory access (RDMA) communication mode is used.'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C6E5005C-00B0-4F27-98BB-95AB88016C22\\",\\n \\"Queues\\": {\\n \\"QueueInfo\\": [\\n {\\n \\"Type\\": \\"Execution\\",\\n \\"HostNamePrefix\\": \\"compute\\",\\n \\"QueueName\\": \\"workq\\",\\n \\"EnableAutoGrow\\": false,\\n \\"ResourceGroupId\\": \\"rg-acfmxp7uc24****\\",\\n \\"ImageId\\": \\"centos_7_06_64_20G_alibase_20****.vhd\\",\\n \\"HostNameSuffix\\": \\"01\\",\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"SpotInstanceTypes\\": {\\n \\"Instance\\": [\\n {\\n \\"InstanceType\\": \\"ecs.n1.tiny\\",\\n \\"SpotPriceLimit\\": 0.062\\n }\\n ]\\n },\\n \\"ComputeInstanceType\\": {\\n \\"InstanceType\\": [\\n \\"ecs.c7.xlarge\\"\\n ]\\n },\\n \\"DeploymentSetId\\": \\"ds-bp1frxuzdg87zh4pzq****\\",\\n \\"UseESS\\": false,\\n \\"NetworkInterfaceTrafficMode\\": \\"Standard\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListQueuesResponse>\\n <RequestId>C6E5005C-00B0-4F27-98BB-95AB88016C22</RequestId>\\n <Queues>\\n <QueueInfo>\\n <HostNameSuffix>01</HostNameSuffix>\\n <EnableAutoGrow>false</EnableAutoGrow>\\n <SpotInstanceTypes>\\n </SpotInstanceTypes>\\n <ImageId>centos_7_06_64_20G_alibase_20****.vhd</ImageId>\\n <HostNamePrefix>compute</HostNamePrefix>\\n <QueueName>workq</QueueName>\\n <ResourceGroupId>rg-acfmxp7uc24****</ResourceGroupId>\\n <SpotStrategy>SpotWithPriceLimit</SpotStrategy>\\n <SpotPriceLimit>0.062</SpotPriceLimit>\\n <Type>Execution</Type>\\n <ComputeInstanceType>\\n <InstanceType>ecs.n1.small</InstanceType>\\n </ComputeInstanceType>\\n </QueueInfo>\\n </Queues>\\n</ListQueuesResponse>","errorExample":""}]', + 'title' => 'ListQueues', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateQueueConfig' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the queue.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'workq', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n" + ."\n" + .'You can call the [ListResourceGroups](~~158855~~) operation to query the IDs of resource groups.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'rg-acfmxazb4ph****', + ], + ], + [ + 'name' => 'ComputeInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type of the node.'."\n" + ."\n" + .'You can call the [ListPreferredEcsTypes](~~188592~~) operation to query the recommended instance types.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'DeploymentSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the deployment set. You can obtain the deployment set ID by calling the [DescribeDeploymentSets](~~91313~~) operation. Only the deployment sets that use low latency policy are supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp1frxuzdg87zh4pzq****', + ], + ], + [ + 'name' => 'NetworkInterfaceTrafficMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The communication mode of the elastic network interface (ENI). Valid values:'."\n" + ."\n" + .'* Standard: uses the TCP communication mode.'."\n" + .'* HighPerformance: uses the remote direct memory access (RDMA) communication mode with Elastic RDMA Interface (ERI) enabled.', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + 'enum' => [ + 'Standard', + 'HighPerformance', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5198C3E8-85F5-4280-8547-687C1710****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'InvalidClientVersion', + 'errorMessage' => 'The client version is invalid.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5198C3E8-85F5-4280-8547-687C1710****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeGWSClustersResponse>\\r\\n <requestId>5198C3E8-85F5-4280-8547-687C1710****</requestId>\\r\\n</DescribeGWSClustersResponse>","errorExample":""}]', + 'title' => 'UpdateQueueConfig', + 'summary' => 'Updates the resource group information and the instance types of compute nodes for a queue of a cluster.', + 'description' => 'After you update the resource group, the nodes that you add by scaling out the cluster are automatically included in the resource group.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListNodesByQueue' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the queue.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'workq', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable asynchronous query.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B405FF19-2D5F-4489-A84C-BC15CC1B24BD', + ], + 'PageNumber' => [ + 'description' => 'The number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Nodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeInfo' => [ + 'description' => 'The list of nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The VPC ID of the node.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1gnu8br4ay7beb2w****', + ], + 'Status' => [ + 'description' => 'The status of the node. Valid values:'."\n" + ."\n" + .'* uninit: The node is not initialized.'."\n" + .'* init: The node is being initialized.'."\n" + .'* ready: The node is ready.'."\n" + .'* running: The cluster is running.'."\n" + .'* exception: An exception occurred on the node.'."\n" + .'* untracking: The node is not added to the cluster.'."\n", + 'type' => 'string', + 'example' => 'untracking', + ], + 'HtEnabled' => [ + 'description' => 'Indicates whether Hyper-Threading (HT) is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Expired' => [ + 'description' => 'Indicates whether the subscription node has expired. If the node is a pay-as-you-go node, false is returned.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ImageOwnerAlias' => [ + 'description' => 'The type of the image. Valid values:'."\n" + ."\n" + .'* system: public image'."\n" + .'* self: custom image'."\n" + .'* others: shared image'."\n" + .'* marketplace: Alibaba Cloud Marketplace image'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'LockReason' => [ + 'description' => 'The reason why the node is locked. Valid values:'."\n" + ."\n" + .'* financial: The instance is locked due to overdue payments.'."\n" + .'* security: The node is locked for security reasons.'."\n" + .'* recycling: The preemptible instance is locked and pending release.'."\n" + .'* dedicatedhostfinancial: The ECS instance is locked due to overdue payments of the dedicated host.'."\n" + ."\n" + .'By default, an empty string is returned.'."\n", + 'type' => 'string', + 'example' => 'financial', + ], + 'HostName' => [ + 'description' => 'The node name.'."\n", + 'type' => 'string', + 'example' => 'compute0', + ], + 'PublicIpAddress' => [ + 'description' => 'The public IP address of the node.'."\n", + 'type' => 'string', + 'example' => '10.34.**.**', + ], + 'SpotStrategy' => [ + 'description' => 'The preemption policy of the instance. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bid price.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'CreatedByEhpc' => [ + 'description' => 'Indicates whether the node was created by using E-HPC.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1e47optm9g58zcu****', + ], + 'IpAddress' => [ + 'description' => 'The private IP address of the node.'."\n", + 'type' => 'string', + 'example' => '172.168.**.**', + ], + 'ExpiredTime' => [ + 'description' => 'The time when the subscription instance expires. If the node is a pay-as-you-go node, a null value is returned.'."\n", + 'type' => 'string', + 'example' => '2020-09-18T13:24:29.000Z', + ], + 'Version' => [ + 'description' => 'The version of the E-HPC client.'."\n", + 'type' => 'string', + 'example' => '1.0.64', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the node.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'AddTime' => [ + 'description' => 'The time when the node was added to the cluster.'."\n", + 'type' => 'string', + 'example' => '2019-09-18T13:24:29.000Z', + ], + 'ImageId' => [ + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'centos_7_02_64_20G_alibase_20170818****', + ], + 'Location' => [ + 'description' => 'The location where the node is deployed. Valid values:'."\n" + ."\n" + .'* OnPremise: The cluster is deployed on a hybrid cloud.'."\n" + .'* PublicCloud: The cluster is deployed on a public cloud.'."\n", + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'Id' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'string', + 'example' => 'i-bp13p7vlcb1uihfv****', + ], + 'CreateMode' => [ + 'description' => 'The mode in which the node is created. Valid values:'."\n" + ."\n" + .'* manual: The node is manually added.'."\n" + .'* autoscale: The node is automatically added.'."\n", + 'type' => 'string', + 'example' => 'manual', + ], + 'TotalResources' => [ + 'description' => 'The number of all resources in the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'The total number of GPU cards. Unit: cards.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'The number of CPU cores. Unit: cores.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => 'The memory capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'UsedResources' => [ + 'description' => 'The usage of the compute nodes in the cluster. For other types of nodes, an empty value is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'The total number of GPU cards. Unit: cards.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'The number of CPU cores. Unit: cores.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => 'The memory capacity. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'StateInSched' => [ + 'description' => 'The status of the node displayed on the scheduler. The status varies with the scheduler.'."\n", + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"B405FF19-2D5F-4489-A84C-BC15CC1B24BD\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Nodes\\": {\\n \\"NodeInfo\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1gnu8br4ay7beb2w****\\",\\n \\"Status\\": \\"untracking\\",\\n \\"HtEnabled\\": true,\\n \\"Expired\\": false,\\n \\"ImageOwnerAlias\\": \\"system\\",\\n \\"LockReason\\": \\"financial\\",\\n \\"HostName\\": \\"compute0\\",\\n \\"PublicIpAddress\\": \\"10.34.**.**\\",\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"CreatedByEhpc\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchId\\": \\"vsw-bp1e47optm9g58zcu****\\",\\n \\"IpAddress\\": \\"172.168.**.**\\",\\n \\"ExpiredTime\\": \\"2020-09-18T13:24:29.000Z\\",\\n \\"Version\\": \\"1.0.64\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"AddTime\\": \\"2019-09-18T13:24:29.000Z\\",\\n \\"ImageId\\": \\"centos_7_02_64_20G_alibase_20170818****\\",\\n \\"Location\\": \\"PublicCloud\\",\\n \\"Id\\": \\"i-bp13p7vlcb1uihfv****\\",\\n \\"CreateMode\\": \\"manual\\",\\n \\"TotalResources\\": {\\n \\"Gpu\\": 0,\\n \\"Cpu\\": 1,\\n \\"Memory\\": 1024\\n },\\n \\"UsedResources\\": {\\n \\"Gpu\\": 0,\\n \\"Cpu\\": 1,\\n \\"Memory\\": 1\\n },\\n \\"StateInSched\\": \\"active\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListNodesByQueueResponse>\\n <PageSize>1</PageSize>\\n <RequestId>B405FF19-2D5F-4489-A84C-BC15CC1B24BD</RequestId>\\n <PageNumber>1</PageNumber>\\n <TotalCount>1</TotalCount>\\n <Nodes>\\n <VpcId>vpc-bp1gnu8br4ay7beb2w****</VpcId>\\n <Status>untracking</Status>\\n <HtEnabled>true</HtEnabled>\\n <Expired>false</Expired>\\n <ImageOwnerAlias>system</ImageOwnerAlias>\\n <LockReason>financial</LockReason>\\n <HostName>compute0</HostName>\\n <PublicIpAddress>10.34.**.**</PublicIpAddress>\\n <SpotStrategy>NoSpot</SpotStrategy>\\n <CreatedByEhpc>true</CreatedByEhpc>\\n <RegionId>cn-hangzhou</RegionId>\\n <VSwitchId>vsw-bp1e47optm9g58zcu****</VSwitchId>\\n <IpAddress>172.168.**.**</IpAddress>\\n <ExpiredTime>2020-09-18T13:24:29.000Z</ExpiredTime>\\n <Version>1.0.64</Version>\\n <ZoneId>cn-hangzhou-b</ZoneId>\\n <AddTime>2019-09-18T13:24:29.000Z</AddTime>\\n <ImageId>centos_7_02_64_20G_alibase_20170818****</ImageId>\\n <Location>PublicCloud</Location>\\n <Id>i-bp13p7vlcb1uihfv****</Id>\\n <CreateMode>manual</CreateMode>\\n <TotalResources>\\n <Gpu>0</Gpu>\\n <Cpu>1</Cpu>\\n <Memory>1024</Memory>\\n </TotalResources>\\n <UsedResources>\\n <Gpu>0</Gpu>\\n <Cpu>1</Cpu>\\n <Memory>1</Memory>\\n </UsedResources>\\n <StateInSched>active</StateInSched>\\n </Nodes>\\n</ListNodesByQueueResponse>","errorExample":""}]', + 'title' => 'ListNodesByQueue', + 'summary' => 'Queries the node information of a single cluster within an Alibaba Cloud account by queue.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetQueue' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75912', + 'abilityTreeNodes' => [ + 'FEATUREehpcAB36B2', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination queue.'."\n" + ."\n" + .'You can call the [ListQueues](~~92176~~) operation to query the queue name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'work', + ], + ], + [ + 'name' => 'Node', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the compute node that you want to move. Valid values of N: 1 to 100.'."\n" + ."\n" + .'You can call the [ListNodes](~~87161~~) operation to query the names of the compute nodes.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'compute1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'DFC3EAA9-F11F-4ED0-836F-4FFCB279E700', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DFC3EAA9-F11F-4ED0-836F-4FFCB279E700\\"\\n}","errorExample":""},{"type":"xml","example":"<SetQueueResponse>\\n <RequestId>DFC3EAA9-F11F-4ED0-836F-4FFCB279E700</RequestId>\\n</SetQueueResponse>","errorExample":""}]', + 'title' => 'SetQueue', + 'summary' => 'Moves compute nodes from a queue to another queue.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteQueue' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '75801', + 'abilityTreeNodes' => [ + 'FEATUREehpcAB36B2', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the queue that you want to delete.'."\n" + ."\n" + .'You can call the [ListQueues](~~92176~~) operation to query the name of the queue.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'workq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '464E9919-D04F-4D1D-B375-15989492****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"464E9919-D04F-4D1D-B375-15989492****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteQueueResponse>\\n <RequestId>464E9919-D04F-4D1D-B375-15989492****</RequestId>\\n</DeleteQueueResponse>","errorExample":""}]', + 'title' => 'DeleteQueue', + 'summary' => 'Deletes a queue in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetSchedulerInfo' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'You can call the [ListRegions](~~188593~~) operation to obtain the IDs of regions supported by Elastic High Performance Computing (E-HPC).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PbsInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about PBS schedulers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AclLimit' => [ + 'description' => 'The information about limits on the queue.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Queue' => [ + 'description' => 'AclLimit specifies the queue that has limits when it is used. Valid values of N: 0 to 100.'."\n" + ."\n" + .'If you set `PbsInfo.N.AclLimit.N.Queue` to `workq` and `PbsInfo.N.AclLimit.N.AclUsers` to `user1,user2`, workq can be used only by user1 and user2.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + 'AclUsers' => [ + 'description' => 'The user that can use the queue. Separate multiple users with commas (`,`).'."\n" + ."\n" + .'If you specify users, you must specify the PbsInfo.N.AclLimit.N.Queue parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user1,user2', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ResourceLimit' => [ + 'description' => 'The information about the nodes that are used by cluster users.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'The maximum number of nodes that can be used in a queue.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'Cpus' => [ + 'description' => 'The maximum number of vCPUs that can be used for nodes in a queue.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'User' => [ + 'description' => 'The name of the user that runs jobs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + 'Queue' => [ + 'description' => 'PbsInfo specifies the number of PBS schedulers that can be configured in the cluster. Valid values of N: 0 to 100.'."\n" + ."\n" + .'ResourceLimit specifies the maximum number of queue resources that can be used. Valid values of N: 0 to 100.'."\n" + ."\n" + .'Queue specifies the name of the queue that is used to run jobs.'."\n" + ."\n" + .'If one of the User, Cpus, Nodes, and Mem parameters is set in ResourceLimit, you must specify the Queue parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + 'Mem' => [ + 'description' => 'The maximum memory resources that can be used in a queue. Units:'."\n" + ."\n" + .'* gb'."\n" + .'* mb'."\n" + .'* kb'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2gb', + ], + 'MaxJobs' => [ + 'description' => 'The maximum number of jobs that can be submitted to the cluster. If the total number of running jobs and queuing jobs exceeds the value, no more jobs can be submitted.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + 'JobHistoryDuration' => [ + 'description' => 'The retention period of jobs. After the retention period is exceeded, job data is deleted. Unit: days.\\'."\n" + .'Valid values: 1 to 30.\\'."\n" + .'Default value: 14.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '14', + ], + 'SchedInterval' => [ + 'description' => 'PbsInfo specifies the number of PBS schedulers that can be configured in the cluster. Valid values of N: 0 to 100.'."\n" + ."\n" + .'SchedInterval specifies the scheduling period. Unit: seconds.'."\n" + ."\n" + .'A scheduling period is the interval between two consecutive running jobs. If you set SchedInterval to 60, another job can be run 60 seconds after a job starts running.'."\n" + ."\n" + .'Default value: 60.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + 'SchedMaxJobs' => [ + 'description' => 'The maximum number of jobs that can be scheduled in the cluster. If the total number of running jobs and queuing jobs exceeds the value, no more jobs can be submitted. Default value: 20000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20000', + ], + 'SchedMaxQueuedJobs' => [ + 'description' => 'The maximum number of queuing jobs that can be scheduled in the cluster. If the number of queuing jobs exceeds the value, no more jobs can be submitted. Default value: 10000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'SlurmInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about Slurm schedulers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BackfillInterval' => [ + 'description' => 'The backfill scheduling period. Unit: seconds.'."\n" + ."\n" + .'Default value: 60.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + 'SchedInterval' => [ + 'description' => 'SlurmInfo specifies the number of Slurm schedulers that can be configured in the cluster. Valid values of N: 0 to 100.'."\n" + ."\n" + .'SchedInterval specifies the scheduling period. Unit: seconds.'."\n" + ."\n" + .'Default value: 60.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'Scheduler', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The scheduler information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SchedName' => [ + 'description' => 'The name of the scheduler. Valid values:'."\n" + ."\n" + .'* pbs'."\n" + .'* pbs19'."\n" + .'* slurm'."\n" + .'* slurm19'."\n" + .'* slurm20'."\n" + ."\n" + .'> If you set Scheduler.N.SchedName to pbs or pbs19, you must specify at least one of the PbsInfo.N.SchedInterval, PbsInfo.N.JobHistoryDuration, PbsInfo.N.ResourceLimit, and PbsInfo.N.AclLimit parameters. If you set Scheduler.N.SchedName to slurm, slurm19, or slurm20, you must specify at least one of the SlurmInfo.N.SchedInterval and SlurmInfo.N.BackfillInterval parameters.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'pbs', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'string', + 'example' => 'pbs: scheduler setting successfully.', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BBC2F93D-003A-49C4-850C-B826EECF****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The target cluster is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"pbs: scheduler setting successfully.\\",\\n \\"RequestId\\": \\"BBC2F93D-003A-49C4-850C-B826EECF****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetSchedulerInfoResponse>\\n<Message>pbs: scheduler setting successfully.</Message>\\n<RequestId>BBC2F93D-003A-49C4-850C-B826EECF****</RequestId>\\n</SetSchedulerInfoResponse>","errorExample":""}]', + 'title' => 'SetSchedulerInfo', + 'summary' => 'Configures the scheduler settings of a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetSchedulerInfo' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Scheduler', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The detailed settings of the scheduler.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SchedName' => [ + 'description' => 'The scheduler name. Valid values:'."\n" + ."\n" + .'* pbs'."\n" + .'* pbs19'."\n" + .'* slurm'."\n" + .'* slurm19'."\n" + .'* slurm20'."\n" + ."\n" + .'Valid values of N: 0 to 100.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pbs', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BBC2F93D-003A-49C4-850C-B826EECF****', + ], + 'SchedInfo' => [ + 'description' => 'The settings of the scheduler.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Configuration' => [ + 'description' => 'The detailed settings of the scheduler.'."\n", + 'type' => 'string', + 'example' => '{"AclInfo":[{"AclEnable": false,"UntrackUser": [],"User": [],"QueueName": "workq"}],"JobHistory": "","SchedIteration": "60","QueueResource": [{"UntrackUser": [],"User": [],"QueueName": "workq"}]}', + ], + 'SchedName' => [ + 'description' => 'The type of the scheduler.'."\n", + 'type' => 'string', + 'example' => 'pbs', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BBC2F93D-003A-49C4-850C-B826EECF****\\",\\n \\"SchedInfo\\": [\\n {\\n \\"Configuration\\": \\"{\\\\\\"AclInfo\\\\\\":[{\\\\\\"AclEnable\\\\\\":false,\\\\\\"UntrackUser\\\\\\":[],\\\\\\"User\\\\\\":[],\\\\\\"QueueName\\\\\\":\\\\\\"workq\\\\\\"}],\\\\\\"JobHistory\\\\\\":\\\\\\"\\\\\\",\\\\\\"SchedIteration\\\\\\":\\\\\\"60\\\\\\",\\\\\\"QueueResource\\\\\\":[{\\\\\\"UntrackUser\\\\\\":[],\\\\\\"User\\\\\\":[],\\\\\\"QueueName\\\\\\":\\\\\\"workq\\\\\\"}]}\\",\\n \\"SchedName\\": \\"pbs\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetSchedulerInfoResponse>\\n<RequestId>193120A7-3216-4DD7-9FE3-13DC77BD****</RequestId>\\n<SchedInfo>\\n <Configuration>\\n <AclInfo>\\n <AclEnable>false</AclEnable>\\n <QueueName>workq</QueueName>\\n </AclInfo>\\n <JobHistory/>\\n <SchedIteration>60</SchedIteration>\\n <QueueResource>\\n <QueueName>workq</QueueName>\\n </QueueResource>\\n </Configuration>\\n <SchedName>pbs</SchedName>\\n</SchedInfo>\\n</GetSchedulerInfoResponse>","errorExample":""}]', + 'title' => 'GetSchedulerInfo', + 'summary' => 'Queries the scheduler settings of a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSoftwares' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'EhpcVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the E-HPC client.'."\n" + ."\n" + .'You can call the [ListCurrentClientVersion](~~87223~~) operation to query the E-HPC client version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'OsTag', + 'in' => 'query', + 'schema' => [ + 'description' => 'The image tag of the cluster.'."\n" + ."\n" + .'You can use the [ListImages](~~87213~~) to query the image tag of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Softwares' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SoftwareInfo' => [ + 'description' => 'The list of the information about the software installed in the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => [ + 'description' => 'The type of the scheduler. Valid values:'."\n" + ."\n" + .'* pbs'."\n" + .'* pbs19'."\n" + .'* slurm'."\n" + .'* slurm19'."\n" + .'* slurm20'."\n" + .'* opengridscheduler'."\n" + .'* deadline'."\n" + .'* gridengine'."\n" + .'* cube'."\n" + .'* custom'."\n", + 'type' => 'string', + 'example' => 'pbs', + ], + 'OsTag' => [ + 'description' => 'The image tag of the cluster.'."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'SchedulerVersion' => [ + 'description' => 'The version of the scheduler.'."\n", + 'type' => 'string', + 'example' => '18.1.1', + ], + 'AccountVersion' => [ + 'description' => 'The version of the domain account service.'."\n", + 'type' => 'string', + 'example' => '2.31', + ], + 'AccountType' => [ + 'description' => 'The service type of the domain account. Valid values:'."\n" + ."\n" + .'* nis'."\n" + .'* ldap'."\n", + 'type' => 'string', + 'example' => 'nis', + ], + 'EhpcVersion' => [ + 'description' => 'The version of the E-HPC client.', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'Applications' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApplicationInfo' => [ + 'description' => 'The list of the software in the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Required' => [ + 'description' => 'Indicates whether the software is required. Valid values:'."\n" + ."\n" + .'* false: optional'."\n" + .'* true: required'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tag' => [ + 'description' => 'The tag of the software.'."\n", + 'type' => 'string', + 'example' => 'CUDNN_9.0', + ], + 'Name' => [ + 'description' => 'The name of the software.'."\n", + 'type' => 'string', + 'example' => 'cudnnt', + ], + 'Version' => [ + 'description' => 'The version of the software.'."\n", + 'type' => 'string', + 'example' => '9.0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"Softwares\\": {\\n \\"SoftwareInfo\\": [\\n {\\n \\"SchedulerType\\": \\"pbs\\",\\n \\"OsTag\\": \\"CentOS_7.2_64\\",\\n \\"SchedulerVersion\\": \\"18.1.1\\",\\n \\"AccountVersion\\": \\"2.31\\",\\n \\"AccountType\\": \\"nis\\",\\n \\"EhpcVersion\\": \\"1.0.0\\",\\n \\"Applications\\": {\\n \\"ApplicationInfo\\": [\\n {\\n \\"Required\\": true,\\n \\"Tag\\": \\"CUDNN_9.0\\",\\n \\"Name\\": \\"cudnnt\\",\\n \\"Version\\": \\"9.0\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListSoftwaresResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n <Softwares>\\n <SchedulerType>pbs</SchedulerType>\\n <OsTag>CentOS_7.2_64</OsTag>\\n <SchedulerVersion>18.1.1</SchedulerVersion>\\n <AccountVersion>2.31</AccountVersion>\\n <AccountType>nis</AccountType>\\n <EhpcVersion>1.0.0</EhpcVersion>\\n <Applications>\\n <Required>true</Required>\\n <Tag>CUDNN_9.0</Tag>\\n <Name>cudnnt</Name>\\n <Version>9.0</Version>\\n </Applications>\\n </Softwares>\\n</ListSoftwaresResponse>","errorExample":""}]', + 'title' => 'ListSoftwares', + 'summary' => 'Queries the list of software that can be installed in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InstallSoftware' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '75861', + 'abilityTreeNodes' => [ + 'FEATUREehpcL8RMWH', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'Application', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the software that you want to install.'."\n" + ."\n" + .'You can call the [ListSoftwares](~~87216~~) operation to query the software that can be installed.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ABYSS_2.1.5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","errorExample":""},{"type":"xml","example":"<InstallSoftwareResponse>\\r\\n <RequestId>896D338C-E4F4-41EC-A154-D605E5DE****</RequestId>\\r\\n</InstallSoftwareResponse>","errorExample":""}]', + 'title' => 'InstallSoftware', + 'summary' => 'Installs software in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListInstalledSoftware' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DDCA0E7B-03E7-430D-810C-0D508539****', + ], + 'SoftwareList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SoftwareList' => [ + 'description' => 'The installed software.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SoftwareId' => [ + 'description' => 'The software ID.'."\n", + 'type' => 'string', + 'example' => 'MPICH_3.2', + ], + 'SoftwareStatus' => [ + 'description' => 'The status of the software. Valid values:'."\n" + ."\n" + .'* Installing: The software is being installed.'."\n" + .'* Installed: The software is installed.'."\n", + 'type' => 'string', + 'example' => 'Installing', + ], + 'SoftwareVersion' => [ + 'description' => 'The version of the software.'."\n", + 'type' => 'string', + 'example' => '3.2', + ], + 'SoftwareName' => [ + 'description' => 'The name of the software.'."\n", + 'type' => 'string', + 'example' => 'mpich', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DDCA0E7B-03E7-430D-810C-0D508539****\\",\\n \\"SoftwareList\\": {\\n \\"SoftwareList\\": [\\n {\\n \\"SoftwareId\\": \\"MPICH_3.2\\",\\n \\"SoftwareStatus\\": \\"Installing\\",\\n \\"SoftwareVersion\\": \\"3.2\\",\\n \\"SoftwareName\\": \\"mpich\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListInstalledSoftwareResponse>\\r\\n <code>200</code>\\r\\n <data>\\r\\n <SoftwareList>\\r\\n <SoftwareList>\\r\\n <SoftwareVersion>3.2</SoftwareVersion>\\r\\n <SoftwareStatus>Installing</SoftwareStatus>\\r\\n <SoftwareId>MPICH_3.2</SoftwareId>\\r\\n <SoftwareName>mpich</SoftwareName>\\r\\n </SoftwareList>\\r\\n </SoftwareList>\\r\\n </data>\\r\\n <requestId>DDCA0E7B-03E7-430D-810C-0D508539****</requestId>\\r\\n <successResponse>true</successResponse>\\r\\n</ListInstalledSoftwareResponse>","errorExample":""}]', + 'title' => 'ListInstalledSoftware', + 'summary' => 'Queries the software that is installed in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UninstallSoftware' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'Application', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the software that you want to uninstall.'."\n" + ."\n" + .'You can call the [ListInstalledSoftware](~~188591~~) operation to query the software that is installed in the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ABYSS_2.1.5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C84FB8EF-5580-4B82-9BDE-6657814C****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C84FB8EF-5580-4B82-9BDE-6657814C****\\"\\n}","errorExample":""},{"type":"xml","example":"<UninstallSoftwareResponse>\\n <RequestId>C84FB8EF-5580-4B82-9BDE-6657814C****</RequestId>\\n</UninstallSoftwareResponse>","errorExample":""}]', + 'title' => 'UninstallSoftware', + 'summary' => 'Uninstalls software from a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListFileSystemWithMountTargets' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page. Valid values: 1 to 50. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '25638B77-2F19-5DC5-B578-7790CE92052B', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FileSystemList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FileSystems' => [ + 'description' => 'The queried file systems.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the file system. Valid values:'."\n" + ."\n" + .'* Pending: The file system is being created or modified.'."\n" + .'* Running: The file system is available.'."\n" + .'* Stopped: The file system is unavailable.'."\n" + .'* Extending: The file system is being scaled up.'."\n" + .'* Stopping: The file system is being disabled.'."\n" + .'* Deleting: The file system is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'Capacity' => [ + 'description' => 'The capacity of the file system. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5120', + ], + 'CreateTime' => [ + 'description' => 'The time when the file system was created.'."\n", + 'type' => 'string', + 'example' => '2018-07-26 16:36:27', + ], + 'StorageType' => [ + 'description' => 'The storage type of the file system.'."\n" + ."\n" + .'* Valid values if FileSystemType is set to standard: Capacity and Performance.'."\n" + .'* Valid values if FileSystemType is set to extreme: standard and advance.'."\n", + 'type' => 'string', + 'example' => 'Performance', + ], + 'BandWidth' => [ + 'description' => 'The bandwidth of the file system. Unit: Mbit/s.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FileSystemId' => [ + 'description' => 'The ID of the file system.'."\n", + 'type' => 'string', + 'example' => '088b****', + ], + 'FileSystemType' => [ + 'description' => 'The type of the file system. Valid value:'."\n" + ."\n" + .'* standard: general-purpose network-attached storage (NAS) file systems.'."\n" + .'* extreme: extreme NAS file systems.'."\n", + 'type' => 'string', + 'example' => 'standard', + ], + 'MeteredSize' => [ + 'description' => 'The used capacity of the NAS file system. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1216816455', + ], + 'EncryptType' => [ + 'description' => 'Indicates whether data in the file system is encrypted.'."\n" + ."\n" + .'You can use keys that are managed by Key Management Service (KMS) to encrypt the data in a file system. When you read and write the encrypted data, the data is automatically decrypted.'."\n" + ."\n" + .'Default value: 0. Valid values:'."\n" + ."\n" + .'* 0: The data in the file system is not encrypted.'."\n" + .'* 1: The data in the file system is encrypted by using a NAS-managed key. This parameter is valid if FileSystemType is set to standard or extreme.'."\n" + .'* 2: The data in the file system is encrypted by using a KMS-managed key. This parameter is valid only if FileSystemType is set to extreme.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProtocolType' => [ + 'description' => 'The protocol type of the file system. Valid values:'."\n" + ."\n" + .'* NFS- SMB'."\n", + 'type' => 'string', + 'example' => 'NFS', + ], + 'Destription' => [ + 'description' => 'The description of the file system.'."\n", + 'type' => 'string', + 'example' => 'FilesDescription', + ], + 'PackageList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Packages' => [ + 'description' => 'The list of storage plans.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PackageId' => [ + 'description' => 'The ID of the storage plan.'."\n", + 'type' => 'string', + 'example' => 'naspackage-0be9c4b624-37****', + ], + ], + ], + ], + ], + ], + 'MountTargetList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MountTargets' => [ + 'description' => 'The list of mount targets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the mount target. Valid values:'."\n" + ."\n" + .'* Active: The mount target is available.'."\n" + .'* Inactive: The mount target is unavailable.'."\n" + .'* Pending: The mount target is being created or modified.'."\n" + .'* Deleting: The mount target is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'example' => 'vpc-8vbvb34rtyh6xb3zrehs1****', + ], + 'MountTargetDomain' => [ + 'description' => 'The domain in which the mount target resides.'."\n", + 'type' => 'string', + 'example' => '088b****-lj2.cn-hangzhou.nas.aliyuncs.com', + ], + 'AccessGroup' => [ + 'description' => 'Indicates whether the permission group is the default permission group of the user.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: The permission group is the default permission group. In this case, all IP addresses are allowed to access the permission group, and the user cannot delete the permission group and permission rules in the permission group.'."\n" + .'* false: The permission group is not the default permission group.'."\n", + 'type' => 'string', + 'example' => 'DEFAULT_VPC_GROUP_NAME', + ], + 'VswId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-8vb34rtyh6xb3zrehs1****', + ], + 'NetworkType' => [ + 'description' => 'The network type. Valid values:'."\n" + ."\n" + .'* vpc'."\n" + .'* classic'."\n", + 'type' => 'string', + 'example' => 'vpc', + ], + ], + ], + ], + ], + ], + 'VpcId' => [ + 'description' => 'The ID of the VPC.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp132kgui8n0targbn1cm', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 406 => [ + [ + 'errorCode' => 'NasError', + 'errorMessage' => 'NAS API request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + [ + 'errorCode' => 'EntityNotExist.Role', + 'errorMessage' => 'The role does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"25638B77-2F19-5DC5-B578-7790CE92052B\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"FileSystemList\\": {\\n \\"FileSystems\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"Capacity\\": 5120,\\n \\"CreateTime\\": \\"2018-07-26 16:36:27\\",\\n \\"StorageType\\": \\"Performance\\",\\n \\"BandWidth\\": 150,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FileSystemId\\": \\"088b****\\",\\n \\"FileSystemType\\": \\"standard\\",\\n \\"MeteredSize\\": 1216816455,\\n \\"EncryptType\\": 0,\\n \\"ProtocolType\\": \\"NFS\\",\\n \\"Destription\\": \\"FilesDescription\\",\\n \\"PackageList\\": {\\n \\"Packages\\": [\\n {\\n \\"PackageId\\": \\"naspackage-0be9c4b624-37****\\"\\n }\\n ]\\n },\\n \\"MountTargetList\\": {\\n \\"MountTargets\\": [\\n {\\n \\"Status\\": \\"Active\\",\\n \\"VpcId\\": \\"vpc-8vbvb34rtyh6xb3zrehs1****\\",\\n \\"MountTargetDomain\\": \\"088b****-lj2.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"AccessGroup\\": \\"DEFAULT_VPC_GROUP_NAME\\",\\n \\"VswId\\": \\"vsw-8vb34rtyh6xb3zrehs1****\\",\\n \\"NetworkType\\": \\"vpc\\"\\n }\\n ]\\n },\\n \\"VpcId\\": \\"vpc-bp132kgui8n0targbn1cm\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListFileSystemWithMountTargets', + 'summary' => 'Queries file systems and mount targets.', + ], + 'ListCpfsFileSystems' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the file system.'."\n" + ."\n" + .'By default, the information about all CPFSs and their mount targets within your account are queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '096751****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n" + ."\n" + .'Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2B900AFE-C938-4551-86E9-97E231BBC876', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'FileSystemList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FileSystems' => [ + 'description' => 'The queried file systems.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => 'The ID of the file system.'."\n", + 'type' => 'string', + 'example' => '096751****', + ], + 'Capacity' => [ + 'description' => 'The capacity of the file system. Unit: GiB'."\n", + 'type' => 'string', + 'example' => '5120', + ], + 'CreateTime' => [ + 'description' => 'The time when the file system was created.'."\n", + 'type' => 'string', + 'example' => '2018-07-26 16:36:27', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'ProtocolType' => [ + 'description' => 'The protocol type that is applied to the mounted file system. Valid values:'."\n" + ."\n" + .'* NFS'."\n" + .'* SMB'."\n", + 'type' => 'string', + 'example' => 'NFS', + ], + 'Destription' => [ + 'description' => 'The description of the file system.'."\n", + 'type' => 'string', + 'example' => 'FilsDestription', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'MountTargetList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MountTargets' => [ + 'description' => 'The mount targets of the file systems.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'example' => 'vpc-8vbvb34rtyh6xb3zrehs1****', + ], + 'Status' => [ + 'description' => 'The status of the mount target. Valid values:'."\n" + ."\n" + .'* Active: The mount target is available.'."\n" + .'* Inactive: The mount target is unavailable.'."\n" + .'* Pending: The mount target is being mounted.'."\n" + .'* Deleting: The mount target is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'VswId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-8vb34rtyh6xb3zrehs1****', + ], + 'NetworkType' => [ + 'description' => 'The network type.'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'MountTargetDomain' => [ + 'description' => 'The domain in which the mount target resides.'."\n", + 'type' => 'string', + 'example' => 'c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 406 => [ + [ + 'errorCode' => 'NasError', + 'errorMessage' => 'NAS API request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"2B900AFE-C938-4551-86E9-97E231BBC876\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 10,\\n \\"FileSystemList\\": {\\n \\"FileSystems\\": [\\n {\\n \\"FileSystemId\\": \\"096751****\\",\\n \\"Capacity\\": \\"5120\\",\\n \\"CreateTime\\": \\"2018-07-26 16:36:27\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"ProtocolType\\": \\"NFS\\",\\n \\"Destription\\": \\"FilsDestription\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"MountTargetList\\": {\\n \\"MountTargets\\": [\\n {\\n \\"VpcId\\": \\"vpc-8vbvb34rtyh6xb3zrehs1****\\",\\n \\"Status\\": \\"Active\\",\\n \\"VswId\\": \\"vsw-8vb34rtyh6xb3zrehs1****\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"MountTargetDomain\\": \\"c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCpfsFileSystemsResponse>\\r\\n <PageNumber>1</PageNumber>\\r\\n <TotalCount>10</TotalCount>\\r\\n <FileSystemList>\\r\\n <FileSystems>\\r\\n <FileSystemId>096751****</FileSystemId>\\r\\n <MountTargetList>\\r\\n <MountTargets>\\r\\n <Status>Active</Status>\\r\\n <NetworkType>Vpc</NetworkType>\\r\\n <VswId>vsw-8vb34rtyh6xb3zrehs1****</VswId>\\r\\n <MountTargetDomain>c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com </MountTargetDomain>\\r\\n <VpcId>vpc-8vbvb34rtyh6xb3zrehs1****</VpcId>\\r\\n </MountTargets>\\r\\n </MountTargetList>\\r\\n <ProtocolType>NFS</ProtocolType>\\r\\n <RegionId>cn-hangzhou</RegionId>\\r\\n <CreateTime>2018-07-26 16:36:27</CreateTime>\\r\\n <ZoneId>cn-hangzhou-a</ZoneId>\\r\\n <Capacity>5120</Capacity>\\r\\n </FileSystems>\\r\\n </FileSystemList>\\r\\n <PageSize>10</PageSize>\\r\\n <RequestId>2B900AFE-C938-4551-86E9-97E231BBC876</RequestId>\\r\\n</ListCpfsFileSystemsResponse>","errorExample":""}]', + 'title' => 'ListCpfsFileSystems', + 'summary' => 'Queries the information about Cloud Paralleled File System (CPFS) and its mount targets.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetClusterVolumes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-gh5WKb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '8BCFD52E-0336-4490-AE7D-F560F106****', + ], + 'Volumes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VolumeInfo' => [ + 'description' => 'The array of the file system mounted to the E-HPC cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobQueue' => [ + 'description' => 'The queue of the job.'."\n", + 'type' => 'string', + 'example' => 'workq', + ], + 'VolumeId' => [ + 'description' => 'The ID of the file system.', + 'type' => 'string', + 'example' => '0e754****', + ], + 'RemoteDirectory' => [ + 'description' => 'The remote mount directory.'."\n", + 'type' => 'string', + 'example' => '/test', + ], + 'VolumeMountpoint' => [ + 'description' => 'The address of the mount target.'."\n", + 'type' => 'string', + 'example' => '0e754****-kal90.cn-hangzhou.nas.aliyuncs.com', + ], + 'LocalDirectory' => [ + 'description' => 'The local mount directory.'."\n", + 'type' => 'string', + 'example' => '/ehpcdata', + ], + 'VolumeType' => [ + 'description' => 'The type of the file system. Valid values:'."\n" + ."\n" + .'* NAS'."\n", + 'type' => 'string', + 'example' => 'NAS', + ], + 'MustKeep' => [ + 'description' => 'Indicates whether the resource can be unmounted.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Location' => [ + 'description' => 'The type of cluster. Valid values:'."\n" + ."\n" + .'* OnPremise: The cluster is deployed on a hybrid cloud.'."\n" + .'* PublicCloud: The cluster is deployed on a public cloud.'."\n", + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'VolumeProtocol' => [ + 'description' => 'The storage protocol type of the file system. Valid values:'."\n" + ."\n" + .'* NFS'."\n" + .'* SMB'."\n", + 'type' => 'string', + 'example' => 'NFS', + ], + 'Roles' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RoleInfo' => [ + 'description' => 'The array of the node on which the file system is mounted.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The type of the node on which the file system is mounted. Valid values:'."\n" + ."\n" + .'* Compute: compute node'."\n" + .'* Manager: management node'."\n" + .'* Login: logon node'."\n", + 'type' => 'string', + 'example' => 'Compute', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'NasError', + 'errorMessage' => 'NAS API request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RequestId\\": \\"8BCFD52E-0336-4490-AE7D-F560F106****\\",\\n \\"Volumes\\": {\\n \\"VolumeInfo\\": [\\n {\\n \\"JobQueue\\": \\"workq\\",\\n \\"VolumeId\\": \\"0e754****\\",\\n \\"RemoteDirectory\\": \\"/test\\",\\n \\"VolumeMountpoint\\": \\"0e754****-kal90.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"LocalDirectory\\": \\"/ehpcdata\\",\\n \\"VolumeType\\": \\"NAS\\",\\n \\"MustKeep\\": true,\\n \\"Location\\": \\"PublicCloud\\",\\n \\"VolumeProtocol\\": \\"NFS\\",\\n \\"Roles\\": {\\n \\"RoleInfo\\": [\\n {\\n \\"Name\\": \\"Compute\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetClusterVolumesResponse>\\n <Volumes>\\n <VolumeInfo>\\n <VolumeProtocol>NFS</VolumeProtocol>\\n <LocalDirectory>/ehpcdata</LocalDirectory>\\n <RemoteDirectory>/</RemoteDirectory>\\n <VolumeId>0e754****</VolumeId>\\n <VolumeType>NAS</VolumeType>\\n <JobQueue>workq</JobQueue>\\n <MustKeep>true</MustKeep>\\n <VolumeMountpoint>0e754****-kal90.cn-hangzhou.nas.aliyuncs.com<</VolumeMountpoint>\\n <Location>PublicCloud</Location>\\n </VolumeInfo>\\n <VolumeInfo>\\n <Roles>\\n <RoleInfo>\\n <Name>Compute</Name>\\n </RoleInfo>\\n </Roles>\\n </VolumeInfo>\\n </Volumes>\\n <RequestId>8BCFD52E-0336-4490-AE7D-F560F1065F9B</RequestId>\\n <RegionId>cn-hangzhou</RegionId>\\n</GetClusterVolumesResponse>","errorExample":""}]', + 'title' => 'GetClusterVolumes', + 'summary' => 'Queries the information of the NAS file system mounted to a specified cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListVolumes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n" + ."\n" + .'Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Volumes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VolumeInfo' => [ + 'description' => 'The information of file systems that are mounted on E-HPC clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VolumeId' => [ + 'description' => 'The ID of the file system.'."\n", + 'type' => 'string', + 'example' => 'bc8a****', + ], + 'ClusterName' => [ + 'description' => 'The instance name.'."\n", + 'type' => 'string', + 'example' => 'cluster1', + ], + 'RemoteDirectory' => [ + 'description' => 'The remote directory on which the file system is mounted.'."\n", + 'type' => 'string', + 'example' => '/test1', + ], + 'VolumeMountpoint' => [ + 'description' => 'The domain name of the mount target.'."\n", + 'type' => 'string', + 'example' => 'bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com', + ], + 'VolumeType' => [ + 'description' => 'The type of the file system that is mounted on the cluster. Only NAS is supported.'."\n", + 'type' => 'string', + 'example' => 'NAS', + ], + 'VolumeProtocol' => [ + 'description' => 'The type of the storage protocol. Valid values:'."\n" + ."\n" + .'* NFS'."\n" + .'* SMB'."\n", + 'type' => 'string', + 'example' => 'NFS', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'AdditionalVolumes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VolumeInfo' => [ + 'description' => 'The information of additional file systems mounted on E-HPC clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobQueue' => [ + 'description' => 'The queue to which the job belongs.'."\n", + 'type' => 'string', + 'example' => 'all.q', + ], + 'VolumeId' => [ + 'description' => 'The ID of the file system.'."\n", + 'type' => 'string', + 'example' => '86y3****', + ], + 'RemoteDirectory' => [ + 'description' => 'The remote directory on which the file system is mounted.'."\n", + 'type' => 'string', + 'example' => '/test', + ], + 'VolumeMountpoint' => [ + 'description' => 'The domain name of the mount target.'."\n", + 'type' => 'string', + 'example' => '86y3****-rgd51.cn-hangzhou.nas.aliyuncs.com', + ], + 'Role' => [ + 'description' => 'The type of the node on which the file system is mounted. Valid values:'."\n" + ."\n" + .'* Manager: management node'."\n" + .'* Login: logon node'."\n" + .'* Compute: compute node'."\n", + 'type' => 'string', + 'example' => 'Compute', + ], + 'LocalDirectory' => [ + 'description' => 'The local mount directory.'."\n", + 'type' => 'string', + 'example' => '/testopt', + ], + 'VolumeType' => [ + 'description' => 'The type of the additional file system. Only NAS is supported.'."\n", + 'type' => 'string', + 'example' => 'NAS', + ], + 'Location' => [ + 'description' => 'The location where the cluster is deployed. Valid values:'."\n" + ."\n" + .'* OnPremise: The node is deployed on a hybrid cloud.'."\n" + .'* PublicCloud: The cluster is deployed on a public cloud.'."\n", + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'VolumeProtocol' => [ + 'description' => 'The type of the storage protocol. Valid values:'."\n" + ."\n" + .'* NFS'."\n" + .'* SMB'."\n", + 'type' => 'string', + 'example' => 'NFS', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 406 => [ + [ + 'errorCode' => 'NasError', + 'errorMessage' => 'NAS API request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Volumes\\": {\\n \\"VolumeInfo\\": [\\n {\\n \\"VolumeId\\": \\"bc8a****\\",\\n \\"ClusterName\\": \\"cluster1\\",\\n \\"RemoteDirectory\\": \\"/test1\\",\\n \\"VolumeMountpoint\\": \\"bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"VolumeType\\": \\"NAS\\",\\n \\"VolumeProtocol\\": \\"NFS\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\",\\n \\"AdditionalVolumes\\": {\\n \\"VolumeInfo\\": [\\n {\\n \\"JobQueue\\": \\"all.q\\",\\n \\"VolumeId\\": \\"86y3****\\",\\n \\"RemoteDirectory\\": \\"/test\\",\\n \\"VolumeMountpoint\\": \\"86y3****-rgd51.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"Role\\": \\"Compute\\",\\n \\"LocalDirectory\\": \\"/testopt\\",\\n \\"VolumeType\\": \\"NAS\\",\\n \\"Location\\": \\"PublicCloud\\",\\n \\"VolumeProtocol\\": \\"NFS\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListVolumesResponse>\\n <TotalCount>1</TotalCount>\\n <Volumes>\\n <VolumeInfo>\\n <VolumeProtocol>nfs</VolumeProtocol>\\n <RemoteDirectory>/test1</RemoteDirectory>\\n <VolumeId>bc8a****</VolumeId>\\n <VolumeType>NAS</VolumeType>\\n <ClusterId>ehpc-hz-FYUr32****</ClusterId>\\n <ClusterName>cluster1</ClusterName>\\n <RegionId>cn-hangzhou</RegionId>\\n <VolumeMountpoint>bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com</VolumeMountpoint>\\n </VolumeInfo>\\n <VolumeInfo>\\n <AdditionalVolumes>\\n <VolumeInfo>\\n <Role>Compute</Role>\\n <VolumeProtocol>NFS</VolumeProtocol>\\n <LocalDirectory>/testopt</LocalDirectory>\\n <RemoteDirectory>/</RemoteDirectory>\\n <VolumeId>bc8a****</VolumeId>\\n <VolumeType>NAS</VolumeType>\\n <JobQueue>all.q</JobQueue>\\n <VolumeMountpoint>bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com</VolumeMountpoint>\\n <Location> </Location>\\n </VolumeInfo>\\n </AdditionalVolumes>\\n </VolumeInfo>\\n </Volumes>\\n <PageSize>1</PageSize>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <PageNumber>1</PageNumber>\\n</ListVolumesResponse>","errorExample":""}]', + 'title' => 'ListVolumes', + 'summary' => 'Queries the file systems mounted on Elastic High Performance Computing (E-HPC) clusters.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateClusterVolumes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AdditionalVolumes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The file systems that you want to mount.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobQueue' => [ + 'description' => 'The queue name of the file system to be mounted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'work', + ], + 'VolumeId' => [ + 'description' => 'The ID of the file system to be mounted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'extreme-00b88****', + ], + 'Roles' => [ + 'description' => 'The array of the nodes to which the file system is mounted.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The type of the node to which the file system is mounted. Valid values:'."\n" + ."\n" + .'* Manager: management node'."\n" + .'* Login: logon node'."\n" + .'* Compute: compute node'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["Compute"]', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 8, + ], + 'VolumeMountpoint' => [ + 'description' => 'The endpoint of the mount target of the file system.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0088****-sihc.cn-hangzhou.extreme.nas.aliyuncs.com', + ], + 'RemoteDirectory' => [ + 'description' => 'The remote directory to which the file system is mounted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'VolumeType' => [ + 'description' => 'The type of the file system to be mounted. Set the value to NAS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NAS', + ], + 'LocalDirectory' => [ + 'description' => 'The on-premises mount directory of the file system to be mounted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/ff', + ], + 'VolumeProtocol' => [ + 'description' => 'The protocol type of the file system to be mounted. Valid values:'."\n" + ."\n" + .'* NFS'."\n" + .'* SMB'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NFS', + ], + 'Location' => [ + 'description' => 'The storage location of the file system to be mounted. Valid values:'."\n" + ."\n" + .'* OnPremise: The file system is stored in a hybrid cloud.'."\n" + .'* PublicCloud: The file system cluster is stored in a public cloud.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PublicCloud', + ], + 'VolumeMountOption' => [ + 'description' => 'The mount option of the file system to be mounted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-t nfs -o vers=3,nolock,noresvport', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C0842122', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 406 => [ + [ + 'errorCode' => 'NasError', + 'errorMessage' => 'NAS API request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F6757FA4-8FED-4602-B7F5-3550C0842122\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateClusterVolumesResponse>\\r\\n <RequestId>F6757FA4-8FED-4602-B7F5-3550C0842122</RequestId>\\r\\n</UpdateClusterVolumesResponse>","errorExample":""}]', + 'title' => 'UpdateClusterVolumes', + 'summary' => 'Mount new storage resources to a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitJob' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '75923', + 'abilityTreeNodes' => [ + 'FEATUREehpcH08VYA', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The command that is used to run the job.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'CommandLine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the user that runs the job.'."\n" + ."\n" + .'You can call the [ListUsers](~~188572~~) operation to query the users of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => './LammpsTest/lammps.pbs', + ], + ], + [ + 'name' => 'RunasUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that corresponds to the username.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testuser', + ], + ], + [ + 'name' => 'RunasUserPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the job. The name must be 6 to 30 characters in length and start with a letter. It can contain letters, digits, and periods (.).'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '12****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'job1', + 'type' => 'string', + 'required' => false, + 'example' => 'jobtest', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => 'The priority of the job. Valid values: 0 to 9. A larger value indicates a higher priority.'."\n" + ."\n" + .'Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PackagePath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path that is used to run the job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => './Tem', + ], + ], + [ + 'name' => 'StdoutRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The output file path of stdout.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => './LammpsTest', + ], + ], + [ + 'name' => 'StderrRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The output file path of stderr.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => './LammpsTest', + ], + ], + [ + 'name' => 'ReRunable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the job can be rerun. Valid values:'."\n" + ."\n" + .'* true: The job can be rerun.'."\n" + .'* false: The job cannot be rerun.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ArrayRequest', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job array.'."\n" + ."\n" + .'Format: X-Y:Z. The minimum index value X is the first index. The maximum index value Y is the last index. Z is the step size. For example, 2-7:2 indicates that three jobs need to be run and their index values are 2, 4, and 6.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1-10:2', + ], + ], + [ + 'name' => 'Variables', + 'in' => 'query', + 'schema' => [ + 'description' => 'The runtime variables passed to the job. They can be accessed by using environment variables in the executable file.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{Name:test1,Value:value1},{Name:test2,Value:value2}]', + ], + ], + [ + 'name' => 'InputFileUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the job file that is uploaded to an Object Storage Service (OSS) bucket.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://ehpc-hangzhou.oss-cn-hangzhou.aliyuncs.com/test-u4****/testlist_ehpc.sh', + ], + ], + [ + 'name' => 'UnzipCmd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The command for file decompression. The command that is used to decompress the job files downloaded from an OSS bucket. Valid values:'."\n" + ."\n" + .'* tar xzf: Decompresses GZIP files.'."\n" + .'* tar xf: Decompresses TAR files.'."\n" + .'* unzip: Decompresses ZIP files.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tar xzf', + ], + ], + [ + 'name' => 'PostCmdLine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The command to perform on the job after the job is submitted.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'example.sh', + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the queue in which the job is run.'."\n" + ."\n" + .'You can call the [ListQueues](~~92176~~) operation to query the name of the queue.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'Node', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of compute nodes required to run the job.'."\n" + ."\n" + .'> If the parameter is not specified, the Cpu, Task, Thread, Mem, and Gpu parameters become invalid.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Cpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of CPU cores required by a single compute node.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Task', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of processes created for a single compute node.'."\n" + ."\n" + .'The parameter is applicable to Message Passing Interface (MPI) jobs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Thread', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of threads created for a single compute node.'."\n" + ."\n" + .'The parameter is applicable to OpenMP jobs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Mem', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum memory usage required by a single compute node. Unit: GB, MB, or KB. The unit is case-insensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1GB', + ], + ], + [ + 'name' => 'Gpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum GPU usage required by a single compute node.'."\n" + ."\n" + .'The parameter takes effect only when the cluster uses PBS and a compute node is a GPU-accelerated instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClockTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum running time of the job. Valid formats:'."\n" + ."\n" + .'* hh:mm:ss'."\n" + .'* mm:ss'."\n" + .'* ss'."\n" + ."\n" + .'We recommend that you use the hh:mm:ss format. If the maximum running time is 12 hours, set the value to 12:00:00.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12:00:00', + ], + ], + [ + 'name' => 'JobRetry.Count', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of retries for the job. Valid values: 1 to 10. You can only retry jobs that are run on the PBS clusters.'."\n" + ."\n" + .'> If this parameter is left empty, the JobRetry.Priority and JobRetry.OnExitCode parameters do not take effect.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'JobRetry.Priority', + 'in' => 'query', + 'schema' => [ + 'description' => 'The priority of the job retry. Valid values: 0 to 9. A larger value indicates a higher priority.'."\n" + ."\n" + .'> If this parameter is left empty, the priority of the job retry is min {Priority of the original job +1, 9}.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'JobRetry.OnExitCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The retry condition of the job. If the exit code is the value of the parameter, the job retry is triggered.'."\n" + ."\n" + .'> If this parameter is left empty, the job retry is triggered when the exit code is not 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use an asynchronous link to submit the job.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => 'The ID of the job.'."\n", + 'type' => 'string', + 'example' => '1.manager', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'UsernameExist', + 'errorMessage' => 'The username already exists.', + ], + [ + 'errorCode' => 'IncorrectCredential', + 'errorMessage' => 'The username or password is incorrect.', + ], + [ + 'errorCode' => 'AgentError.Account.ValidateCredentialFailure', + 'errorMessage' => 'Username or password verification failed.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ContainerNotFound', + 'errorMessage' => 'The specified container does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError.Job.SubmitFailure', + 'errorMessage' => 'Failed to submit jobs: %s', + ], + [ + 'errorCode' => 'AgentError.Job.InvalidContainerType', + 'errorMessage' => 'Unsupported container type: %s.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentError.Account.AccountValidateCredentialFailure', + 'errorMessage' => 'Cannot get user info', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"JobId\\": \\"1.manager\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<SubmitJobResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n <JobId>1.manager</JobId>\\r\\n</SubmitJobResponse>","errorExample":""}]', + 'title' => 'SubmitJob', + 'summary' => 'Submits a job in a cluster.', + 'description' => 'The ID of the request.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateJobFile' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '75791', + 'abilityTreeNodes' => [ + 'FEATUREehpcH08VYA', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'RunasUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user to which the job file belongs.'."\n" + ."\n" + .'You can call the [ListUsers](~~188572~~) operation to query the users of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testuser1', + ], + ], + [ + 'name' => 'RunasUserPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user password.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '!QAZ****', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the job file. The content is encoded in Base64.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c2xlZXAgMzA=', + ], + ], + [ + 'name' => 'TargetFile', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the job file.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lammps.pbs', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether to use an asynchronous link to submit job files.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'IncorrectCredential', + 'errorMessage' => 'The username or password is incorrect.', + ], + [ + 'errorCode' => 'AgentError.Account.ValidateCredentialFailure', + 'errorMessage' => 'Username or password verification failed.', + ], + [ + 'errorCode' => 'UsernameExist', + 'errorMessage' => 'The username already exists.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateJobFileResponse>\\n\\t<RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n</CreateJobFileResponse>","errorExample":""}]', + 'title' => 'CreateJobFile', + 'summary' => 'Creates a job file.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListJobs' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the user that runs the job.'."\n" + ."\n" + .'You can call the [ListUsers](~~188572~~) operation to query the users in the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'* all'."\n" + .'* finished'."\n" + .'* notfinish'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'finished', + ], + ], + [ + 'name' => 'Rerunable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the job can be rerun. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n" + ."\n" + .'Pages start from 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return per page. Maximum value: 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => 'The page number returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Jobs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'JobInfo' => [ + 'description' => 'The list of jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => 'The name of the user that ran the job.'."\n", + 'type' => 'string', + 'example' => 'user1', + ], + 'Comment' => [ + 'description' => 'The description of the job.'."\n", + 'type' => 'string', + 'example' => 'jobDescription', + ], + 'State' => [ + 'description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'* FINISHED: The job is completed'."\n" + .'* RUNNING: The job connector is running.'."\n" + .'* QUEUED: The job is pending in a queue.'."\n", + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'Stderr' => [ + 'description' => 'The output file path of stderr.'."\n", + 'type' => 'string', + 'example' => './Temp', + ], + 'Priority' => [ + 'description' => 'The priority of the job. Valid values: 0 to 9. A large value indicates a higher priority.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'ShellPath' => [ + 'description' => 'The path that was used to run the job.'."\n", + 'type' => 'string', + 'example' => './Temp', + ], + 'Stdout' => [ + 'description' => 'The output file path of stdout.'."\n", + 'type' => 'string', + 'example' => './Temp', + ], + 'ArrayRequest' => [ + 'description' => 'The job array. If the job is not in a queue, the output is empty.'."\n" + ."\n" + .'Format: X-Y:Z. X is the minimum index value. Y is the maximum index value. Z is the step size. For example, 2-7:2 indicates that three jobs need to be run and their index values are 2, 4, and 6.'."\n", + 'type' => 'string', + 'example' => '1-10:2', + ], + 'StartTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '2018-07-18T17:46:48', + ], + 'LastModifyTime' => [ + 'description' => 'The time when the job was last modified.'."\n", + 'type' => 'string', + 'example' => '2018-07-18T17:46:48', + ], + 'NodeList' => [ + 'description' => 'The list of compute nodes that were used to run the job.'."\n", + 'type' => 'string', + 'example' => '[\'compute2\', \'compute3\']', + ], + 'Name' => [ + 'description' => 'The name of the job.'."\n", + 'type' => 'string', + 'example' => 'job1', + ], + 'Id' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'example' => '0.manager', + ], + 'SubmitTime' => [ + 'description' => 'The time when the job was submitted.'."\n", + 'type' => 'string', + 'example' => '2018-07-18T17:46:47', + ], + 'Resources' => [ + 'description' => 'The resources that were used to run the job.'."\n", + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'The number of nodes that were used to run the job.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cores' => [ + 'description' => 'The number of CPUs that were used to run the job.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AgentError.Job.ListFailure', + 'errorMessage' => 'Failed to list jobs: %s.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Jobs\\": {\\n \\"JobInfo\\": [\\n {\\n \\"Owner\\": \\"user1\\",\\n \\"Comment\\": \\"jobDescription\\",\\n \\"State\\": \\"FINISHED\\",\\n \\"Stderr\\": \\"./Temp\\",\\n \\"Priority\\": \\"0\\",\\n \\"ShellPath\\": \\"./Temp\\",\\n \\"Stdout\\": \\"./Temp\\",\\n \\"ArrayRequest\\": \\"1-10:2\\",\\n \\"StartTime\\": \\"2018-07-18T17:46:48\\",\\n \\"LastModifyTime\\": \\"2018-07-18T17:46:48\\",\\n \\"NodeList\\": \\"[\'compute2\', \'compute3\']\\",\\n \\"Name\\": \\"job1\\",\\n \\"Id\\": \\"0.manager\\",\\n \\"SubmitTime\\": \\"2018-07-18T17:46:47\\",\\n \\"Resources\\": {\\n \\"Nodes\\": 0,\\n \\"Cores\\": 2\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListJobsResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>10</PageSize>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n <PageNumber>1</PageNumber>\\n <Jobs>\\n <JobInfo>\\n <Comment>jobDescription</Comment>\\n <Owner>user1</Owner>\\n <Priority>0</Priority>\\n <NodeList>[\'compute2\', \'compute3\']</NodeList>\\n <StartTime>2018-07-18T17:46:48</StartTime>\\n <LastModifyTime>2018-07-18T17:46:48</LastModifyTime>\\n <SubmitTime>2018-07-18T17:46:47</SubmitTime>\\n <Name>job1</Name>\\n <Stderr>./Temp</Stderr>\\n <State>FINISHED</State>\\n <ShellPath>./Temp</ShellPath>\\n <Id>0.manager</Id>\\n <ArrayRequest>1-10:2</ArrayRequest>\\n <Stdout>./Temp</Stdout>\\n <Resources>\\n <Cores>2</Cores>\\n <Nodes>0</Nodes>\\n </Resources>\\n </JobInfo>\\n </Jobs>\\n</ListJobsResponse>","errorExample":""}]', + 'title' => 'ListJobs', + 'summary' => 'Queries the list of jobs in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeJob' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to obtain the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job ID.'."\n" + ."\n" + .'You can call the [ListJobs](~~87251~~) operation to obtain the job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1.scheduler****', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use an asynchronous link to stop the job.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9697AD8D-56FA-4C8E-B46C-00AC9***', + ], + 'Message' => [ + 'description' => 'The list of returned job information.'."\n", + 'type' => 'object', + 'properties' => [ + 'JobInfo' => [ + 'description' => 'The details of the job.'."\n", + 'type' => 'string', + 'example' => '{"2.scheduler": {"egroup": "users","Stageout_status": 1,"Keep_Files": "n","server": "scheduler","queue": "workq"}}', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9697AD8D-56FA-4C8E-B46C-00AC9***\\",\\n \\"Message\\": {\\n \\"JobInfo\\": \\"{\\\\\\"2.scheduler\\\\\\": {\\\\\\"egroup\\\\\\": \\\\\\"users\\\\\\",\\\\\\"Stageout_status\\\\\\": 1,\\\\\\"Keep_Files\\\\\\": \\\\\\"n\\\\\\",\\\\\\"server\\\\\\": \\\\\\"scheduler\\\\\\",\\\\\\"queue\\\\\\": \\\\\\"workq\\\\\\"}}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeJobResponse>\\n <RequestId>9697AD8D-56FA-4C8E-B46C-00AC9***</RequestId>\\n <Message>\\n <JobInfo>{\\"2.scheduler\\": {\\"egroup\\": \\"users\\",\\"Stageout_status\\": 1,\\"Keep_Files\\": \\"n\\",\\"server\\": \\"scheduler\\",\\"queue\\": \\"workq\\"}}</JobInfo>\\n </Message>\\n</DescribeJobResponse>","errorExample":""}]', + 'title' => 'DescribeJob', + 'summary' => 'Queries the information about a job in an E-HPC cluster.', + ], + 'ListJobsWithFilters' => [ + 'summary' => 'Queries the details of a specified job.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number to return.'."\n" + ."\n" + .'Pages start from 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Maximum value: 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Users', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The users that run the job.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the user that runs the job. Fuzzy match is supported. You can call the [ListUsers](~~188572~~) operation to query the users in the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'Queues', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The information about the queues in which the job is run.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the queue in which the job is run. Fuzzy search is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The information about the computing nodes that are used to run the job.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the compute node. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'node1', + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'JobName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the job. Fuzzy search is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'job1', + ], + ], + [ + 'name' => 'JobStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'* all'."\n" + .'* finished'."\n" + .'* notfinish'."\n" + ."\n" + .'Default value: all.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'finished', + ], + ], + [ + 'name' => 'ExecuteOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which jobs are sorted based on the execution time. Valid values:'."\n" + ."\n" + .'* asc: ascending order'."\n" + .'* desc: descending order'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + [ + 'name' => 'SubmitOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which jobs are sorted based on the time when they are submitted. Valid values:'."\n" + ."\n" + .'* asc: ascending order'."\n" + .'* desc: descending order'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + [ + 'name' => 'PendOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order in which jobs are sorted based on the time when they queue. Valid values:'."\n" + ."\n" + .'* asc: ascending order'."\n" + .'* desc: descending order'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region. You can call the [ListRegions](~~188593~~) operation to query the list of regions where E-HPC is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest time when a job is submitted. The value is a UNIX timestamp, which represents the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1647427667', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest time when a job is submitted. The value is a UNIX timestamp, which represents the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1647428667', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable asynchronous query.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => 'The page number returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Jobs' => [ + 'title' => 'Jobs', + 'description' => 'The list of jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => 'The name of the user that ran the job.'."\n", + 'type' => 'string', + 'example' => 'test2@scheduler', + ], + 'Comment' => [ + 'description' => 'The description of the job.'."\n", + 'type' => 'string', + 'example' => 'jobDescription', + ], + 'State' => [ + 'description' => 'The status of the job. Valid value:'."\n" + ."\n" + .'* FINISHED: The job is completed.'."\n" + .'* RUNNING: The job is running.'."\n" + .'* QUEUED: The job is pending in a queue.'."\n", + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'Stderr' => [ + 'description' => 'The output file path of stderr.'."\n", + 'type' => 'string', + 'example' => './Temp', + ], + 'Priority' => [ + 'description' => 'The priority of the job. Valid values: 0 to 9. A larger value indicates a higher priority.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'ShellPath' => [ + 'description' => 'The path that was used to run the job.'."\n", + 'type' => 'string', + 'example' => './Temp', + ], + 'Stdout' => [ + 'description' => 'The output file path of stdout.'."\n", + 'type' => 'string', + 'example' => './Temp', + ], + 'ArrayRequest' => [ + 'description' => 'The job array. If the job is not in a queue, the output is empty.'."\n" + ."\n" + .'Format: X-Y:Z. X is the minimum index value. Y is the maximum index value. Z is the step size. For example, 2-7:2 indicates that three jobs need to be run and their index values are 2, 4, and 6.'."\n", + 'type' => 'string', + 'example' => '1-10:2', + ], + 'StartTime' => [ + 'description' => 'The time when the job was created.'."\n", + 'type' => 'string', + 'example' => '1647427667', + ], + 'LastModifyTime' => [ + 'description' => 'The time when the job was last modified.'."\n", + 'type' => 'string', + 'example' => '1647428667', + ], + 'NodeList' => [ + 'description' => 'The list of compute nodes that were used to run the job.'."\n", + 'type' => 'string', + 'example' => '[\'compute2\', \'compute3\']', + ], + 'Name' => [ + 'description' => 'The name of the job.'."\n", + 'type' => 'string', + 'example' => 'job1', + ], + 'Id' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'example' => '8.scheduler', + ], + 'SubmitTime' => [ + 'description' => 'The time when the job was submitted.'."\n", + 'type' => 'string', + 'example' => '1647423718', + ], + 'Resources' => [ + 'description' => 'The resources that were used to run the job.'."\n", + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'The number of nodes that were used to run the job.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Cores' => [ + 'description' => 'The number of CPUs that were used to run the job.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + 'Queue' => [ + 'description' => 'The number of queues that ran the job.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Rerunable' => [ + 'description' => 'Indicates whether the job can be run again. Valid values:'."\n" + ."\n" + .'* true: yes'."\n" + .'* false: no'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'VariableList' => [ + 'description' => 'The list of variables of the job.'."\n", + 'type' => 'string', + 'example' => '{"PBS_O_SHELL":"/bin/bash", "PBS_O_HOST":"manager", "PBS_O_SYSTEM":"Linux", "PBS_O_LANG":"en_US.UTF-8", "PBS_O_QUEUE":"workq"}', + ], + ], + ], + ], + 'Success' => [ + 'title' => 'Success', + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => '%s', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed. ', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred. ', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable ', + 'errorMessage' => 'The request has failed due to a temporary failure of the server ', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Jobs\\": [\\n {\\n \\"Owner\\": \\"test2@scheduler\\",\\n \\"Comment\\": \\"jobDescription\\",\\n \\"State\\": \\"FINISHED\\",\\n \\"Stderr\\": \\"./Temp\\",\\n \\"Priority\\": \\"0\\",\\n \\"ShellPath\\": \\"./Temp\\",\\n \\"Stdout\\": \\"./Temp\\",\\n \\"ArrayRequest\\": \\"1-10:2\\",\\n \\"StartTime\\": \\"1647427667\\",\\n \\"LastModifyTime\\": \\"1647428667\\",\\n \\"NodeList\\": \\"[\'compute2\', \'compute3\']\\",\\n \\"Name\\": \\"job1\\",\\n \\"Id\\": \\"8.scheduler\\",\\n \\"SubmitTime\\": \\"1647423718\\",\\n \\"Resources\\": {\\n \\"Nodes\\": 0,\\n \\"Cores\\": 2\\n },\\n \\"Queue\\": \\"2\\",\\n \\"Rerunable\\": true,\\n \\"VariableList\\": \\"{\\\\\\"PBS_O_SHELL\\\\\\":\\\\\\"/bin/bash\\\\\\", \\\\t\\\\\\"PBS_O_HOST\\\\\\":\\\\\\"manager\\\\\\", \\\\t\\\\\\"PBS_O_SYSTEM\\\\\\":\\\\\\"Linux\\\\\\", \\\\t\\\\\\"PBS_O_LANG\\\\\\":\\\\\\"en_US.UTF-8\\\\\\", \\\\t\\\\\\"PBS_O_QUEUE\\\\\\":\\\\\\"workq\\\\\\"}\\"\\n }\\n ],\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListJobsWithFiltersResponse>\\n <TotalCount>1</TotalCount>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <Jobs>\\n <Owner>test2@scheduler</Owner>\\n <Comment>jobDescription</Comment>\\n <State>FINISHED</State>\\n <Stderr>./Temp</Stderr>\\n <Priority>0</Priority>\\n <ShellPath>./Temp</ShellPath>\\n <Stdout>./Temp</Stdout>\\n <ArrayRequest>1-10:2</ArrayRequest>\\n <StartTime>1647427667</StartTime>\\n <LastModifyTime>1647428667</LastModifyTime>\\n <NodeList>[\'compute2\', \'compute3\']</NodeList>\\n <Name>job1</Name>\\n <Id>8.scheduler</Id>\\n <SubmitTime>1647423718</SubmitTime>\\n <Resources>\\n <Nodes>0</Nodes>\\n <Cores>2</Cores>\\n </Resources>\\n <Queue>2</Queue>\\n </Jobs>\\n <Success>true</Success>\\n</ListJobsWithFiltersResponse>","errorExample":""}]', + 'title' => 'ListJobsWithFilters', + ], + 'RerunJobs' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-sh-3VeFyR****', + ], + ], + [ + 'name' => 'Jobs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of jobs that you want to run. Maximum number of jobs: 100. Minimum number of jobs: 1.'."\n" + ."\n" + .'Format: `[{"Id": "0.sched****"},{"Id": "1.sched****"}]`. Separate multiple jobs with commas (,).'."\n" + ."\n" + .'You can call the [ListJobs](~~87251~~) operation to query the job ID.'."\n" + ."\n" + .'> You can rerun only jobs that are in the RUNNING or QUEUED state.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Id":"1.scheduler"}]', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use an asynchronous link to rerun the job.'."\n" + ."\n" + .'Default value: false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'UsernameExist', + 'errorMessage' => 'The username already exists.', + ], + [ + 'errorCode' => 'IncorrectCredential', + 'errorMessage' => 'The username or password is incorrect.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError.Job.RerunFailure', + 'errorMessage' => 'Failed to run the job again: %s.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteJobsResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n</DeleteJobsResponse>","errorExample":""}]', + 'title' => 'RerunJobs', + 'summary' => 'Reruns one or more jobs.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopJobs' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Jobs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of jobs that you want to stop. Maximum number of jobs: 100. Minimum number of jobs: 1.'."\n" + ."\n" + .'Format: `[{"Id": "0.sched****"},{"Id": "1.sched****"}]`. Separate multiple jobs with commas (,).'."\n" + ."\n" + .'You can call the [ListJobs](~~87251~~) operation to query the job ID.'."\n" + ."\n" + .'> You can stop only jobs that are in the RUNNING or QUEUED state.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Id":"1.sched****"},{"Id":"0.sched****"}]', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use an asynchronous link to stop the job.'."\n" + ."\n" + .'Default value: false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'UsernameExist', + 'errorMessage' => 'The username already exists.', + ], + [ + 'errorCode' => 'IncorrectCredential', + 'errorMessage' => 'The username or password is incorrect.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError.Job.StopFailure', + 'errorMessage' => 'Failed to stop jobs: %s.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopJobsResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n</StopJobsResponse>","errorExample":""}]', + 'title' => 'StopJobs', + 'summary' => 'Stops one or more jobs in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetJobLog' => [ + 'summary' => 'Queries the output logs of a job.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the job.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1.scheduler****', + ], + ], + [ + 'name' => 'ExecHost', + 'in' => 'query', + 'schema' => [ + 'description' => 'The node on which the job runs.'."\n" + ."\n" + .'* If the job is completed, you do not need to specify the parameter.'."\n" + .'* If the job is running, you must specify the parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'compute000', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum size of logs that you can read in a single request.'."\n" + ."\n" + .'Unit: bits'."\n" + ."\n" + .'Default value: 1024'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1024', + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'description' => 'The position where logs start to be read.'."\n" + ."\n" + .'Unit: bits'."\n" + ."\n" + .'Default value: 0'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the task.'."\n", + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'JobId' => [ + 'description' => 'The ID of the job.'."\n", + 'type' => 'string', + 'example' => '1.scheduler****', + ], + 'OutputLog' => [ + 'description' => 'The content of the output logs. The content is encoded in Base64.'."\n", + 'type' => 'string', + 'example' => 'c2xlZXAgMzA=', + ], + 'ErrorLog' => [ + 'description' => 'The content of the error logs. The content is encoded in Base64.'."\n", + 'type' => 'string', + 'example' => 'c2xlZXAgMzA=', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ComputeNotFound', + 'errorMessage' => 'The specified compute node does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B745C159-3155-4B94-95D0-4B73D4D2****\\",\\n \\"JobId\\": \\"1.scheduler****\\",\\n \\"OutputLog\\": \\"c2xlZXAgMzA=\\",\\n \\"ErrorLog\\": \\"c2xlZXAgMzA=\\"\\n}","errorExample":""},{"type":"xml","example":"<GetJobLogResponse>\\n <RequestId>B745C159-3155-4B94-95D0-4B73D4D2****</RequestId>\\n <JobId>1.scheduler****</JobId>\\n <OutputLog>c2xlZXAgMzA=</OutputLog>\\n <ErrorLog>c2xlZXAgMzA=</ErrorLog>\\n</GetJobLogResponse>","errorExample":""}]', + 'title' => 'GetJobLog', + ], + 'DeleteJobs' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '75798', + 'abilityTreeNodes' => [ + 'FEATUREehpcH08VYA', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Jobs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list of jobs that you want to delete. Maximum number of jobs: 100. Minimum number of jobs: 1.'."\n" + ."\n" + .'Format: `[{"Id": "0.sched****"},{"Id": "1.sched****"}]`. Separate multiple jobs with commas (,).'."\n" + ."\n" + .'You can call the [ListJobs](~~87251~~) operation to query the job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Id": "0.sched****"},{"Id": "1.sched****"}]', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use an asynchronous link to delete the jobs.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'UsernameExist', + 'errorMessage' => 'The username already exists.', + ], + [ + 'errorCode' => 'IncorrectCredential', + 'errorMessage' => 'The username or password is incorrect.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError.Job.DeleteFailure', + 'errorMessage' => 'Failed to delete job: %s', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteJobsResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n</DeleteJobsResponse>","errorExample":""}]', + 'title' => 'DeleteJobs', + 'summary' => 'Deletes jobs from a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitServerlessJob' => [ + 'summary' => 'Submits a serverless job to an Elastic High Performance Computing (E-HPC) cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the serverless job.'."\n" + ."\n" + .'> The name can contain lowercase letters, digits, and hyphens (-). It cannot start or end with a hyphen.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testjob', + ], + ], + [ + 'name' => 'ArrayProperties', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The configuration of the array job.'."\n" + ."\n" + .'> The value of an array job index is passed to a serverless job container through the environment variable `EHPC_ARRAY_TASK_ID`. Users can access the container from business programs.'."\n", + 'type' => 'object', + 'properties' => [ + 'IndexStart' => [ + 'description' => 'The starting value of the array job index. Valid values: 0 to 4999.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'IndexEnd' => [ + 'description' => 'The end value of the array job index. Valid values: 0 to 4999. The value must be greater than or equal to the value of IndexStart.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'IndexStep' => [ + 'description' => 'The interval of the array job index.'."\n" + ."\n" + .'> If the array job property is IndexStart=1,IndexEnd=5, and IndexStep=2, the array job contains three subtasks. The values of the subtask indexes are 1,3, and 5.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'JobPriority', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scheduling priority of the serverless job. Valid values: 0 to 999. A greater value indicates a higher priority.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'EphemeralStorage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The size of the temporary storage space added to the serverless job container. Unit: GiB.'."\n" + ."\n" + .'> By default, a space of 30 GiB is provided free of charge. If you require a larger space, you can pass this parameter to specify your required space size.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'The validity period of the serverless job. After the validity period expires, the job is forcibly terminated. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of the vSwitches to which the serverless job container belongs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch ID.'."\n" + ."\n" + .'> E-HPC supports only virtual private cloud (VPC) networks. You can call the [DescribeVSwitches](~~35748~~) operation to query the created vSwitches.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1gb5gf5546rn****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The Elastic Compute Service (ECS) instance types used by the serverless job container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ECS instance type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g7.8xlarge', + ], + 'required' => false, + 'docRequired' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'Cpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vCPU size of the serverless job container. Unit: cores.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + 'default' => '1.0', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The memory size of the serverless job container. Unit: GiB.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'docRequired' => false, + 'example' => '4', + 'default' => '2.0', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The bidding policy of the ECS instances. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is created as a preemptible instance for which you specify the maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bid price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'SpotWithPriceLimit', + ], + ], + [ + 'name' => 'SpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum hourly price of the preemptible elastic container instance. The value can be accurate to three decimal places.'."\n" + ."\n" + .'If you set SpotStrategy to SpotWithPriceLimit, you must specify the SpotPriceLimit parameter.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.062', + ], + ], + [ + 'name' => 'RamRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Resource Access Manamement (RAM) role that is associated with the Serverless job container.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testRamRoleName', + ], + ], + [ + 'name' => 'Container', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The properties of the Serverless job container.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnvironmentVar' => [ + 'description' => 'The value of the environment variable for the container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the environment variable for the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the environment variable for the container. The name can be 1 to 128 characters in length and can contain letters, digits, and underscores (\\_). The name cannot start with a digit. Specify the name in the \\[0-9a-zA-Z] format.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PATH', + ], + 'Value' => [ + 'description' => 'The value of the environment variable for the container. The value must be 0 to 256 bits in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/bin', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + 'WorkingDir' => [ + 'description' => 'The working directory of the container.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/'."\n", + ], + 'Image' => [ + 'description' => 'The container image.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/ehpc/hpl:latest'."\n", + ], + 'Command' => [ + 'description' => 'The container startup commands.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The container startup command.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'python3', + ], + 'required' => false, + 'maxItems' => 20, + ], + 'Arg' => [ + 'description' => 'The arguments of the container startup command. You can specify up to 10 arguments.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The startup argument.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hello.py', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'Gpu' => [ + 'description' => 'The number of GPUs used by the container.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'VolumeMount' => [ + 'description' => 'The data volumes that are mounted to the container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data volumes mounted to the container.', + 'type' => 'object', + 'properties' => [ + 'MountPath' => [ + 'description' => 'The directory to which the volume is mounted.'."\n" + ."\n" + .'> The data stored in this directory is overwritten by the data on the volume. Exercise caution when you specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/data', + ], + 'FlexVolumeDriver' => [ + 'description' => 'The driver type when you use the FlexVolume plug-in to mount a volume. Valid values:'."\n" + ."\n" + .'* alicloud/nas: a NAS driver.'."\n" + .'* alicloud/oss: an OSS driver.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'alicloud/oss', + ], + 'FlexVolumeOptions' => [ + 'description' => 'The options of the FlexVolume object. Each option is a key-value pair in a JSON string.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"bucket":"hpctest","url": "oss-cn-hangzhou-internal.aliyuncs.com'."\n" + .'","path":"/data","ramRole":"AliyunECSInstanceForEHPCRole"}', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'DependsOn', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The dependencies of the serverless job.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The serverless job dependencies.', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => 'The ID of the dependent job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'Type' => [ + 'description' => 'The dependency type. Valid values:'."\n" + ."\n" + .'* AfterSucceeded: **All subtasks** of the dependent job or array job succeed. The exit code is 0.'."\n" + .'* AfterFailed: **All subtasks** of the dependent job or array job fail. The exit code is not 0.'."\n" + .'* AfterAny: The dependent job completes (succeeds or fails).'."\n" + .'* AfterCorresponding: The subtask corresponding to the dependent array job succeeds. The exit code is 0.'."\n" + ."\n" + .'Default value: AfterSucceeded.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AfterAny', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + [ + 'name' => 'RetryStrategy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The retry policy of the serverless job.'."\n", + 'type' => 'object', + 'properties' => [ + 'Attempts' => [ + 'description' => 'The number of retries for the serverless job. Valid values: 1 to 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '5', + ], + 'EvaluateOnExit' => [ + 'description' => 'The retry rules for the serverless job. You can specify up to 10 rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => 'The job action. Valid values:'."\n" + ."\n" + .'* Retry: The job starts a retry when a specific exit code is hit.'."\n" + .'* Exit: The job exits when a specific exit code is hit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Retry', + ], + 'OnExitCode' => [ + 'description' => 'The job exit code, which is used together with Action to form a job retry rule. Valid values: 0 to 255.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => 'The ID of the serverless job.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + [ + 'errorCode' => 'ServiceAPIError', + 'errorMessage' => 'Failed to call the operation. Cause:%s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": \\"10\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => 'SubmitServerlessJob', + ], + 'ListServerlessJobs' => [ + 'summary' => 'Queries the list of serverless jobs based on filter conditions.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [ListRegions](~~188593~~) operation to query the list of regions where E-HPC is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Maximum value: 100. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'JobIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The list of serverless job IDs or subtask IDs (array jobs).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the serverless job or subtask (array job).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5,10_1', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'JobNames', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The names of the serverless jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the serverless job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testjob', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the serverless job. Valid values:'."\n" + ."\n" + .'* All'."\n" + .'* Pending'."\n" + .'* Running'."\n" + .'* Succeeded'."\n" + .'* Canceled'."\n" + .'* Failed'."\n" + ."\n" + .'Default value: All.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + 'enum' => [ + 'Pending', + 'Running', + 'Canceled', + 'Failed', + 'All', + 'Succeeded', + ], + ], + ], + [ + 'name' => 'StartOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to sort the serverless jobs by the job start time. Valid values:'."\n" + ."\n" + .'* Asc: ascending order.'."\n" + .'* Desc: descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + 'enum' => [ + 'Desc', + 'Asc', + ], + ], + ], + [ + 'name' => 'SubmitOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to sort the serverless jobs by the job submission time. Valid values:'."\n" + ."\n" + .'* Asc: ascending order.'."\n" + .'* Desc: descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + 'enum' => [ + 'Desc', + 'Asc', + ], + ], + ], + [ + 'name' => 'SubmitTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => 'The earliest time at which the job is submitted.'."\n" + ."\n" + .'> You can use this parameter to query the job list based on the job submission time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1647427667', + ], + ], + [ + 'name' => 'SubmitTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The latest time at which the job is submitted.'."\n" + ."\n" + .'> You can use this parameter to query the job list based on the job submission time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1659521430', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => 'The page number returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Jobs' => [ + 'title' => 'Jobs', + 'description' => 'The list of serverless jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => 'The ID of the serverless job or the subtask (array job).'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'JobName' => [ + 'description' => 'The name of the serverless job.'."\n", + 'type' => 'string', + 'example' => 'testjob', + ], + 'State' => [ + 'description' => 'The status of the serverless job. Valid values:'."\n" + ."\n" + .'* Pending'."\n" + .'* Initing'."\n" + .'* Running'."\n" + .'* Succeeded'."\n" + .'* Canceled'."\n" + .'* Failed'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'Priority' => [ + 'description' => 'The scheduling priority of the serverless job. Valid values are 0 to 999. A greater value indicates a higher priority.'."\n", + 'type' => 'string', + 'example' => '9', + ], + 'Queue' => [ + 'description' => 'The name of the queue in which the serverless job is run.'."\n", + 'type' => 'string', + 'example' => 'comp', + ], + 'User' => [ + 'description' => 'The username that is used to run the serverless job.'."\n", + 'type' => 'string', + 'example' => 'testuser', + ], + 'SubmitTime' => [ + 'description' => 'The time at which the serverless job is submitted.'."\n", + 'type' => 'string', + 'example' => '1647423718', + ], + 'StartTime' => [ + 'description' => 'The time at which the serverless job started.'."\n", + 'type' => 'string', + 'example' => '1647427667', + ], + 'EndTime' => [ + 'description' => 'The time at which the serverless job ended.'."\n", + 'type' => 'string', + 'example' => '1682128871', + ], + 'IsArrayJob' => [ + 'description' => 'Indicates whether the job is an array job. Valid values:'."\n" + ."\n" + .'* True: yes'."\n" + .'* False: no'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + 'description' => 'The list of serverless jobs.', + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Jobs\\": [\\n {\\n \\"JobId\\": \\"5\\",\\n \\"JobName\\": \\"testjob\\",\\n \\"State\\": \\"Running\\",\\n \\"Priority\\": \\"9\\",\\n \\"Queue\\": \\"comp\\",\\n \\"User\\": \\"testuser\\",\\n \\"SubmitTime\\": \\"1647423718\\",\\n \\"StartTime\\": \\"1647427667\\",\\n \\"EndTime\\": \\"1682128871\\",\\n \\"IsArrayJob\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListServerlessJobs', + ], + 'DescribeServerlessJobs' => [ + 'summary' => 'Queries the details of a serverless job by job ID or subtask ID (array job). You can specify only a single job ID or a single subtask ID at a time.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The list of serverless job IDs or the subtask IDs (array jobs).'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If the serverless job is an array job, you can specify only the subtask ID. Specify the subtask ID in the format of \\<array job ID>\\_< subtask index>. For example, 10\\_3 indicates the subtask whose index is 3 in the array job whose ID is 10.'."\n" + ."\n" + .'* You can specify only a single ID in one request.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the serverless job or the subtask (array job).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + 'required' => true, + 'maxItems' => 1, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'JobInfos' => [ + 'description' => 'The list of detailed information about the serverless job.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => 'The ID of the serverless job or the subtask (array job).'."\n", + 'type' => 'string', + 'example' => '5', + ], + 'JobName' => [ + 'description' => 'The name of the serverless job.'."\n", + 'type' => 'string', + 'example' => 'testjob', + ], + 'State' => [ + 'description' => 'The status of the serverless job. Valid values:'."\n" + ."\n" + .'* Pending'."\n" + .'* Initing'."\n" + .'* Running'."\n" + .'* Succeeded'."\n" + .'* Canceled'."\n" + .'* Failed'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'Priority' => [ + 'description' => 'The scheduling priority of the serverless job.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'Queue' => [ + 'description' => 'The name of the queue in which the serverless job is run.'."\n", + 'type' => 'string', + 'example' => 'comp', + ], + 'User' => [ + 'description' => 'The username that is used to run the serverless job.'."\n", + 'type' => 'string', + 'example' => 'testuser', + ], + 'SubmitTime' => [ + 'description' => 'The time when the serverless job is submitted.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1647423718', + ], + 'StartTime' => [ + 'description' => 'The time when the serverless job started.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1647427667', + ], + 'EndTime' => [ + 'description' => 'The time when the serverless job ended.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1662016121', + ], + 'LastModifyTime' => [ + 'description' => 'The time when the serverless job is last modified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663831441000', + ], + 'IsArrayJob' => [ + 'description' => 'Indicates whether the job is an array job.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ArrayProperties' => [ + 'description' => 'The properties of the array job.'."\n", + 'type' => 'object', + 'properties' => [ + 'IndexStart' => [ + 'description' => 'The starting value of the array job index.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'IndexEnd' => [ + 'description' => 'The end value of the array job index.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'IndexStep' => [ + 'description' => 'The interval of the array job index.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + 'ContainerGroups' => [ + 'description' => 'The information of the container groups that are used to run the serverless job.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContainerGroupId' => [ + 'description' => 'The ID of the container group.'."\n", + 'type' => 'string', + 'example' => 'eci-bp1jrgfqqy54kg5hc****', + ], + 'ContainerGroupName' => [ + 'description' => 'The name of the container group.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Status' => [ + 'description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'* Pending: The instance is being started.'."\n" + .'* Running: The instance is running.'."\n" + .'* Succeeded: The instance runs successfully.'."\n" + .'* Failed: The instance fails to run.'."\n" + .'* Scheduling: The instance is being created.'."\n" + .'* ScheduleFailed: The instance fails to be created.'."\n" + .'* Restarting: The instance is being restarted.'."\n" + .'* Updating: The instance is being updated.'."\n" + .'* Terminating: The instance is being terminated.'."\n" + .'* Expired: The instance expires.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the Elastic Compute Service (ECS) instance.'."\n", + 'type' => 'string', + 'example' => 'ecs.g5.large', + ], + 'SpotStrategy' => [ + 'description' => 'The bidding policy of the instance. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is a regular pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is a preemptible instance that has a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'SpotPriceLimit' => [ + 'description' => 'The maximum hourly price for the preemptible instance.'."\n" + ."\n" + .'This parameter is returned only if you set the SpotStrategy parameter to SpotWithPriceLimit.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.025', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs that are allocated to the container.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'Memory' => [ + 'description' => 'The memory size of the elastic container instance. Unit: GiB.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '4.0', + ], + 'Containers' => [ + 'description' => 'The list of containers in the container group.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => 'The startup parameter of the container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The startup parameter of the container.'."\n", + 'type' => 'string', + 'example' => 'hello.py', + ], + ], + 'Commands' => [ + 'description' => 'The startup command of the container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The startup command of the container.'."\n", + 'type' => 'string', + 'example' => '/usr/bin/python', + ], + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '2.0', + ], + 'CurrentState' => [ + 'description' => 'The current status of the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'DetailStatus' => [ + 'description' => 'The details of the container status.'."\n", + 'type' => 'string', + 'example' => 'working', + ], + 'ExitCode' => [ + 'description' => 'The exit code of the container.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FinishTime' => [ + 'description' => 'The time when the container stopped running.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z'."\n", + ], + 'Message' => [ + 'description' => 'The information about the container status.'."\n", + 'type' => 'string', + 'example' => 'Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)'."\n", + ], + 'Reason' => [ + 'description' => 'The reason why the container is in this state.'."\n", + 'type' => 'string', + 'example' => 'Started'."\n", + ], + 'Signal' => [ + 'description' => 'The code of the container status.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => 'The time when the container started to run.'."\n", + 'type' => 'string', + 'example' => '2019-12-19T12:05:02Z'."\n", + ], + 'State' => [ + 'description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'* Waiting'."\n" + .'* Running'."\n" + .'* Terminated'."\n", + 'type' => 'string', + 'example' => 'Terminated'."\n", + ], + ], + ], + 'EnvironmentVars' => [ + 'description' => 'The environment variables.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the environment variable.'."\n", + 'type' => 'string', + 'example' => 'PATH'."\n", + ], + 'Value' => [ + 'description' => 'The value of the environment variable.'."\n", + 'type' => 'string', + 'example' => '/usr/bin/'."\n", + ], + 'ValueFrom' => [ + 'description' => 'The source of the environment variable value. This parameter can be used only when the variable value is not specified.'."\n", + 'type' => 'object', + 'properties' => [ + 'FieldRef' => [ + 'description' => 'The specified field.'."\n", + 'type' => 'object', + 'properties' => [ + 'FieldPath' => [ + 'description' => 'The path of the field.'."\n", + 'type' => 'string', + 'example' => 'status.podIP', + ], + ], + ], + ], + ], + ], + ], + ], + 'Gpu' => [ + 'description' => 'The number of GPUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Image' => [ + 'description' => 'The image of the container.'."\n", + 'type' => 'string', + 'example' => 'HPL', + ], + 'ImagePullPolicy' => [ + 'description' => 'The policy to pull images. Valid values:'."\n" + ."\n" + .'* Always: Each time instances are created, image pulling is performed.'."\n" + .'* IfNotPresent: On-premises images are preferentially used. If no on-premises images are available, image pulling is performed.'."\n" + .'* Never: On-premises images are always used. Image pulling is not performed.'."\n", + 'type' => 'string', + 'example' => 'Always', + ], + 'LivenessProbe' => [ + 'description' => 'The liveness probe of the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'Execs' => [ + 'description' => 'The commands that are run.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The commands that are run.'."\n", + 'type' => 'string', + 'example' => '["/bin/sh", "-c", "echo Hello world > /usr/share/message"]'."\n", + ], + ], + 'FailureThreshold' => [ + 'description' => 'The minimum number of consecutive failures that must occur for the probe to be considered as failed. Default value: 3.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'HttpGet' => [ + 'description' => 'The HTTP GET method that is used to check the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'The path to which HTTP GET requests are sent.'."\n", + 'type' => 'string', + 'example' => '/usr/nginx/'."\n", + ], + 'Port' => [ + 'description' => 'The port to which HTTP GET requests are sent.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80', + ], + 'Scheme' => [ + 'description' => 'The protocol type of the HTTP GET requests.'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + ], + ], + 'InitialDelaySeconds' => [ + 'description' => 'The number of seconds after the container is started and before a liveness probe is initiated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PeriodSeconds' => [ + 'description' => 'The interval at which the probe is run. Unit: seconds. Default value: 10. Minimum value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'SuccessThreshold' => [ + 'description' => 'The minimum number of consecutive successes that must occur for the check to be considered successful. Default value: 1. Set the value to 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TcpSocket' => [ + 'description' => 'The TCP socket method that is used to check the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'Host' => [ + 'description' => 'The name of the host.'."\n", + 'type' => 'string', + 'example' => '1.2.3.4'."\n", + ], + 'Port' => [ + 'description' => 'The port number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80', + ], + ], + ], + 'TimeoutSeconds' => [ + 'description' => 'The timeout period of the check. Default value: 1. Minimum value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + 'Memory' => [ + 'description' => 'The memory size of the instance. Unit: GiB.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '4.0', + ], + 'Name' => [ + 'description' => 'The container name.'."\n", + 'type' => 'string', + 'example' => 'HPL', + ], + 'Ports' => [ + 'description' => 'The exposed ports and protocols of the container.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'description' => 'The port number. Valid values: 1 to 65535.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8080', + ], + 'Protocol' => [ + 'description' => 'The protocol.'."\n", + 'type' => 'string', + 'example' => 'TCP', + ], + ], + 'description' => 'The exposed ports and protocols of the container.', + ], + ], + 'PreviousState' => [ + 'description' => 'The previous status of the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'DetailStatus' => [ + 'description' => 'The details of the container status.'."\n", + 'type' => 'string', + 'example' => 'working', + ], + 'ExitCode' => [ + 'description' => 'The exit code of the container.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FinishTime' => [ + 'description' => 'The time when the container stopped running.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'Message' => [ + 'description' => 'The message about the container status.'."\n", + 'type' => 'string', + 'example' => 'Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)', + ], + 'Reason' => [ + 'description' => 'The reason why the container is in this state.'."\n", + 'type' => 'string', + 'example' => 'Completed', + ], + 'Signal' => [ + 'description' => 'The code of the container status.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => 'The time when the container started to run.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'State' => [ + 'description' => 'The status of the container. Valid values:'."\n" + ."\n" + .'* Waiting: The container is being started.'."\n" + .'* Running: The container is running.'."\n" + .'* Terminated: The container terminates running.'."\n", + 'type' => 'string', + 'example' => 'Terminated', + ], + ], + ], + 'ReadinessProbe' => [ + 'description' => 'The readiness probe that is used to check whether the container is ready to serve a request.'."\n", + 'type' => 'object', + 'properties' => [ + 'Execs' => [ + 'description' => 'The commands that are run in the container when you use the command line interface (CLI) to perform health checks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The commands that are run in the container when you use CLI to perform health checks.'."\n", + 'type' => 'string', + 'example' => '['."\n" + .' "/bin/sh",'."\n" + .' "-c",'."\n" + .' "echo Hello world > /usr/share/message"'."\n" + .']', + ], + ], + 'FailureThreshold' => [ + 'description' => 'The minimum number of consecutive failures that must occur for the check to be considered as failed. Default value: 3.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'HttpGet' => [ + 'description' => 'The HTTP GET method that is used to check the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'The path to which HTTP GET requests are sent.'."\n", + 'type' => 'string', + 'example' => '/usr/local', + ], + 'Port' => [ + 'description' => 'The port to which the system sends an HTTP GET request for a health check.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8080', + ], + 'Scheme' => [ + 'description' => 'The protocol type of the HTTP GET requests.'."\n", + 'type' => 'string', + 'example' => 'HTTP', + ], + ], + ], + 'InitialDelaySeconds' => [ + 'description' => 'The number of seconds after the container is started and before a liveness probe is initiated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PeriodSeconds' => [ + 'description' => 'The interval at which the container is checked. Unit: seconds. Default value: 10. Minimum value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'SuccessThreshold' => [ + 'description' => 'The minimum number of consecutive successes for a failed liveness probe to be considered successful. Default value: 1. Set the value to 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TcpSocket' => [ + 'description' => 'The TCP socket method that is used to check the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'Host' => [ + 'description' => 'The IP address of the host.'."\n", + 'type' => 'string', + 'example' => '1.2.3.4', + ], + 'Port' => [ + 'description' => 'The port number.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8888', + ], + ], + ], + 'TimeoutSeconds' => [ + 'description' => 'The timeout period of the check. Default value: 1. Minimum value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'Ready' => [ + 'description' => 'Indicates whether the container passed the readiness probe.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RestartCount' => [ + 'description' => 'The number of times that the instance worker restarted.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SecurityContext' => [ + 'description' => 'The security context of the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'Capability' => [ + 'description' => 'The permissions specific to the processes in the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'Adds' => [ + 'description' => 'The permissions specific to the processes in the container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The permissions specific to the processes in the container.'."\n", + 'type' => 'string', + 'example' => 'NET_ADMIN', + ], + ], + ], + ], + 'ReadOnlyRootFilesystem' => [ + 'description' => 'Indicates whether the root file system is set to the read-only mode. The only valid value is true.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RunAsUser' => [ + 'description' => 'The user ID (UID) that is used to run the entry point of the container process.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1558', + ], + ], + ], + 'Stdin' => [ + 'description' => 'Indicates whether the container allocates buffer resources to standard input streams when the container runs. If you do not specify this parameter, an end-of-file (EOF) error may occur when standard input streams in the container are read. Default value: false.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'StdinOnce' => [ + 'description' => 'Indicates whether the container runtime closes the stdin channel after the stdin channel has been opened by a single attach session. If stdin is true, the stdin stream remains open across multiple attach sessions. If StdinOnce is set to true, stdin is opened on container start, but remains empty until the first client attaches to stdin, and then remains open and receives data until the client disconnects. When the client disconnects, stdin is closed and remains closed until the container is restarted.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tty' => [ + 'description' => 'Indicates whether interaction is enabled. Default value: false. If the value of the Command parameter is /bin/bash, the value of this parameter must be set to true.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'VolumeMounts' => [ + 'description' => 'Information about the mounted volumes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MountPath' => [ + 'description' => 'The directory to which the volume is mounted. Data under this directory is overwritten by the data on the volume.'."\n", + 'type' => 'string', + 'example' => '/usr/share/', + ], + 'MountPropagation' => [ + 'description' => 'The mount propagation settings of the volume. Mount propagation allows you to share volumes that are mounted on a container with other containers in the same pod or other pods on the same node. Valid values:'."\n" + ."\n" + .'* None: The volume mount does not receive subsequent mounts that are mounted to the volume or the subdirectories of the volume.'."\n" + .'* HostToCotainer: The volume mount receives all subsequent mounts that are mounted to the volume or the subdirectories of the volume.'."\n" + .'* Bidirectional: This value is similar to HostToCotainer. The volume mount receives all subsequent mounts that are mounted to the volume or the subdirectories of the volume. All volume mounts that are mounted by the container are propagated back to the instance and all containers of all pods that use the same volume.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Name' => [ + 'description' => 'The name of the volume.'."\n", + 'type' => 'string', + 'example' => 'test-empty', + ], + 'ReadOnly' => [ + 'description' => 'Indicates whether the volumes are read-only.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'SubPath' => [ + 'description' => 'The subdirectory of the volume. This parameter specifies different subdirectories of the same volume that the instance can mount to different subdirectories of containers.'."\n", + 'type' => 'string', + 'example' => '/usr/sub', + ], + ], + ], + ], + 'WorkingDir' => [ + 'description' => 'The working directory.'."\n", + 'type' => 'string', + 'example' => '/usr/local/nginx', + ], + ], + 'description' => 'The list of containers in the container group.', + ], + ], + 'Volumes' => [ + 'description' => 'The information about volumes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about volumes.', + 'type' => 'object', + 'properties' => [ + 'ConfigFileVolumeConfigFileToPaths' => [ + 'description' => 'The paths to configuration files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The paths to configuration files.', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => 'The content of the configuration file. Maximum size: 32 KB.'."\n", + 'type' => 'string', + 'example' => 'hello world', + ], + 'Path' => [ + 'description' => 'The relative path to the configuration file.'."\n", + 'type' => 'string', + 'example' => '/usr/bin/', + ], + ], + ], + ], + 'DiskVolumeDiskId' => [ + 'description' => 'The ID of the disk volume if you set Type to DiskVolume.'."\n", + 'type' => 'string', + 'example' => 'd-xxxx', + ], + 'DiskVolumeFsType' => [ + 'description' => 'The type of the volume.'."\n", + 'type' => 'string', + 'example' => 'xfs', + ], + 'EmptyDirVolumeMedium' => [ + 'description' => 'The storage media for the emptyDir volume. This parameter is empty by default, which indicates that the node file system is used as the storage media. Valid values:'."\n" + ."\n" + .'* Memory: uses memory as the storage media.'."\n" + .'* LocalRaid0: forms local disks into RAID 0. This value is valid only if an elastic container instance that has local disks mounted is created. For more information, see [Create an elastic container instance that has local disks mounted](~~114664~~).'."\n", + 'type' => 'string', + 'example' => 'Memory', + ], + 'EmptyDirVolumeSizeLimit' => [ + 'description' => 'The storage size of the emptyDir volume. If you specify this parameter, include the unit in the value. We recommend that you use Gi or Mi.'."\n", + 'type' => 'string', + 'example' => '256Mi', + ], + 'FlexVolumeDriver' => [ + 'description' => 'The name of the driver when you set the Type parameter to FlexVolume.'."\n", + 'type' => 'string', + 'example' => 'flexvolume', + ], + 'FlexVolumeFsType' => [ + 'description' => 'The file system type when you set the Type parameter to FlexVolume. The default value is determined by the script of the FlexVolume plug-in.'."\n", + 'type' => 'string', + 'example' => 'ntfs', + ], + 'FlexVolumeOptions' => [ + 'description' => 'The FlexVolume options.'."\n", + 'type' => 'string', + 'example' => '[nolock,tcp,noresvport]', + ], + 'NFSVolumePath' => [ + 'description' => 'The path of the Network File System (NFS) volume.'."\n", + 'type' => 'string', + 'example' => '/eci', + ], + 'NFSVolumeReadOnly' => [ + 'description' => 'Indicates whether the NFS volume is read-only.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'NFSVolumeServer' => [ + 'description' => 'The endpoint of the server if you set Type to NFSVolume.'."\n", + 'type' => 'string', + 'example' => '0eafxxxxx-xxxxx.cn-hangzhou.nas.aliyuncs.com', + ], + 'Name' => [ + 'description' => 'The name of the volume.'."\n", + 'type' => 'string', + 'example' => 'test-empty', + ], + 'Type' => [ + 'description' => 'The type of the volume. Valid values:'."\n" + ."\n" + .'* EmptyDirVolume'."\n" + .'* NFSVolume'."\n" + .'* ConfigFileVolume'."\n" + .'* FlexVolume'."\n", + 'type' => 'string', + 'example' => 'EmptyDirVolume', + ], + ], + ], + ], + 'Events' => [ + 'description' => 'The event information. Up to 50 events can be returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The event information. Up to 50 events can be returned.', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => 'The number of the events.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'FirstTimestamp' => [ + 'description' => 'The time when the event started.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'LastTimestamp' => [ + 'description' => 'The time when the event ended.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z'."\n", + ], + 'Message' => [ + 'description' => 'The message about the event.'."\n", + 'type' => 'string', + 'example' => 'Started container', + ], + 'Name' => [ + 'description' => 'The name of the category to which the event belongs.'."\n", + 'type' => 'string', + 'example' => 'test-xxx', + ], + 'Reason' => [ + 'description' => 'The name of the event.'."\n", + 'type' => 'string', + 'example' => 'Created', + ], + 'Type' => [ + 'description' => 'The type of the event. Valid values:'."\n" + ."\n" + .'* Normal'."\n" + .'* Warning'."\n", + 'type' => 'string', + 'example' => 'Normal', + ], + ], + ], + ], + 'CreationTime' => [ + 'description' => 'The time when the instance is created. The time follows the RFC 3339 standard and must be in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'SucceededTime' => [ + 'description' => 'The time when all containers exited on success. The time follows the RFC 3339 standard and must be in UTC.'."\n", + 'type' => 'string', + 'example' => '2019-12-11T04:33:42Z', + ], + 'ExpiredTime' => [ + 'description' => 'The time when the instance failed to run due to overdue payments. The time follows the RFC 3339 standard and must be in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'FailedTime' => [ + 'description' => 'The time when the instance failed to run. The time follows the RFC 3339 standard and must be in UTC.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'Discount' => [ + 'description' => 'The discount.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'DnsConfig' => [ + 'description' => 'The Domain Name System (DNS) settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'NameServers' => [ + 'description' => 'The IP addresses of DNS servers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The IP address of the DNS server.'."\n", + 'type' => 'string', + 'example' => '[10.2.*.*]', + ], + ], + 'Options' => [ + 'description' => 'The options. Each option is a name-value pair. The value in the name-value pair is optional.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The options. Each option is a name-value pair. The value in the name-value pair is optional.', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The variable name of the option.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'Value' => [ + 'description' => 'The variable value of the option.'."\n", + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'Searches' => [ + 'description' => 'The search domains of the DNS server.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The search domain of the DNS server.'."\n", + 'type' => 'string', + 'example' => 'svc.local.kubenetes', + ], + ], + ], + ], + 'EciSecurityContext' => [ + 'description' => 'The security context of the container group.'."\n", + 'type' => 'object', + 'properties' => [ + 'Sysctls' => [ + 'description' => 'The Sysctl parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the Sysctl parameter.'."\n", + 'type' => 'string', + 'example' => 'kernel.msgmax', + ], + 'Value' => [ + 'description' => 'The value of the Sysctl parameter.'."\n", + 'type' => 'string', + 'example' => '65536', + ], + ], + ], + ], + ], + ], + 'EniInstanceId' => [ + 'description' => 'The ID of the elastic network interface (ENI).'."\n", + 'type' => 'string', + 'example' => 'eni-bp14rzqi6fd8satm****', + ], + 'EphemeralStorage' => [ + 'description' => 'The size of the temporary storage space. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'HostAliases' => [ + 'description' => 'The hostname mapping of a container in the elastic container instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hostname mapping of a container in the elastic container instance.', + 'type' => 'object', + 'properties' => [ + 'Hostnames' => [ + 'description' => 'The information about the host.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the host.'."\n", + 'type' => 'string', + 'example' => '[\'hehe.com\', \'haha.com\']', + ], + ], + 'Ip' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + ], + ], + ], + 'InitContainers' => [ + 'description' => 'The init containers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The init containers.', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => 'The startup parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The startup parameter.'."\n", + 'type' => 'string', + 'example' => '[\'hello world\']', + ], + ], + 'Command' => [ + 'description' => 'The startup command.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The startup command.'."\n", + 'type' => 'string', + 'example' => '[/bin/sh echo]', + ], + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1.0', + ], + 'CurrentState' => [ + 'description' => 'The current status of the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'DetailStatus' => [ + 'description' => 'The details of the container status.'."\n", + 'type' => 'string', + 'example' => 'working', + ], + 'ExitCode' => [ + 'description' => 'The exit code of the container.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FinishTime' => [ + 'description' => 'The time when the container stopped running.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'Message' => [ + 'description' => 'The message about the event.'."\n", + 'type' => 'string', + 'example' => 'Created container', + ], + 'Reason' => [ + 'description' => 'The reason why the container is in this state.'."\n", + 'type' => 'string', + 'example' => 'Started', + ], + 'Signal' => [ + 'description' => 'The code of the container status.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => 'The time when the container started to run.'."\n", + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'State' => [ + 'description' => 'The status of the container. Valid values:'."\n" + ."\n" + .'* Waiting'."\n" + .'* Running'."\n" + .'* Terminated'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + 'EnvironmentVars' => [ + 'description' => 'The environment variables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The name of the environment variable.'."\n", + 'type' => 'string', + 'example' => 'PATH', + ], + 'Value' => [ + 'description' => 'The value of the environment variable.'."\n", + 'type' => 'string', + 'example' => '/usr/local/bin', + ], + 'ValueFrom' => [ + 'description' => 'The source of the environment variable value. This parameter can be used only when the variable value is not specified.'."\n", + 'type' => 'object', + 'properties' => [ + 'FieldRef' => [ + 'description' => 'The specified field.'."\n", + 'type' => 'object', + 'properties' => [ + 'FieldPath' => [ + 'description' => 'The path of the field in the specified version. Set the value to `status.podIP`.'."\n", + 'type' => 'string', + 'example' => 'status.podIP', + ], + ], + ], + ], + ], + ], + ], + ], + 'Gpu' => [ + 'description' => 'The number of GPUs.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Image' => [ + 'description' => 'The image.'."\n", + 'type' => 'string', + 'example' => 'nginx', + ], + 'ImagePullPolicy' => [ + 'description' => 'The policy to pull images.'."\n", + 'type' => 'string', + 'example' => 'Always', + ], + 'Memory' => [ + 'description' => 'The size of memory that is allocated to the init container. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2.0', + ], + 'Name' => [ + 'description' => 'The container name.'."\n", + 'type' => 'string', + 'example' => 'Init-xxx', + ], + 'Ports' => [ + 'description' => 'The exposed ports and protocols of the container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The exposed ports and protocols of the container.', + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'description' => 'The port number. Valid values: 1 to 65535.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8888', + ], + 'Protocol' => [ + 'description' => 'The protocol.'."\n", + 'type' => 'string', + 'example' => 'TCP', + ], + ], + ], + ], + 'PreviousState' => [ + 'description' => 'The previous status of the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'DetailStatus' => [ + 'description' => 'The details of the container status.'."\n", + 'type' => 'string', + 'example' => 'working', + ], + 'ExitCode' => [ + 'description' => 'The exit code of the container.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FinishTime' => [ + 'description' => 'The time when the container stopped running.'."\n", + 'type' => 'string', + 'example' => '2019-12-24T05:35:44Z', + ], + 'Message' => [ + 'description' => 'The message about the container status.'."\n", + 'type' => 'string', + 'example' => 'Started container', + ], + 'Reason' => [ + 'description' => 'The reason why the container is in this state.'."\n", + 'type' => 'string', + 'example' => 'completed', + ], + 'Signal' => [ + 'description' => 'The code of the container status.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => 'The time when the container started to run.'."\n", + 'type' => 'string', + 'example' => '2019-12-24T05:35:44Z', + ], + 'State' => [ + 'description' => 'The status of the container. Valid values: Waiting, Running, and Terminated.'."\n", + 'type' => 'string', + 'example' => 'Terminated', + ], + ], + ], + 'Ready' => [ + 'description' => 'Indicates whether the container passed the readiness probe.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RestartCount' => [ + 'description' => 'The number of times that the instance worker restarted.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'SecurityContext' => [ + 'description' => 'The security context of the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'Capability' => [ + 'description' => 'The permissions specific to the processes in the container.'."\n", + 'type' => 'object', + 'properties' => [ + 'Adds' => [ + 'description' => 'The permissions specific to the processes in the container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The permissions specific to the processes in the container.'."\n", + 'type' => 'string', + 'example' => 'NET_ADMIN', + ], + ], + ], + ], + 'ReadOnlyRootFilesystem' => [ + 'description' => 'Indicates whether the root file system is set to the read-only mode. The only valid value is true.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RunAsUser' => [ + 'description' => 'The UID that is used to run the entry point of the container process.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1557', + ], + ], + ], + 'VolumeMounts' => [ + 'description' => 'The information about the volumes that are mounted to the init container.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the volumes that are mounted to the init container.', + 'type' => 'object', + 'properties' => [ + 'MountPath' => [ + 'description' => 'The directory to which the volume is mounted. Data under this directory is overwritten by the data on the volume.'."\n", + 'type' => 'string', + 'example' => '/usr/share/', + ], + 'MountPropagation' => [ + 'description' => 'The mount propagation settings of the volume. Mount propagation allows you to share volumes that are mounted on a container with other containers in the same pod or other pods on the same node. Valid values:'."\n" + ."\n" + .'* None: The volume mount does not receive subsequent mounts that are mounted to the volume or the subdirectories of the volume.'."\n" + .'* HostToCotainer: The volume mount receives all subsequent mounts that are mounted to the volume or the subdirectories of the volume.'."\n" + .'* Bidirectional: This value is similar to HostToCotainer. The volume mount receives all subsequent mounts that are mounted to the volume or the subdirectories of the volume. All volume mounts that are mounted by the container are propagated back to the instance and all containers of all pods that use the same volume.'."\n" + ."\n" + .'Default value: None.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Name' => [ + 'description' => 'The name of the volume. The name is the same as the volume you selected when you purchased the container.'."\n", + 'type' => 'string', + 'example' => 'test-empty', + ], + 'ReadOnly' => [ + 'description' => 'Default value: False.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'WorkingDir' => [ + 'description' => 'The working directory.'."\n", + 'type' => 'string', + 'example' => '/usr/test', + ], + ], + ], + ], + 'InternetIp' => [ + 'description' => 'The public IP address.'."\n", + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'IntranetIp' => [ + 'description' => 'The private IP address.'."\n", + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'Ipv6Address' => [ + 'description' => 'The IPv6 address.'."\n", + 'type' => 'string', + 'example' => '2001:XXXX:4:4:4:4:4:4', + ], + 'RamRoleName' => [ + 'description' => 'The name of the instance RAM role. You can use an instance RAM role to access both elastic container instances and ECS instances. For more information, see [Use the instance RAM role by calling APIs](~~61178~~).'."\n", + 'type' => 'string', + 'example' => 'ram:PassRole', + ], + 'RegionId' => [ + 'description' => 'The ID of the region in which the instance resides.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the cluster belongs. If you do not specify a resource group when you create an elastic container instance, the system automatically adds the instance to the default resource group in your account.'."\n", + 'type' => 'string', + 'example' => 'rg-aekzh43v*****', + ], + 'RestartPolicy' => [ + 'description' => 'The instance restart policy. Valid values:'."\n" + ."\n" + .'* Always: Always restarts the instance if a container in the instance exits upon termination.'."\n" + .'* Never: Never restarts the instance if a container in the instance exits upon termination.'."\n" + .'* OnFailure: Restarts the instance when the last start failed.'."\n", + 'type' => 'string', + 'example' => 'Never', + ], + 'SecurityGroupId' => [ + 'description' => 'The ID of the security group.'."\n", + 'type' => 'string', + 'example' => 'sg-bp12ujq5zpxuyjfo3o8r', + ], + 'Tags' => [ + 'description' => 'The tags of the instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags of the instances.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'name', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'test-xh', + ], + ], + ], + ], + 'TenantEniInstanceId' => [ + 'description' => 'This parameter is unavailable.'."\n", + 'type' => 'string', + 'example' => 'i-xxx', + ], + 'TenantEniIp' => [ + 'description' => 'This parameter is unavailable.'."\n", + 'type' => 'string', + 'example' => '10.10.XX.XX', + ], + 'TenantSecurityGroupId' => [ + 'description' => 'This parameter is unavailable.'."\n", + 'type' => 'string', + 'example' => 'sg-xxx', + ], + 'TenantVSwitchId' => [ + 'description' => 'This parameter is unavailable.'."\n", + 'type' => 'string', + 'example' => 'vsw-xxx', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1vzjjflab6wvjox****', + ], + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) to which the elastic container instance belongs.'."\n", + 'type' => 'string', + 'example' => 'vpc-1vzjjflab6wvjox****', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone in which the elastic container instance is deployed.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + ], + 'description' => 'The information of the container groups that are used to run the serverless job.', + ], + ], + ], + 'description' => 'The list of detailed information about the serverless job.', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"JobInfos\\": [\\n {\\n \\"JobId\\": \\"5\\",\\n \\"JobName\\": \\"testjob\\",\\n \\"State\\": \\"Running\\",\\n \\"Priority\\": 9,\\n \\"Queue\\": \\"comp\\",\\n \\"User\\": \\"testuser\\",\\n \\"SubmitTime\\": 1647423718,\\n \\"StartTime\\": 1647427667,\\n \\"EndTime\\": 1662016121,\\n \\"LastModifyTime\\": 1663831441000,\\n \\"IsArrayJob\\": false,\\n \\"ArrayProperties\\": {\\n \\"IndexStart\\": 1,\\n \\"IndexEnd\\": 5,\\n \\"IndexStep\\": 2\\n },\\n \\"ContainerGroups\\": [\\n {\\n \\"ContainerGroupId\\": \\"eci-bp1jrgfqqy54kg5hc****\\",\\n \\"ContainerGroupName\\": \\"test\\",\\n \\"Status\\": \\"Running\\",\\n \\"InstanceType\\": \\"ecs.g5.large\\",\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"SpotPriceLimit\\": 0.025,\\n \\"Cpu\\": 2,\\n \\"Memory\\": 4,\\n \\"Containers\\": [\\n {\\n \\"Args\\": [\\n \\"hello.py\\"\\n ],\\n \\"Commands\\": [\\n \\"/usr/bin/python\\"\\n ],\\n \\"Cpu\\": 2,\\n \\"CurrentState\\": {\\n \\"DetailStatus\\": \\"working\\",\\n \\"ExitCode\\": 0,\\n \\"FinishTime\\": \\"2018-08-02T15:00:00Z\\",\\n \\"Message\\": \\"Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)\\",\\n \\"Reason\\": \\"Started\\",\\n \\"Signal\\": 1,\\n \\"StartTime\\": \\"2019-12-19T12:05:02Z\\\\n\\",\\n \\"State\\": \\"Terminated\\\\n\\"\\n },\\n \\"EnvironmentVars\\": [\\n {\\n \\"Key\\": \\"PATH\\\\n\\",\\n \\"Value\\": \\"/usr/bin/\\\\n\\",\\n \\"ValueFrom\\": {\\n \\"FieldRef\\": {\\n \\"FieldPath\\": \\"status.podIP\\"\\n }\\n }\\n }\\n ],\\n \\"Gpu\\": 1,\\n \\"Image\\": \\"HPL\\",\\n \\"ImagePullPolicy\\": \\"Always\\",\\n \\"LivenessProbe\\": {\\n \\"Execs\\": [\\n \\"[\\\\\\"/bin/sh\\\\\\", \\\\\\"-c\\\\\\", \\\\\\"echo Hello world > /usr/share/message\\\\\\"]\\\\n\\"\\n ],\\n \\"FailureThreshold\\": 3,\\n \\"HttpGet\\": {\\n \\"Path\\": \\"/usr/nginx/\\\\n\\",\\n \\"Port\\": 80,\\n \\"Scheme\\": \\"HTTP\\"\\n },\\n \\"InitialDelaySeconds\\": 10,\\n \\"PeriodSeconds\\": 5,\\n \\"SuccessThreshold\\": 1,\\n \\"TcpSocket\\": {\\n \\"Host\\": \\"1.2.3.4\\\\n\\",\\n \\"Port\\": 80\\n },\\n \\"TimeoutSeconds\\": 10\\n },\\n \\"Memory\\": 4,\\n \\"Name\\": \\"HPL\\",\\n \\"Ports\\": [\\n {\\n \\"Port\\": 8080,\\n \\"Protocol\\": \\"TCP\\"\\n }\\n ],\\n \\"PreviousState\\": {\\n \\"DetailStatus\\": \\"working\\",\\n \\"ExitCode\\": 0,\\n \\"FinishTime\\": \\"2018-08-02T15:00:00Z\\",\\n \\"Message\\": \\"Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)\\",\\n \\"Reason\\": \\"Completed\\",\\n \\"Signal\\": 1,\\n \\"StartTime\\": \\"2018-08-02T15:00:00Z\\",\\n \\"State\\": \\"Terminated\\"\\n },\\n \\"ReadinessProbe\\": {\\n \\"Execs\\": [\\n \\"[\\\\n \\\\\\"/bin/sh\\\\\\",\\\\n \\\\\\"-c\\\\\\",\\\\n \\\\\\"echo Hello world > /usr/share/message\\\\\\"\\\\n]\\"\\n ],\\n \\"FailureThreshold\\": 3,\\n \\"HttpGet\\": {\\n \\"Path\\": \\"/usr/local\\",\\n \\"Port\\": 8080,\\n \\"Scheme\\": \\"HTTP\\"\\n },\\n \\"InitialDelaySeconds\\": 10,\\n \\"PeriodSeconds\\": 5,\\n \\"SuccessThreshold\\": 1,\\n \\"TcpSocket\\": {\\n \\"Host\\": \\"1.2.3.4\\",\\n \\"Port\\": 8888\\n },\\n \\"TimeoutSeconds\\": 1\\n },\\n \\"Ready\\": true,\\n \\"RestartCount\\": 5,\\n \\"SecurityContext\\": {\\n \\"Capability\\": {\\n \\"Adds\\": [\\n \\"NET_ADMIN\\"\\n ]\\n },\\n \\"ReadOnlyRootFilesystem\\": true,\\n \\"RunAsUser\\": 1558\\n },\\n \\"Stdin\\": true,\\n \\"StdinOnce\\": true,\\n \\"Tty\\": false,\\n \\"VolumeMounts\\": [\\n {\\n \\"MountPath\\": \\"/usr/share/\\",\\n \\"MountPropagation\\": \\"None\\",\\n \\"Name\\": \\"test-empty\\",\\n \\"ReadOnly\\": false,\\n \\"SubPath\\": \\"/usr/sub\\"\\n }\\n ],\\n \\"WorkingDir\\": \\"/usr/local/nginx\\"\\n }\\n ],\\n \\"Volumes\\": [\\n {\\n \\"ConfigFileVolumeConfigFileToPaths\\": [\\n {\\n \\"Content\\": \\"hello world\\",\\n \\"Path\\": \\"/usr/bin/\\"\\n }\\n ],\\n \\"DiskVolumeDiskId\\": \\"d-xxxx\\",\\n \\"DiskVolumeFsType\\": \\"xfs\\",\\n \\"EmptyDirVolumeMedium\\": \\"Memory\\",\\n \\"EmptyDirVolumeSizeLimit\\": \\"256Mi\\",\\n \\"FlexVolumeDriver\\": \\"flexvolume\\",\\n \\"FlexVolumeFsType\\": \\"ntfs\\",\\n \\"FlexVolumeOptions\\": \\"[nolock,tcp,noresvport]\\",\\n \\"NFSVolumePath\\": \\"/eci\\",\\n \\"NFSVolumeReadOnly\\": false,\\n \\"NFSVolumeServer\\": \\"0eafxxxxx-xxxxx.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"Name\\": \\"test-empty\\",\\n \\"Type\\": \\"EmptyDirVolume\\"\\n }\\n ],\\n \\"Events\\": [\\n {\\n \\"Count\\": 20,\\n \\"FirstTimestamp\\": \\"2018-08-02T15:00:00Z\\",\\n \\"LastTimestamp\\": \\"2018-08-02T15:00:00Z\\\\n\\",\\n \\"Message\\": \\"Started container\\",\\n \\"Name\\": \\"test-xxx\\",\\n \\"Reason\\": \\"Created\\",\\n \\"Type\\": \\"Normal\\"\\n }\\n ],\\n \\"CreationTime\\": \\"2018-08-02T15:00:00Z\\",\\n \\"SucceededTime\\": \\"2019-12-11T04:33:42Z\\",\\n \\"ExpiredTime\\": \\"2018-08-02T15:00:00Z\\",\\n \\"FailedTime\\": \\"2018-08-02T15:00:00Z\\",\\n \\"Discount\\": 9,\\n \\"DnsConfig\\": {\\n \\"NameServers\\": [\\n \\"[10.2.*.*]\\"\\n ],\\n \\"Options\\": [\\n {\\n \\"Name\\": \\"name\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"Searches\\": [\\n \\"svc.local.kubenetes\\"\\n ]\\n },\\n \\"EciSecurityContext\\": {\\n \\"Sysctls\\": [\\n {\\n \\"Name\\": \\"kernel.msgmax\\",\\n \\"Value\\": \\"65536\\"\\n }\\n ]\\n },\\n \\"EniInstanceId\\": \\"eni-bp14rzqi6fd8satm****\\",\\n \\"EphemeralStorage\\": 20,\\n \\"HostAliases\\": [\\n {\\n \\"Hostnames\\": [\\n \\"[\'hehe.com\', \'haha.com\']\\"\\n ],\\n \\"Ip\\": \\"192.0.XX.XX\\"\\n }\\n ],\\n \\"InitContainers\\": [\\n {\\n \\"Args\\": [\\n \\"[\'hello world\']\\"\\n ],\\n \\"Command\\": [\\n \\"[/bin/sh echo]\\"\\n ],\\n \\"Cpu\\": 1,\\n \\"CurrentState\\": {\\n \\"DetailStatus\\": \\"working\\",\\n \\"ExitCode\\": 0,\\n \\"FinishTime\\": \\"2018-08-02T15:00:00Z\\",\\n \\"Message\\": \\"Created container\\",\\n \\"Reason\\": \\"Started\\",\\n \\"Signal\\": 1,\\n \\"StartTime\\": \\"2018-08-02T15:00:00Z\\",\\n \\"State\\": \\"Running\\"\\n },\\n \\"EnvironmentVars\\": [\\n {\\n \\"Key\\": \\"PATH\\",\\n \\"Value\\": \\"/usr/local/bin\\",\\n \\"ValueFrom\\": {\\n \\"FieldRef\\": {\\n \\"FieldPath\\": \\"status.podIP\\"\\n }\\n }\\n }\\n ],\\n \\"Gpu\\": 1,\\n \\"Image\\": \\"nginx\\",\\n \\"ImagePullPolicy\\": \\"Always\\",\\n \\"Memory\\": 2,\\n \\"Name\\": \\"Init-xxx\\",\\n \\"Ports\\": [\\n {\\n \\"Port\\": 8888,\\n \\"Protocol\\": \\"TCP\\"\\n }\\n ],\\n \\"PreviousState\\": {\\n \\"DetailStatus\\": \\"working\\",\\n \\"ExitCode\\": 0,\\n \\"FinishTime\\": \\"2019-12-24T05:35:44Z\\",\\n \\"Message\\": \\"Started container\\",\\n \\"Reason\\": \\"completed\\",\\n \\"Signal\\": 1,\\n \\"StartTime\\": \\"2019-12-24T05:35:44Z\\",\\n \\"State\\": \\"Terminated\\"\\n },\\n \\"Ready\\": true,\\n \\"RestartCount\\": 5,\\n \\"SecurityContext\\": {\\n \\"Capability\\": {\\n \\"Adds\\": [\\n \\"NET_ADMIN\\"\\n ]\\n },\\n \\"ReadOnlyRootFilesystem\\": true,\\n \\"RunAsUser\\": 1557\\n },\\n \\"VolumeMounts\\": [\\n {\\n \\"MountPath\\": \\"/usr/share/\\",\\n \\"MountPropagation\\": \\"None\\",\\n \\"Name\\": \\"test-empty\\",\\n \\"ReadOnly\\": false\\n }\\n ],\\n \\"WorkingDir\\": \\"/usr/test\\"\\n }\\n ],\\n \\"InternetIp\\": \\"192.0.XX.XX\\",\\n \\"IntranetIp\\": \\"172.16.XX.XX\\",\\n \\"Ipv6Address\\": \\"2001:XXXX:4:4:4:4:4:4\\",\\n \\"RamRoleName\\": \\"ram:PassRole\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceGroupId\\": \\"rg-aekzh43v*****\\",\\n \\"RestartPolicy\\": \\"Never\\",\\n \\"SecurityGroupId\\": \\"sg-bp12ujq5zpxuyjfo3o8r\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"name\\",\\n \\"Value\\": \\"test-xh\\"\\n }\\n ],\\n \\"TenantEniInstanceId\\": \\"i-xxx\\",\\n \\"TenantEniIp\\": \\"10.10.XX.XX\\",\\n \\"TenantSecurityGroupId\\": \\"sg-xxx\\",\\n \\"TenantVSwitchId\\": \\"vsw-xxx\\",\\n \\"VSwitchId\\": \\"vsw-bp1vzjjflab6wvjox****\\",\\n \\"VpcId\\": \\"vpc-1vzjjflab6wvjox****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeServerlessJobs', + ], + 'StopServerlessJobs' => [ + 'summary' => 'Stops Serverless jobs in a cluster based on job IDs or subtask IDs (array jobs). If you specify the job ID of an array job, all subtasks in the job are stopped.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The serverless job IDs or subtask IDs (array jobs).'."\n" + ."\n" + .'* If you specify the job ID of an array job, all subtasks under the array job are stopped.'."\n" + .'* If you specify the ID of a subtask of an array job, only the subtask is stopped.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the serverless job or subtask (array job).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => 'StopServerlessJobs', + ], + 'CreateJobTemplate' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CommandLine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The command that is used to run the job.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => './LammpsTest/lammps.pbs', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the job template. The name must be 2 to 64 characters in length. It must start with a letter and can contain letters, digits, hyphens (-), and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'jobtemplate1', + ], + ], + [ + 'name' => 'RunasUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the user that runs the job.'."\n" + ."\n" + .'You can call the [ListUsers](~~188572~~) operation to query the users of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => 'The priority of the job. Valid values: 0 to 9. A larger value indicates a higher priority.'."\n" + ."\n" + .'Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PackagePath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path that is used to run the job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => './jobfolder', + ], + ], + [ + 'name' => 'StdoutRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The output file path of stdout.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => './LammpsTest', + ], + ], + [ + 'name' => 'StderrRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The output file path of stderr.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => './LammpsTest', + ], + ], + [ + 'name' => 'ReRunable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically rerun the job after the job fails. Valid value:'."\n" + ."\n" + .'* true: reruns the job.'."\n" + .'* false: does not rerun the job.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ArrayRequest', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job array.'."\n" + ."\n" + .'Format: X-Y:Z. X is the minimum index value. Y is the maximum index value. Z is the step size. For example, 2-7:2 indicates that three jobs need to be run and their index values are 2, 4, and 6.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1-10:2', + ], + ], + [ + 'name' => 'Variables', + 'in' => 'query', + 'schema' => [ + 'description' => 'The runtime variables passed to the job. They can be accessed by using environment variables in the executable file.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{Name:,Value:},{Name:,Value:}]', + ], + ], + [ + 'name' => 'Queue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the queue in which the job is run.'."\n" + ."\n" + .'You can call the [ListQueues](~~92176~~) operation to query the name of the queue.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'ClockTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum running time of the job. Valid formats:'."\n" + ."\n" + .'* hh:mm:ss'."\n" + .'* mm:ss'."\n" + .'* ss'."\n" + ."\n" + .'We recommend that you use the hh:mm:ss format. If the maximum running time is 12 hours, set the value to 12:00:00.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12:00:00', + ], + ], + [ + 'name' => 'Node', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of compute nodes. Valid values: 1 to 500.'."\n" + ."\n" + .'> If you do not specify this parameter, the Task, Thread, Mem, or GPU parameters do not take effect.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5000', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'Task', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of tasks required by a single compute node. Valid values: 1 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'Thread', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of threads required by a single compute node. Valid values: 1 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Mem', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum memory usage required by a single compute node. Unit: GB, MB, or KB. The unit is case-insensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1GB', + ], + ], + [ + 'name' => 'Gpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum GPU usage required by a single compute node. Valid values: 1 to 8.'."\n" + ."\n" + .'The parameter takes effect only when the cluster uses PBS and a compute node is a GPU-accelerated instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'InputFileUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the job files that are uploaded to an Object Storage Service (OSS) bucket.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://test.oss-cn-beijing.aliyuncs.com/test.py', + ], + ], + [ + 'name' => 'WithUnzipCmd', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to decompress the job files downloaded from an OSS bucket. Valid values:'."\n" + ."\n" + .'* true: decompresses the job file.'."\n" + .'* false: does not decompress the job file.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'UnzipCmd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The command that is used to decompress the job files downloaded from an OSS bucket. The parameter takes effect only when WithUnzipCmd is set to true. Valid values:'."\n" + ."\n" + .'* tar xzf: decompresses GZIP files.'."\n" + .'* tar xf: decompresses TAR files.'."\n" + .'* unzip: decompresses ZIP files.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tar xzf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => 'The ID of the job template.'."\n", + 'type' => 'string', + 'example' => 'ehpc-job-tmpl-6RxO5y****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'TemplateNameExist', + 'errorMessage' => 'The template name already exists.', + ], + [ + 'errorCode' => 'TooMuchTemplates', + 'errorMessage' => 'The number of templates exceeds the quota.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateId\\": \\"ehpc-job-tmpl-6RxO5y****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateJobTemplateResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n <TemplateId>ehpc-job-tmpl-6RxO5y****</TemplateId>\\r\\n</CreateJobTemplateResponse>","errorExample":""}]', + 'title' => 'CreateJobTemplate', + 'summary' => 'Creates a job template.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListJobTemplates' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the job template.'."\n" + ."\n" + .'You can call the [ListJobTemplates](~~87248~~) operation to obtain the job template name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'jobtemplateName', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number to return. Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return per page. Maximum value: 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => 'The page number returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Templates' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'JobTemplates' => [ + 'description' => 'The list of job templates.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Task' => [ + 'description' => 'The number of tasks required by a single compute node. Valid values: 1 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Variables' => [ + 'description' => 'The environment variables of the job.'."\n", + 'type' => 'string', + 'example' => '[{Name:,Value:},{Name:,Value:}]', + ], + 'CommandLine' => [ + 'description' => 'The command that is used to run the job.'."\n", + 'type' => 'string', + 'example' => './LammpsTest/lammps.pbs', + ], + 'Queue' => [ + 'description' => 'The queue of the job.'."\n", + 'type' => 'string', + 'example' => 'workq', + ], + 'Priority' => [ + 'description' => 'The priority of the job. Valid values: 0 to 9. A larger value indicates a higher priority.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Mem' => [ + 'description' => 'The maximum memory usage of a single compute node. The unit can be GB, MB, or KB, and is case-insensitive.'."\n", + 'type' => 'string', + 'example' => '1GB', + ], + 'Thread' => [ + 'description' => 'The number of threads required by a single task. Valid values: 1 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ArrayRequest' => [ + 'description' => 'The queue of the job.'."\n" + ."\n" + .'Format: X-Y:Z. X is the minimum index value. Y is the maximum index value. Z is the step size. For example, 2-7:2 indicates that three jobs need to be run and their index values are 2, 4, and 6.'."\n", + 'type' => 'string', + 'example' => '2-7:2', + ], + 'StderrRedirectPath' => [ + 'description' => 'The output file path of stderr.'."\n", + 'type' => 'string', + 'example' => './LammpsTest', + ], + 'Node' => [ + 'description' => 'The number of compute nodes. Valid values: 1 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'StdoutRedirectPath' => [ + 'description' => 'The output file path of stdout.'."\n", + 'type' => 'string', + 'example' => './Lammps', + ], + 'Gpu' => [ + 'description' => 'The maximum GPU usage for individual compute nodes. Valid values: 1 to 8.'."\n" + ."\n" + .'The parameter takes effect only when the cluster uses PBS and a compute node is a GPU-accelerated instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PackagePath' => [ + 'description' => 'The path that is used to run the job.'."\n", + 'type' => 'string', + 'example' => './jobfolder', + ], + 'ClockTime' => [ + 'description' => 'The maximum running time of the job. Valid formats:'."\n" + ."\n" + .'* hh:mm:ss'."\n" + .'* mm:ss'."\n" + .'* ss'."\n", + 'type' => 'string', + 'example' => '12:00:00', + ], + 'ReRunable' => [ + 'description' => 'Specifies whether the job can be rerun. Valid values:'."\n" + ."\n" + .'* true: The job can be rerun.'."\n" + .'* false: The job cannot be rerun.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'Name' => [ + 'description' => 'The name of the job template.'."\n", + 'type' => 'string', + 'example' => 'job1', + ], + 'Id' => [ + 'description' => 'The ID of the job template.'."\n", + 'type' => 'string', + 'example' => 'ehpc-job-tmpl-6RxO5y****', + ], + 'RunasUser' => [ + 'description' => 'The name of the user that runs the job.'."\n", + 'type' => 'string', + 'example' => 'user1', + ], + 'InputFileUrl' => [ + 'description' => 'The URL of the job files that are uploaded to an Object Storage Service (OSS) bucket.'."\n", + 'type' => 'string', + 'example' => 'https://test.oss-cn-beijing.aliyuncs.com/test.py', + ], + 'WithUnzipCmd' => [ + 'description' => 'Specifies whether to decompress the job files downloaded from an OSS bucket. Valid value:'."\n" + ."\n" + .'* true: decompresses the job file.'."\n" + .'* false: does not decompress the job file.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'UnzipCmd' => [ + 'description' => 'The command that is used to decompress the job files downloaded from an OSS bucket. The parameter takes effect only when WithUnzipCmd is set to true. Valid values:'."\n" + ."\n" + .'* tar xzf: decompresses GZIP files.'."\n" + .'* tar xf: decompresses TAR files.'."\n" + .'* unzip: decompresses ZIP files.'."\n", + 'type' => 'string', + 'example' => 'tar xzf', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Templates\\": {\\n \\"JobTemplates\\": [\\n {\\n \\"Task\\": 2,\\n \\"Variables\\": \\"[{Name:,Value:},{Name:,Value:}]\\",\\n \\"CommandLine\\": \\"./LammpsTest/lammps.pbs\\",\\n \\"Queue\\": \\"workq\\",\\n \\"Priority\\": 0,\\n \\"Mem\\": \\"1GB\\",\\n \\"Thread\\": 1,\\n \\"ArrayRequest\\": \\"2-7:2\\",\\n \\"StderrRedirectPath\\": \\"./LammpsTest\\",\\n \\"Node\\": 2,\\n \\"StdoutRedirectPath\\": \\"./Lammps\\",\\n \\"Gpu\\": 1,\\n \\"PackagePath\\": \\"./jobfolder\\",\\n \\"ClockTime\\": \\"12:00:00\\",\\n \\"ReRunable\\": false,\\n \\"Name\\": \\"job1\\",\\n \\"Id\\": \\"ehpc-job-tmpl-6RxO5y****\\",\\n \\"RunasUser\\": \\"user1\\",\\n \\"InputFileUrl\\": \\"https://test.oss-cn-beijing.aliyuncs.com/test.py\\",\\n \\"WithUnzipCmd\\": true,\\n \\"UnzipCmd\\": \\"tar xzf\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListJobTemplatesResponse>\\n <PageSize>1</PageSize>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n <PageNumber>1</PageNumber>\\n <TotalCount>1</TotalCount>\\n <Templates>\\n <Task>2</Task>\\n <Variables>[{Name:,Value:},{Name:,Value:}]</Variables>\\n <CommandLine>./LammpsTest/lammps.pbs</CommandLine>\\n <Queue>workq</Queue>\\n <Priority>0</Priority>\\n <Mem>1GB</Mem>\\n <Thread>1</Thread>\\n <ArrayRequest>2-7:2</ArrayRequest>\\n <StderrRedirectPath>./LammpsTest</StderrRedirectPath>\\n <Node>2</Node>\\n <StdoutRedirectPath>./Lammps</StdoutRedirectPath>\\n <Gpu>1</Gpu>\\n <PackagePath>./jobfolder</PackagePath>\\n <ClockTime>12:00:00</ClockTime>\\n <ReRunable>false</ReRunable>\\n <Name>job1</Name>\\n <Id>ehpc-job-tmpl-6RxO5y****</Id>\\n <RunasUser>user1</RunasUser>\\n <InputFileUrl>https://test.oss-cn-beijing.aliyuncs.com//test.py</InputFileUrl>\\n <WithUnzipCmd>true</WithUnzipCmd>\\n <UnzipCmd>tar xzf</UnzipCmd>\\n </Templates>\\n</ListJobTemplatesResponse>","errorExample":""}]', + 'title' => 'ListJobTemplates', + 'summary' => 'Queries the list of job templates.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'EditJobTemplate' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the job template.'."\n" + ."\n" + .'You can call the [ListJobTemplates](~~87248~~) operation to obtain the job template ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-job-tmpl-6RxO5y****', + ], + ], + [ + 'name' => 'CommandLine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The command that is used to run the job.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => './LammpsTest/lammps.pbs', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the job template.'."\n" + ."\n" + .'You can call the [ListJobTemplates](~~87248~~) operation to obtain the job template name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'jobTemapleteName', + ], + ], + [ + 'name' => 'RunasUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the user that runs the job.'."\n" + ."\n" + .'You can call the [ListUsers](~~188572~~) operation to query the users of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => 'The priority of the job. Valid values: 0 to 9. A large value indicates a high priority.'."\n" + ."\n" + .'Default value: 0'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PackagePath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The path that is used to run the job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => './packageFolder', + ], + ], + [ + 'name' => 'StdoutRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The output file path of stdout.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => './LammpsTest', + ], + ], + [ + 'name' => 'StderrRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => 'The output file path of stderr.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => './Lammps', + ], + ], + [ + 'name' => 'ReRunable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the job can be rerun. Valid values:'."\n" + ."\n" + .'* true: The job can be rerun.'."\n" + .'* false: The job cannot be rerun.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ArrayRequest', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job array.'."\n" + ."\n" + .'Format: X-Y:Z. X is the minimum index value. Y is the maximum index value. Z is the step size. For example, 2-7:2 indicates that three jobs need to be run and their index values are 2, 4, and 6.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1-10:2', + ], + ], + [ + 'name' => 'Variables', + 'in' => 'query', + 'schema' => [ + 'description' => 'The runtime variables passed to the job. They can be accessed by using environment variables in the executable file.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{Name:,Value:},{Name:,Value:}]', + ], + ], + [ + 'name' => 'Queue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the queue.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'ClockTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum running time of the job. Valid formats:'."\n" + ."\n" + .'* hh:mm:ss'."\n" + .'* mm:ss'."\n" + .'* ss'."\n" + ."\n" + .'We recommend that you use the hh:mm:ss format. If the maximum running time is 12 hours, set the value to 12:00:00.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12:00:00', + ], + ], + [ + 'name' => 'Node', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the compute nodes. Valid values: 1 to 500.'."\n" + ."\n" + .'> If the parameter is not specified, the Task, Thread, Mem, and Gpu parameters become invalid.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5000', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'Task', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of tasks required by a single compute node. Valid values: 1 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'Thread', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of threads required by a single compute node. Valid values: 1 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Mem', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum memory usage required by a single compute node. Unit: GB, MB, or KB. The unit is case-insensitive.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1GB', + ], + ], + [ + 'name' => 'Gpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum GPU usage required by a single compute node. Valid values: 1 to 8.'."\n" + ."\n" + .'The parameter takes effect only when the cluster uses PBS and a compute node is a GPU-accelerated instance.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'InputFileUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the job files that are uploaded to an Object Storage Service (OSS) bucket.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://test.oss-cn-beijing.aliyuncs.com/test.py', + ], + ], + [ + 'name' => 'WithUnzipCmd', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to decompress the job files downloaded from an OSS bucket. Valid values:'."\n" + ."\n" + .'* true: The job files are decompressed.'."\n" + .'* false: The job files are not decompressed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'UnzipCmd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The command that is used to decompress the job files downloaded from an OSS bucket. The parameter takes effect only when WithUnzipCmd is set to true. Valid values:'."\n" + ."\n" + .'* tar xzf: decompresses GZIP files.'."\n" + .'* tar xf: decompresses TAR files.'."\n" + .'* unzip: decompresses ZIP files.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tar xzf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => 'The ID of the job template.'."\n", + 'type' => 'string', + 'example' => 'ehpc-job-tmpl-6RxO5y****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'TemplateNameExist', + 'errorMessage' => 'The template name already exists.', + ], + [ + 'errorCode' => 'TooMuchTemplates', + 'errorMessage' => 'The number of templates exceeds the quota.', + ], + ], + [ + [ + 'errorCode' => 'TemplateNotExist', + 'errorMessage' => 'The template ID does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateId\\": \\"ehpc-job-tmpl-6RxO5y****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<EditJobTemplateResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n <TemplateId>ehpc-job-tmpl-6RxO5y****</TemplateId>\\r\\n</EditJobTemplateResponse>","errorExample":""}]', + 'title' => 'EditJobTemplate', + 'summary' => 'Modifies a job template.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteJobTemplates' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Templates', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the job templates that you want to delete. You can specify a maximum of 20 job template IDs.'."\n" + ."\n" + .'Format of job template IDs: `[{"Id": "0.sched****"},{"Id": "1.sched****"}]`. Separate multiple job template IDs with commas (,).'."\n" + ."\n" + .'You can call the [ListJobTemplates](~~87248~~) operation to query job template IDs.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Id":"ehpc-job-tmpl-6RVcMK****"},{"Id": "ehpc-job-tmpl-6RxO5y****"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteJobTemplatesResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n</DeleteJobTemplatesResponse>","errorExample":""}]', + 'title' => 'DeleteJobTemplates', + 'summary' => 'Deletes job templates.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InvokeShellCommand' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '75862', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Command', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the command. The content must be 2 to 2,048 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'echo "hello world"', + ], + ], + [ + 'name' => 'WorkingDir', + 'in' => 'query', + 'schema' => [ + 'description' => 'The working directory of the command. Default value: `/root`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/home', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'The timeout period. If a command times out, the command process will be terminated. Unit: seconds.'."\n" + ."\n" + .'Default value: 60.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information of nodes on which the command is run.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the Nth node instance on which the command is run.'."\n" + ."\n" + .'> This parameter specifies the node on which the command is run. If it is not specified, the command will be run on all nodes of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1in9hmw3ur52x0****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CommandId' => [ + 'description' => 'The ID of the command. It is used to query the execution status of the command.'."\n", + 'type' => 'string', + 'example' => 'c-hz01v8vudql****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The list of IDs of the instances on which you want to run the command.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of IDs of the instances on which you want to run the command.', + 'type' => 'string', + 'example' => '[ "i-uf68t1zu3jkhs8w****", "i-uf6abz34m2714bp****", "i-uf65bh2113hlqvyx****", "i-uf68t1zu3jkhs8wx****", "i-uf6b0mtpx166fxxi****", "i-uf6faknz4dy1bit7****" ]', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"CommandId\\": \\"c-hz01v8vudql****\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"InstanceIds\\": {\\n \\"InstanceId\\": [\\n \\"[ \\\\\\"i-uf68t1zu3jkhs8w****\\\\\\", \\\\\\"i-uf6abz34m2714bp****\\\\\\", \\\\\\"i-uf65bh2113hlqvyx****\\\\\\", \\\\\\"i-uf68t1zu3jkhs8wx****\\\\\\", \\\\\\"i-uf6b0mtpx166fxxi****\\\\\\", \\\\\\"i-uf6faknz4dy1bit7****\\\\\\" ]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<InvokeShellCommandResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n <CommandId>c-hz01v8vudql****</CommandId>\\r\\n <InstanceIds>\\r\\n <InstanceId>i-uf68t1zu3jkhs8w****</InstanceId>\\r\\n <InstanceId>i-uf6abz34m2714bp****</InstanceId>\\r\\n <InstanceId>i-uf65bh2113hlqvyx****</InstanceId>\\r\\n <InstanceId>i-uf68t1zu3jkhs8wx****</InstanceId>\\r\\n <InstanceId>i-uf6b0mtpx166fxxi****</InstanceId>\\r\\n <InstanceId>i-uf6faknz4dy1bit7****</InstanceId>\\r\\n </InstanceIds>\\r\\n</InvokeShellCommandResponse>","errorExample":""}]', + 'title' => 'InvokeShellCommand', + 'summary' => 'Runs interactive commands in a cluster node.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListCommands' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'CommandId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the command.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'c-hz01v8vudql****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n" + ."\n" + .'Page number starts from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page.\\'."\n" + .'Valid values: 1 to 50.\\'."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Commands' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Command' => [ + 'description' => 'The list of commands.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'description' => 'The timeout period. Unit: seconds.'."\n", + 'type' => 'string', + 'example' => '60', + ], + 'CommandId' => [ + 'description' => 'The ID of the command.'."\n", + 'type' => 'string', + 'example' => 'c-hz01v8vudql****', + ], + 'WorkingDir' => [ + 'description' => 'The working directory of the command.'."\n", + 'type' => 'string', + 'example' => '/home', + ], + 'CommandContent' => [ + 'description' => 'The content of the command.'."\n", + 'type' => 'string', + 'example' => 'echo "hello world"', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Commands\\": {\\n \\"Command\\": [\\n {\\n \\"Timeout\\": \\"60\\",\\n \\"CommandId\\": \\"c-hz01v8vudql****\\",\\n \\"WorkingDir\\": \\"/home\\",\\n \\"CommandContent\\": \\"echo \\\\\\"hello world\\\\\\"\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCommandsResponse>\\n <PageSize>10</PageSize>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\n <PageNumber>1</PageNumber>\\n <TotalCount>1</TotalCount>\\n <Commands>\\n <Timeout>60</Timeout>\\n <CommandId>c-hz01v8vudql****</CommandId>\\n <WorkingDir>/home</WorkingDir>\\n <CommandContent>echo \\"hello world\\"</CommandContent>\\n </Commands>\\n</ListCommandsResponse>","errorExample":""}]', + 'title' => 'ListCommands', + 'summary' => 'Queries the interactive commands in a specified cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListInvocationResults' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'CommandId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the command.'."\n" + ."\n" + .'You can call the [ListCommands](~~87388~~) operation to query the command ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c-hz01v8x80o3****', + ], + ], + [ + 'name' => 'InvokeRecordStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the command that you want to query. Valid values:'."\n" + ."\n" + .'* Finished'."\n" + .'* Running'."\n" + .'* Failed'."\n" + .'* Stopped'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Finished', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of the page to return.'."\n" + ."\n" + .'Page numbers start from 1.'."\n" + ."\n" + .'Default value: 1'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information of nodes on which the command is run.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The ID of the node on which the command is run.'."\n" + ."\n" + .'> The Instance.N.Id parameter specifies the node on which the command is run. If it is not specified, the command is run on all nodes of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf65bh2113hlqvyr****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InvocationResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InvocationResult' => [ + 'description' => 'The result of the command.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the command was run and its result was obtained.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => 'The output result.'."\n", + 'type' => 'string', + 'example' => 'hello world', + ], + 'FinishedTime' => [ + 'description' => 'The time at which the command entered the Finished state.'."\n", + 'type' => 'string', + 'example' => '2021-09-06T09:14:56Z', + ], + 'CommandId' => [ + 'description' => 'The ID of the command.'."\n", + 'type' => 'string', + 'example' => 'c-hz01v8x80o3****', + ], + 'InstanceId' => [ + 'description' => 'The ID of the node on which the command was run.'."\n", + 'type' => 'string', + 'example' => 'i-uf65bh2113hlqvyr****', + ], + 'InvokeRecordStatus' => [ + 'description' => 'The status of the command. Valid values:'."\n" + ."\n" + .'* Finished'."\n" + .'* Running'."\n" + .'* Failed'."\n" + .'* Stopped'."\n", + 'type' => 'string', + 'example' => 'Finished', + ], + 'ExitCode' => [ + 'description' => 'The exit code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"InvocationResults\\": {\\n \\"InvocationResult\\": [\\n {\\n \\"Success\\": true,\\n \\"Message\\": \\"hello world\\",\\n \\"FinishedTime\\": \\"2021-09-06T09:14:56Z\\",\\n \\"CommandId\\": \\"c-hz01v8x80o3****\\",\\n \\"InstanceId\\": \\"i-uf65bh2113hlqvyr****\\",\\n \\"InvokeRecordStatus\\": \\"Finished\\",\\n \\"ExitCode\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListInvocationResultsResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n <TotalCount>1</TotalCount>\\r\\n <PageNumber>1</PageNumber>\\r\\n <PageSize>10</PageSize>\\r\\n <InvocationResults>\\r\\n <InvocationResult>\\r\\n <CommandId>c-hz01v8x80o3****</CommandId>\\r\\n <Success>true</Success>\\r\\n <InvokeRecordStatus>Finished</InvokeRecordStatus>\\r\\n <FinishedTime>2021-09-06T09:14:56Z</FinishedTime>\\r\\n <ExitCode>0</ExitCode>\\r\\n <Message>hello world</Message>\\r\\n <InstanceId>i-uf65bh2113hlqvyr****</InstanceId>\\r\\n </InvocationResult>\\r\\n </InvocationResults>\\r\\n</ListInvocationResultsResponse>","errorExample":""}]', + 'title' => 'ListInvocationResults', + 'summary' => 'Queries the result of an interactive command in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListInvocationStatus' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'CommandId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The command ID.'."\n" + ."\n" + .'You can call the [ListCommands](~~87388~~) operation to query the command ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c-hz01v8x80o3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'CommandId' => [ + 'description' => 'The command ID.'."\n", + 'type' => 'string', + 'example' => 'c-hz01v8x80o3****', + ], + 'InvokeStatus' => [ + 'description' => 'The status of the command. Valid values:'."\n" + ."\n" + .'* Finished: The execution of the command finished.'."\n" + .'* Running: The command is being executed.'."\n" + .'* Failed: The command failed to be executed.'."\n" + .'* Stopped: The execution of the command stopped.'."\n", + 'type' => 'string', + 'example' => 'Finished', + ], + 'InvokeInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InvokeInstance' => [ + 'description' => 'An array of execution statuses. An entry is returned for each node.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceInvokeStatus' => [ + 'description' => 'The status of the node. Valid values:'."\n" + ."\n" + .'* Finished: The running of the node finished.'."\n" + .'* Running: The node is running.'."\n" + .'* Failed: The node failed to run.'."\n" + .'* Stopped: The running of the node stopped.'."\n", + 'type' => 'string', + 'example' => 'Finished', + ], + 'InstanceId' => [ + 'description' => 'The ID of the node.'."\n", + 'type' => 'string', + 'example' => 'i-uf6abz34m2714bp4****', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"CommandId\\": \\"c-hz01v8x80o3****\\",\\n \\"InvokeStatus\\": \\"Finished\\",\\n \\"InvokeInstances\\": {\\n \\"InvokeInstance\\": [\\n {\\n \\"InstanceInvokeStatus\\": \\"Finished\\",\\n \\"InstanceId\\": \\"i-uf6abz34m2714bp4****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListInvocationStatusResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n <CommandId>c-hz01v8x80o3****</CommandId>\\r\\n <InvokeStatus>Finished</InvokeStatus>\\r\\n <InvokeInstances>\\r\\n <InvokeInstance>\\r\\n <InstanceId>i-uf6abz34m2714bp4****</InstanceId>\\r\\n <InstanceInvokeStatus>Finished</InstanceInvokeStatus>\\r\\n </InvokeInstance>\\r\\n <InvokeInstance>\\r\\n <InstanceId>i-uf68t1zu3jkhs8wy****</InstanceId>\\r\\n <InstanceInvokeStatus>Finished</InstanceInvokeStatus>\\r\\n </InvokeInstance>\\r\\n </InvokeInstances>\\r\\n</ListInvocationStatusResponse>","errorExample":""}]', + 'title' => 'ListInvocationStatus', + 'summary' => 'Queries the status of an interactive command.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetPostScripts' => [ + 'summary' => 'Configures the post-processing scripts of a cluster.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the cluster resides. You can call the [ListRegions](~~188593~~) operation to query the latest region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to obtain the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-sh-EnjshUxn', + ], + ], + [ + 'name' => 'PostInstallScripts', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The post-processing scripts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => 'The parameter that is used to run the post-processing script.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-h', + ], + 'Url' => [ + 'description' => 'The URL that is used to download the post-processing script.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://bucket.oss-cn-shanghai.aliyuncs.com/postscript_examples.sh', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B745C159-3155-4B94-95D0-4B73D4D2****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetPostScriptsResponse>\\n <RequestId>B745C159-3155-4B94-95D0-4B73D4D2****</RequestId>\\n</SetPostScriptsResponse>","errorExample":""}]', + 'title' => 'SetPostScripts', + ], + 'GetPostScripts' => [ + 'summary' => 'Queries the post-processing scripts of a cluster.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the cluster resides.'."\n" + ."\n" + .'You can call the [ListRegions](~~188593~~) operation to query the latest region list.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to obtain the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-sh-EnjshUxn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'PostInstallScripts' => [ + 'description' => 'The post-installation scripts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => 'The parameter that is used to run the post-installation script.'."\n", + 'type' => 'string', + 'example' => '-h', + ], + 'Url' => [ + 'description' => 'The URL that is used to download the post-installation script.'."\n", + 'type' => 'string', + 'example' => 'https://bucket.oss-cn-shanghai.aliyuncs.com/postscript_examples.sh', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B745C159-3155-4B94-95D0-4B73D4D2****\\",\\n \\"PostInstallScripts\\": [\\n {\\n \\"Args\\": \\"-h\\",\\n \\"Url\\": \\"https://bucket.oss-cn-shanghai.aliyuncs.com/postscript_examples.sh\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetPostScriptsResponse>\\n <PostInstallScripts>\\n <Args>-h</Args>\\n <Url>https://bucket.oss-cn-shanghai.aliyuncs.com/postscript_examples.sh</Url>\\n </PostInstallScripts>\\n</GetPostScriptsResponse>","errorExample":""}]', + 'title' => 'GetPostScripts', + ], + 'GetVisualServiceStatus' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'inactive (dead) , ws service is not running.', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"inactive (dead) , ws service is not running.\\",\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetVisualServiceStatusResponse>\\r\\n <Message>\\r\\n <Msg>inactive (dead) , ws service is not running.</Msg>\\r\\n </Message>\\r\\n <RequestId>896D338C-E4F4-41EC-A154-D605E5DE****</RequestId>\\r\\n</GetVisualServiceStatusResponse>","errorExample":""}]', + 'title' => 'GetVisualServiceStatus', + 'summary' => 'Queries the status of the VNC service in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifyVisualServicePasswd' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'RunasUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the cluster. Set the value to root.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'root', + ], + ], + [ + 'name' => 'RunasUserPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that corresponds to the username specified by RunasUser.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2145****', + ], + ], + [ + 'name' => 'Passwd', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that you can use to remotely connect to the visualization service over the VNC. The password must be 6 characters in length and must contain letters and digits.'."\n" + ."\n" + .'> You must call the API operation over HTTPS to ensure that the password remains confidential.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1254****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'Service started.', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE6880', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'IncorrectCredential', + 'errorMessage' => 'The username or password is incorrect.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"{\\\\\\"Msg\\\\\\": \\\\\\"\\\\\\" }\\",\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE6880\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyVisualServicePasswdResponse>\\n<RequestId>92221BA0-4C9A-5F44-918F-6C1293F83BFA</RequestId>\\n<Message>\\n <Msg/>\\n</Message>\\n</ModifyVisualServicePasswdResponse>","errorExample":""}]', + 'title' => 'ModifyVisualServicePasswd', + 'summary' => 'Sets a password that you can use to remotely connect to a visualization service in a cluster over the virtual network console (VNC).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartVisualService' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'CidrIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'A public IP address of logon nodes in the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '190.100.**.**', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The fixed port. Set the value to 12016'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '65535', + 'example' => '12016', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The status of the VNC Remote visualization service. Valid values:'."\n" + ."\n" + .'* Service started'."\n" + .'* Service stopped'."\n", + 'type' => 'string', + 'example' => 'Service started', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE6880', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Service started.\\",\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartVisualServiceResponse>\\r\\n <Message>\\r\\n <Msg>Service started.</Msg>\\r\\n </Message>\\r\\n <RequestId>896D338C-E4F4-41EC-A154-D605E5DE****</RequestId>\\r\\n</StartVisualServiceResponse>","errorExample":""}]', + 'title' => 'StartVisualService', + 'summary' => 'Starts the Virtual Network Console (VNC) Remote visualization service in a specified cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopVisualService' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'CidrIp', + 'in' => 'query', + 'schema' => [ + 'description' => 'The CIDR block or IP address that is allowed to access the VNC service. This parameter is used to assign a security group to the E-HPC cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100.168.**.**', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => 'The fixed port. Set the value to 12016.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '65535', + 'example' => '12016', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'Service stopped', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE6880', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Service stopped\\",\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopVisualServiceResponse>\\r\\n <Message>\\r\\n <Msg>Service stopped</Msg>\\r\\n </Message>\\r\\n <RequestId>896D338C-E4F4-41EC-A154-D605E5DE****</RequestId>\\r\\n</StopVisualServiceResponse>","errorExample":""}]', + 'title' => 'StopVisualService', + 'summary' => 'Stops the remote visualization service of Virtual Network Console (VNC) in a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetAutoScaleConfig' => [ + 'summary' => 'Configures the auto scaling settings of a cluster.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'EnableAutoGrow', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto scale-out. Valid values:'."\n" + ."\n" + .'* true: enables auto scale-out.'."\n" + .'* false: disables auto scale-out.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'EnableAutoShrink', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto scale-in. Valid values:'."\n" + ."\n" + .'* true: enables auto scale-in.'."\n" + .'* false: disables auto scale-in.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'GrowIntervalInMinutes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval between two consecutive rounds of scale-out. Unit: minutes.'."\n" + ."\n" + .'Valid values: 2 to 10.'."\n" + ."\n" + .'Default value: 2.'."\n" + ."\n" + .'> An interval may exist during multiple rounds of a scale-out task or between two consecutive scale-out tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '2', + ], + ], + [ + 'name' => 'ShrinkIntervalInMinutes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval between two consecutive rounds of scale-in. Unit: minutes.'."\n" + ."\n" + .'Valid values: 2 to 10.'."\n" + ."\n" + .'Default value: 2.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '2', + ], + ], + [ + 'name' => 'ShrinkIdleTimes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of consecutive times that a compute node is idle during the resource scale-in check.'."\n" + ."\n" + .'Valid values: 2 to 5.'."\n" + ."\n" + .'Default value: 3.'."\n" + ."\n" + .'If the parameter is set to 3, a compute node is idle more than three consecutive times. In this case, the node is released. If a compute node is idle for longer than 6 minutes continuously, it is released by default. This is because the default value of the ShrinkIntervalInMinutes parameter is 2.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'default' => '3', + ], + ], + [ + 'name' => 'GrowTimeoutInMinutes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scale-out timeout period. Unit: minutes.'."\n" + ."\n" + .'Valid values: 10 to 60.'."\n" + ."\n" + .'Default value: 20.'."\n" + ."\n" + .'If the scale-out timeout period has been reached but the scale-out nodes still do not reach the Running state, the system releases them.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'ExtraNodesGrowRatio', + 'in' => 'query', + 'schema' => [ + 'description' => 'The percentage of extra compute nodes. Valid values: 0 to 100.'."\n" + ."\n" + .'Default value: 0.'."\n" + ."\n" + .'If you need to add 100 compute nodes and the value of the ExtraNodesGrowRatio parameter is 2, 102 compute nodes are added.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'GrowRatio', + 'in' => 'query', + 'schema' => [ + 'description' => 'The percentage of each round of a scale-out task. Valid values: 1 to 100.'."\n" + ."\n" + .'Default value: 100.'."\n" + ."\n" + .'If you set GrowRatio to 50, the scale-out has two rounds. Each round completes half of the scale-out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '50', + 'default' => '100', + ], + ], + [ + 'name' => 'MaxNodesInCluster', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of compute nodes that can be added to the cluster. Valid values: 0 to 500.'."\n" + ."\n" + .'Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'ExcludeNodes', + 'in' => 'query', + 'schema' => [ + 'description' => 'The compute nodes that are excluded from auto scaling tasks. Separate multiple compute nodes with commas (,).'."\n" + ."\n" + .'If you want to retain a compute node, you can specify the node as an additional node to retain the node when it is idle.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The preemption policy of the compute nodes. Valid values:'."\n" + ."\n" + .'* NoSpot: The compute nodes are pay-as-you-go instances.'."\n" + .'* SpotWithPriceLimit: The compute nodes are preemptible instances that have a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SpotWithPriceLimit', + ], + ], + [ + 'name' => 'SpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum hourly price of the compute nodes. The value can be accurate to three decimal places. The parameter takes effect only when `SpotStrategy` is set to `SpotWithPriceLimit`.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.062', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IDs of the images.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If both `Queues.N.QueueImageId` and `ImageId` are specified, `Queues.N.QueueImageId` prevails.'."\n" + ."\n" + .'* If you set `Queues.N.QueueImageId` or `ImageId`, the parameter that you set takes effect.'."\n" + .'* If you leave both `Queues.N.QueueImageId` and `ImageId` empty, the image that was specified when you created the cluster or the last time you scaled out the cluster is used by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_03_64_20G_alibase_201708****', + ], + ], + [ + 'name' => 'Queues', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The information about the queue.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The array of information about queues.'."\n", + 'type' => 'object', + 'properties' => [ + 'QueueImageId' => [ + 'description' => 'The image ID of the queue where the scale-out is performed. Valid values of N: 1 to 8.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you set both `Queues.N.QueueImageId` and `ImageId`, `Queues.N.QueueImageId` prevails.'."\n" + ."\n" + .'* If you set `Queues.N.QueueImageId` or `ImageId`, the parameter that you set takes effect.'."\n" + .'* If you leave both `Queues.N.QueueImageId` and `ImageId` empty, the image that was specified when you created the cluster or the last time when you scaled out the cluster is used by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_03_64_20G_alibase_201708****', + ], + 'SystemDiskCategory' => [ + 'description' => 'The category of the system disk specified for the compute nodes that are added to the queue. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: enhanced SSD (ESSD).'."\n" + .'* cloud: basic disk. Disks of this type are retired.'."\n" + ."\n" + .'Valid values of N: 1 to 8.'."\n" + ."\n" + .'Default value: cloud_efficiency.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_efficiency', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the compute nodes that are automatically added to the queue. Valid values of N: 1 to 8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.medium', + ], + 'HostNameSuffix' => [ + 'description' => 'The hostname suffix of the host that is used to perform scale-out for the queue. You can manage nodes that have a specified hostname suffix.'."\n" + ."\n" + .'Valid values of N: 1 to 8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '000', + ], + 'SpotStrategy' => [ + 'description' => 'The preemption policy of the compute node that is automatically added to the queue. Valid values of N: 1 to 8.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* NoSpot: The compute node is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The compute node is created as a preemptible instance that has a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The compute node is created as a preemptible instance for which the market price at the time of purchase is used as the bid price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + 'HostNamePrefix' => [ + 'description' => 'The hostname prefix of the host that is used to perform scale-out for the queue. You can manage compute nodes that have a specified hostname prefix.'."\n" + ."\n" + .'Valid values of N: 1 to 8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + 'MinNodesInQueue' => [ + 'description' => 'The minimum number of compute nodes that can be removed from the queue. Valid values: 0 to 50.'."\n" + ."\n" + .'Valid values of N: 1 to 8.'."\n" + ."\n" + .'Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'SystemDiskSize' => [ + 'description' => 'The size of the system disk specified for the compute nodes that are added to the queue. Unit: GB.'."\n" + ."\n" + .'Valid values: 40 to 500.'."\n" + ."\n" + .'Valid values of N: 1 to 8.'."\n" + ."\n" + .'Default value: 40.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + 'MaxNodesInQueue' => [ + 'description' => 'The maximum number of compute nodes that can be added to the queue. Valid values: 0 to 500.'."\n" + ."\n" + .'Valid values of N: 1 to 8.'."\n" + ."\n" + .'Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'EnableAutoShrink' => [ + 'description' => 'Specifies whether the queue enables auto scale-in. Valid values:'."\n" + ."\n" + .'* true: enables auto scale-in.'."\n" + .'* false: disables auto scale-in.'."\n" + ."\n" + .'Valid values of N: 1 to 8.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'QueueName' => [ + 'description' => 'The name of the queue. You can specify 1 to 8 names.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cluster1', + ], + 'EnableAutoGrow' => [ + 'description' => 'Specifies whether the queue enables auto scale-out. Valid values:'."\n" + ."\n" + .'* true: enables auto scale-out.'."\n" + .'* false: disables auto scale-out.'."\n" + ."\n" + .'Valid values of N: 1 to 8.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'SystemDiskLevel' => [ + 'description' => 'The performance level of the system disk specified for the compute nodes that are added to the queue. Valid values:'."\n" + ."\n" + .'* PL0: An ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: An ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: An ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'Valid values of N: 1 to 8.'."\n" + ."\n" + .'Default value: PL1.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'SpotPriceLimit' => [ + 'description' => 'The maximum hourly price of the compute nodes that are automatically added to the queue. The value can be accurate to three decimal places. The parameter takes effect only when `Queues.N.SpotStrategy` is set to `SpotWithPriceLimit`.'."\n" + ."\n" + .'Valid values of N: 1 to 8.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.662', + ], + 'InstanceTypes' => [ + 'description' => 'The instance types of the nodes in the queue.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The array of node information.'."\n", + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => 'The vSwitch ID of the compute nodes that are automatically added to the queue.'."\n" + ."\n" + .'You can specify 1 to 8 IDs.'."\n" + ."\n" + .'The vSwitch IDs of N compute nodes in the queue can be set at the same time when auto scaling is performed in the queue. Valid values of N: 0 to 500.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone that compute nodes automatically added to the queue belong.'."\n" + ."\n" + .'You can specify 1 to 8 IDs.'."\n" + ."\n" + .'The zone IDs of N compute nodes in the queue can be set at the same time when auto scaling is performed in the queue. Valid values of N: 0 to 500.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + 'SpotPriceLimit' => [ + 'description' => 'The maximum hourly price of the compute nodes that are automatically added to the queue. The value can be accurate to three decimal places. The parameter takes effect only when `Queues.N.InstanceTypes.N.SpotStrategy` is set to `SpotWithPriceLimit`.'."\n" + ."\n" + .'You can specify the maximum hourly price for 1 to 8 compute nodes.'."\n" + ."\n" + .'The maximum hourly prices of N compute nodes in the queue can be set at the same time when auto scaling is performed in the queue. Valid values of N: 0 to 500.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.660', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the compute nodes that are automatically added to the queue.'."\n" + ."\n" + .'You can specify the specification for 1 to 8 nodes.'."\n" + ."\n" + .'The instance types of N compute nodes in the queue can be set at the same time when auto scaling is performed in the queue. Valid values of N: 0 to 500.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + 'SpotStrategy' => [ + 'description' => 'The preemption policy for the compute node that is automatically added to the queue. Valid values:'."\n" + ."\n" + .'* NoSpot: The compute node is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The compute node is created as a preemptible instance that has a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The compute node is created as a preemptible instance for which the market price at the time of purchase is used as the bid price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n" + ."\n" + .'You can specify the preemption policy for 1 to 8 compute nodes.'."\n" + ."\n" + .'The preemption policies of N compute nodes in the queue can be set at the same time when auto scaling is performed in the queue. Valid values of N: 0 to 500.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SpotWithPriceLimit', + ], + 'SpotDuration' => [ + 'title' => '抢占式实例的保留时长，单位为小时。取值范围：0~6。'."\n" + .'- 保留时长2~6正在邀测中，如需开通请提交工单。'."\n" + .'- 取值为0，则为无保护期模式。'."\n" + .'默认值：1。', + 'description' => 'The protection period of the preemptible instance. Unit: hours. Valid values: 0 to 1. A value of 0 means that no protection period is specified. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'SpotInterruptionBehavior' => [ + 'title' => '抢占实例中断模式。目前仅支持Terminate（默认）直接释放实例。', + 'description' => 'The interruption mode of the preemptible instance. The value can only be Terminate, which indicates that the instance is released.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Terminate', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + 'DataDisks' => [ + 'description' => 'The list of data disks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of data disks.'."\n", + 'type' => 'object', + 'properties' => [ + 'DataDiskSize' => [ + 'description' => 'The size of the data disk. Unit: GB.'."\n" + ."\n" + .'Valid values: 40 to 500.'."\n" + ."\n" + .'Default value: 40.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + 'DataDiskCategory' => [ + 'description' => 'The category of the data disk. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD.'."\n" + .'* cloud: basic disk.'."\n" + ."\n" + .'Default value: cloud_efficiency.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_efficiency', + ], + 'DataDiskDeleteWithInstance' => [ + 'description' => 'Specifies whether the data disk is released when the node is released. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: true.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'DataDiskPerformanceLevel' => [ + 'description' => 'The performance level of the ESSD used as the data disk. The parameter takes effect only when the Queues.N.DataDisks.N.DataDiskCategory parameter is set to cloud_essd. Valid values:'."\n" + ."\n" + .'* PL0: An ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: An ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: An ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n" + ."\n" + .'Default value: PL1.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'DataDiskEncrypted' => [ + 'description' => 'Specifies whether to encrypt the data disk. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'DataDiskKMSKeyId' => [ + 'description' => 'The Key Management Service (KMS) key ID of the data disk.'."\n" + ."\n" + .'Valid values of N: 0 to 16.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40826X', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + 'MaxNodesPerCycle' => [ + 'description' => 'The maximum number of compute nodes that can be added in each round of scale-out. Valid values: 0 to 99.'."\n" + ."\n" + .'Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'MinNodesPerCycle' => [ + 'description' => 'The minimum number of compute nodes that can be added in each round of scale-out. Valid values: 1 to 99'."\n" + ."\n" + .'Default value: 1.'."\n" + ."\n" + .'If the number of compute nodes that you want to add in a round is less than the value of this property, the system automatically changes the value of this property to the number of compute nodes that you want to add in a round. This helps ensure that compute nodes can be added as expected.'."\n" + ."\n" + .'> The configuration takes effect only for the minimum compute nodes that can be added in the current round.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'AutoMinNodesPerCycle' => [ + 'description' => 'Specifies whether to automatically specify the minimum number of compute nodes that can be added in each round of scale-out. If you set this parameter to true, the minimum number of nodes for each scale-out is equal to the number of nodes required by the job. The maximum number is 99.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'SortedByInventory' => [ + 'description' => 'Specifies whether the instances are unordered. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'> If you set this parameter to true, the system selects instance types in descending order of the number of instances in stock during auto scaling.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 8, + ], + ], + [ + 'name' => 'ComputeEnableHt', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable hyper-threading for the ECS instance that is used as the compute node.'."\n" + ."\n" + .'> You can only disable hyper-threading for some instance types. The hyper-threading is enabled for ECS instances by default. For more information, see [Specify and view CPU options](~~145895~~).'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DnsConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configurations of DNS.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '"{\\"DnsType\\":\\"PrivateZone\\",\\"DnsName\\":\\"xxxxx\\"}"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-13358736C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidOpt', + 'errorMessage' => 'The specified operation is invalid. Please try again later. If the problem still exists, submit a ticket.', + ], + [ + 'errorCode' => 'TooManyComputes', + 'errorMessage' => 'The number of computing nodes exceeds the quota.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-13358736C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetAutoScaleConfigResponse>\\n <RequestId>04F0F334-13358736C-A1D7-6C044FE7****</RequestId>\\n</SetAutoScaleConfigResponse>","errorExample":""}]', + 'title' => 'SetAutoScaleConfig', + 'description' => '## Usage notes'."\n" + ."\n" + .'If the settings in the Queue Configuration section are different from the settings in the Global Configurations section, the former prevails.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeAutoScaleConfig' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MaxNodesInCluster' => [ + 'description' => 'The maximum number of compute nodes in the cluster. This parameter indicates the largest number of nodes that can be added to the cluster.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'GrowTimeoutInMinutes' => [ + 'description' => 'The timeout period before the scale-out nodes were started. Valid values: 10 to 60.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SpotStrategy' => [ + 'description' => 'The bidding method of the compute nodes. Valid values:'."\n" + ."\n" + .'* NoSpot: The instances of the compute node are pay-as-you-go instances.'."\n" + .'* SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73', + ], + 'EnableAutoShrink' => [ + 'description' => 'Specifies whether to enable auto scale-in.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ClusterType' => [ + 'description' => 'The type of the scheduler. Valid values:'."\n" + ."\n" + .'* pbs'."\n" + .'* slurm'."\n" + .'* opengridscheduler'."\n" + .'* deadline'."\n", + 'type' => 'string', + 'example' => 'slurm', + ], + 'EnableAutoGrow' => [ + 'description' => 'Specifies whether to enable auto scale-out.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExcludeNodes' => [ + 'description' => 'The list of nodes on which auto scaling is not enabled.'."\n", + 'type' => 'string', + 'example' => 'i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****', + ], + 'GrowIntervalInMinutes' => [ + 'description' => 'The interval between two consecutive rounds of scale-in. Valid values: 2 to 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ShrinkIntervalInMinutes' => [ + 'description' => 'The interval between two consecutive rounds of scale-out. Valid values: 2 to 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SpotPriceLimit' => [ + 'description' => 'The maximum hourly price of the new ECS instance. The value is accurate to three decimal places. It takes effect only when SpotStrategy is set to SpotWithPriceLimit.'."\n", + 'type' => 'string', + 'example' => '0.062', + ], + 'ShrinkIdleTimes' => [ + 'description' => 'The number of consecutive idle times of a node during the resource shrink check. Valid values: 2 to 5.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ExtraNodesGrowRatio' => [ + 'description' => 'The percentage of extra compute nodes. Valid values: 0 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GrowRatio' => [ + 'description' => 'The percentage of each round of scale-out. Valid values: 1 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Uid' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => 'testu****', + ], + 'ClusterId' => [ + 'description' => 'The ID of the associated cluster.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidOpt', + 'errorMessage' => 'The specified operation is invalid. Please try again later. If the problem still exists, submit a ticket.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxNodesInCluster\\": 100,\\n \\"GrowTimeoutInMinutes\\": 20,\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73\\",\\n \\"EnableAutoShrink\\": true,\\n \\"ClusterType\\": \\"slurm\\",\\n \\"EnableAutoGrow\\": true,\\n \\"ExcludeNodes\\": \\"i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****\\",\\n \\"GrowIntervalInMinutes\\": 10,\\n \\"ShrinkIntervalInMinutes\\": 2,\\n \\"SpotPriceLimit\\": \\"0.062\\",\\n \\"ShrinkIdleTimes\\": 3,\\n \\"ExtraNodesGrowRatio\\": 0,\\n \\"GrowRatio\\": 1,\\n \\"Uid\\": \\"testu****\\",\\n \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeAutoScaleConfigResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73</RequestId>\\n <ClusterType>slurm</ClusterType>\\n <Uid>testu****</Uid>\\n <EnableAutoGrow>true</EnableAutoGrow>\\n <EnableAutoShrink>true</EnableAutoShrink>\\n <ExcludeNodes>i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****</ExcludeNodes>\\n <GrowIntervalInMinutes>10</GrowIntervalInMinutes>\\n <ShrinkIntervalInMinutes>2</ShrinkIntervalInMinutes>\\n <ShrinkIdleTimes>3</ShrinkIdleTimes>\\n <GrowTimeoutInMinutes>20</GrowTimeoutInMinutes>\\n <ExtraNodesGrowRatio>0</ExtraNodesGrowRatio>\\n <MaxNodesInCluster>100</MaxNodesInCluster>\\n <GrowRatio>1</GrowRatio>\\n <SpotStrategy>NoSpot</SpotStrategy>\\n <SpotPriceLimit>0</SpotPriceLimit>\\n</DescribeAutoScaleConfigResponse> ","errorExample":""}]', + 'title' => 'DescribeAutoScaleConfig', + 'summary' => 'Queries the auto scaling settings of a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetAutoScaleConfig' => [ + 'summary' => 'Obtains the auto scaling settings of a cluster.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MaxNodesInCluster' => [ + 'description' => 'The interval between two consecutive rounds of scale-in. Unit: minutes. Valid values: 2 to 10.'."\n" + ."\n" + .'> An interval may exist during multiple rounds of a scale-out task or between two consecutive scale-out tasks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'GrowTimeoutInMinutes' => [ + 'description' => 'The maximum hourly price of the compute nodes. The value can be accurate to three decimal places. The parameter takes effect only when SpotStrategy is set to SpotWithPriceLimit.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SpotStrategy' => [ + 'description' => 'The percentage of extra compute nodes. Valid values: 0 to 100.'."\n" + ."\n" + .'If you need to add 100 compute nodes and the value of the ExtraNodesGrowRatio parameter is 2, 102 compute nodes are added.'."\n", + 'type' => 'string', + 'example' => 'SpotWithPriceLimit', + ], + 'EnableAutoShrink' => [ + 'description' => 'The number of consecutive times that a compute node is idle during the resource scale-in check. Valid values: 2 to 5.'."\n" + ."\n" + .'If the parameter is set to 3, a compute node is idle for more than three consecutive times. In this case, the node is released.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The image ID of the compute nodes in the queue.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'EnableAutoGrow' => [ + 'description' => 'The percentage of each round of scale-out. Valid values: 1 to 100.'."\n" + ."\n" + .'If you set GrowRatio to 50, the scale-out has two rounds. Each round completes half of the scale-out.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ClusterType' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'pbs', + ], + 'ExcludeNodes' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => 'i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****', + ], + 'ShrinkIntervalInMinutes' => [ + 'description' => 'The auto scaling configuration of the queue.'."\n" + ."\n" + .'> If auto scaling is enabled for the cluster and queue at the same time, the queue settings prevail.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GrowIntervalInMinutes' => [ + 'description' => 'The image ID of the compute nodes in the queue.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SpotPriceLimit' => [ + 'description' => 'The type of the system disk. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: ultra disk'."\n" + .'* cloud_ssd: SSD'."\n" + .'* cloud_essd: ESSD'."\n" + .'* cloud: basic disk'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.062', + ], + 'ExtraNodesGrowRatio' => [ + 'description' => 'The instance type of the compute nodes that were automatically added in the queue.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ShrinkIdleTimes' => [ + 'description' => 'The suffix of the queue name. You can query queues that have a specified suffix.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ImageId' => [ + 'description' => 'The preemption policy of the compute nodes. Valid values:'."\n" + ."\n" + .'* NoSpot: The compute nodes are pay-as-you-go instances.'."\n" + .'* SpotWithPriceLimit: The compute nodes are preemptible instances that have a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.'."\n", + 'type' => 'string', + 'example' => 'm-bp10txryr4mhrrt1****', + ], + 'GrowRatio' => [ + 'description' => 'The minimum number of compute nodes that can be retained in a queue. Valid values: 0 to 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ClusterId' => [ + 'description' => 'The prefix of the queue name. You can query queues that have a specified prefix.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'Uid' => [ + 'description' => 'The size of the system disk. Unit: GB. Valid values: 40 to 500.'."\n", + 'type' => 'string', + 'example' => '129845258050****', + ], + 'Queues' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'QueueInfo' => [ + 'description' => 'The auto scaling configuration of the queue.'."\n" + ."\n" + .'> If auto scaling is enabled for the cluster and queue at the same time, the queue settings prevail.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'QueueImageId' => [ + 'description' => 'The image ID of the compute node in the queue.'."\n", + 'type' => 'string', + 'example' => 'centos_7_06_64_20G_alibase_2019071****', + ], + 'SystemDiskCategory' => [ + 'description' => 'The category of the system disk. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: enhanced SSD (ESSD).'."\n" + .'* cloud: basic disk.'."\n", + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the compute nodes that are automatically added to the queue.'."\n", + 'type' => 'string', + 'example' => 'ecs.sn1ne.large', + ], + 'HostNameSuffix' => [ + 'description' => 'The suffix of the queue name. You can query queues that have a specified suffix.'."\n", + 'type' => 'string', + 'example' => '000', + ], + 'SpotStrategy' => [ + 'description' => 'The preemption policy of the compute nodes. Valid values:'."\n" + ."\n" + .'* NoSpot: The compute nodes are pay-as-you-go instances.'."\n" + .'* SpotWithPriceLimit: The compute nodes are preemptible instances that have a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'MinNodesInQueue' => [ + 'description' => 'The minimum number of compute nodes that can be retained in a queue. Valid values: 0 to 50.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'HostNamePrefix' => [ + 'description' => 'The prefix of the queue name. You can query queues that have a specified prefix.'."\n", + 'type' => 'string', + 'example' => 'compute', + ], + 'SystemDiskSize' => [ + 'description' => 'The system disk size. Unit: GB. Valid values: 40 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'MaxNodesInQueue' => [ + 'description' => 'The maximum number of compute nodes that can be added to a queue. Valid values: 0 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'EnableAutoShrink' => [ + 'description' => 'Indicates whether the queue enabled the auto scale-in. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'QueueName' => [ + 'description' => 'The name of the queue.'."\n", + 'type' => 'string', + 'example' => 'workq', + ], + 'EnableAutoGrow' => [ + 'description' => 'Indicates whether the queue enabled the auto scale-out. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SystemDiskLevel' => [ + 'description' => 'The performance level of the system disk. Valid values:'."\n" + ."\n" + .'* PL0: An ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: An ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: An ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n", + 'type' => 'string', + 'example' => 'PL1', + ], + 'ResourceGroupId' => [ + 'description' => 'The ID of the resource group to which the compute nodes belong.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmxp7uc24****', + ], + 'SpotPriceLimit' => [ + 'description' => 'The maximum hourly price of the compute nodes. The value can be accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.062', + ], + 'InstanceTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceTypeInfo' => [ + 'description' => 'The specification information of the compute nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HostNamePrefix' => [ + 'description' => 'The prefix of the hostname. You can query compute nodes that have a specified prefix.'."\n", + 'type' => 'string', + 'example' => 'compute', + ], + 'VSwitchId' => [ + 'description' => 'The ID of the vSwitch.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + 'ZoneId' => [ + 'description' => 'The ID of the zone.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'SpotPriceLimit' => [ + 'description' => 'The maximum hourly price of the compute nodes. The value can be accurate to three decimal places. This parameter is valid only when the SpotStrategy parameter is set to SpotWithPriceLimit.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '0.062', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the compute nodes.'."\n", + 'type' => 'string', + 'example' => 'ecs.sn1ne.large', + ], + 'SpotStrategy' => [ + 'description' => 'The bidding method of the compute nodes. Valid values:'."\n" + ."\n" + .'* NoSpot: The compute nodes are pay-as-you-go instances.'."\n" + .'* SpotWithPriceLimit: The compute nodes are preemptible instances that have a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The compute nodes are preemptible instances for which the market price at the time of purchase is used as the bid price.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'SpotDuration' => [ + 'description' => 'The protection period of the preemptible instance. Unit: hours. Valid values: 0 to 1. Default value: 1. A value of 0 means no protection period is specified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SpotInterruptionBehavior' => [ + 'title' => '抢占实例中断模式。目前仅支持Terminate（默认）直接释放实例。'."\n", + 'description' => 'The interruption event of the preemptible instance. The value can only be Terminate, which specifies that the instance is released.'."\n", + 'type' => 'string', + 'example' => 'Terminate', + ], + ], + ], + ], + ], + ], + 'DataDisks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataDisksInfo' => [ + 'description' => 'The list of data disks.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DataDiskCategory' => [ + 'description' => 'The type of the data disk. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: ultra disk.'."\n" + .'* cloud_ssd: standard SSD.'."\n" + .'* cloud_essd: ESSD.'."\n" + .'* cloud: basic disk.'."\n", + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'DataDiskSize' => [ + 'description' => 'The capacity of the data disk. Unit: GB.'."\n" + ."\n" + .'Valid values: 40 to 500.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'DataDiskDeleteWithInstance' => [ + 'description' => 'Indicates whether the data disk is released when the node is released. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DataDiskPerformanceLevel' => [ + 'description' => 'The performance level of the ESSD used as the data disk. The parameter is returned only when the DataDisks.N.DataDiskCategory parameter is set to cloud_essd. Valid values:'."\n" + ."\n" + .'* PL0: An ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1: An ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: An ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: An ESSD can deliver up to 1,000,000 random read/write IOPS.'."\n", + 'type' => 'string', + 'example' => 'PL1', + ], + 'DataDiskEncrypted' => [ + 'description' => 'Indicates whether the data disk is encrypted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'DataDiskKMSKeyId' => [ + 'description' => 'The ID of the KMS key that is used by the data disk.'."\n", + 'type' => 'string', + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40826X', + ], + ], + ], + ], + ], + ], + 'MaxNodesPerCycle' => [ + 'description' => 'The maximum number of compute nodes that can be added in each round of scale-out. Valid values: 0 to 99.'."\n" + ."\n" + .'Default value: 0.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'MinNodesPerCycle' => [ + 'description' => 'The minimum number of compute nodes that can be added in each round of scale-out. Valid values: 1 to 99'."\n" + ."\n" + .'Default value: 1.'."\n" + ."\n" + .'If the compute nodes that you want to add in a round is less than the minimum compute nodes that can be added, the value of this parameter is automatically changed to the number of compute nodes that you want to add. This ensures that compute nodes can be added as expected.'."\n" + ."\n" + .'> The configuration takes effect only for the minimum compute nodes that can be added in the current round.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'AutoMinNodesPerCycle' => [ + 'description' => 'Indicates whether the minimum node number for each scale-out is automatically set. If this parameter is set to true, the minimum number of nodes for each scale-out is equal to the number of nodes required by the job. The maximum number is 99.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'SortedByInventory' => [ + 'description' => 'Indicates whether the instances are unordered. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'> If this parameter is set to true, the system selects instance types in descending order based on the number of instances in stock during auto scaling.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + 'ComputeEnableHt' => [ + 'description' => 'Specifies whether to enable hyper-threading for the ECS instance that is used as the compute node.'."\n" + ."\n" + .'> You can only disable hyper-threading for some instance types. The hyper-threading is enabled for ECS instances by default. For more information, see [Specify and view CPU options](~~145895~~).', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DnsConfig' => [ + 'description' => 'The configurations of DNS.'."\n", + 'type' => 'string', + 'example' => '"{\\"DnsType\\":\\"PrivateZone\\",\\"DnsName\\":\\"xxxxx\\"}"', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidOpt', + 'errorMessage' => 'The specified operation is invalid. Please try again later. If the problem still exists, submit a ticket.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"MaxNodesInCluster\\": 300,\\n \\"GrowTimeoutInMinutes\\": 20,\\n \\"SpotStrategy\\": \\"SpotWithPriceLimit\\",\\n \\"EnableAutoShrink\\": true,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"EnableAutoGrow\\": true,\\n \\"ClusterType\\": \\"pbs\\",\\n \\"ExcludeNodes\\": \\"i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****\\",\\n \\"ShrinkIntervalInMinutes\\": 2,\\n \\"GrowIntervalInMinutes\\": 2,\\n \\"SpotPriceLimit\\": 0.062,\\n \\"ExtraNodesGrowRatio\\": 2,\\n \\"ShrinkIdleTimes\\": 3,\\n \\"ImageId\\": \\"m-bp10txryr4mhrrt1****\\",\\n \\"GrowRatio\\": 100,\\n \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\",\\n \\"Uid\\": \\"129845258050****\\",\\n \\"Queues\\": {\\n \\"QueueInfo\\": [\\n {\\n \\"QueueImageId\\": \\"centos_7_06_64_20G_alibase_2019071****\\",\\n \\"SystemDiskCategory\\": \\"cloud_efficiency\\",\\n \\"InstanceType\\": \\"ecs.sn1ne.large\\",\\n \\"HostNameSuffix\\": \\"000\\",\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"MinNodesInQueue\\": 10,\\n \\"HostNamePrefix\\": \\"compute\\",\\n \\"SystemDiskSize\\": 40,\\n \\"MaxNodesInQueue\\": 100,\\n \\"EnableAutoShrink\\": true,\\n \\"QueueName\\": \\"workq\\",\\n \\"EnableAutoGrow\\": true,\\n \\"SystemDiskLevel\\": \\"PL1\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxp7uc24****\\",\\n \\"SpotPriceLimit\\": 0.062,\\n \\"InstanceTypes\\": {\\n \\"InstanceTypeInfo\\": [\\n {\\n \\"HostNamePrefix\\": \\"compute\\",\\n \\"VSwitchId\\": \\"vsw-bp1lfcjbfb099rrjn****\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"SpotPriceLimit\\": 0.062,\\n \\"InstanceType\\": \\"ecs.sn1ne.large\\",\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"SpotDuration\\": 0,\\n \\"SpotInterruptionBehavior\\": \\"Terminate\\"\\n }\\n ]\\n },\\n \\"DataDisks\\": {\\n \\"DataDisksInfo\\": [\\n {\\n \\"DataDiskCategory\\": \\"cloud_efficiency\\",\\n \\"DataDiskSize\\": 40,\\n \\"DataDiskDeleteWithInstance\\": true,\\n \\"DataDiskPerformanceLevel\\": \\"PL1\\",\\n \\"DataDiskEncrypted\\": false,\\n \\"DataDiskKMSKeyId\\": \\"0e478b7a-4262-4802-b8cb-00d3fb40826X\\"\\n }\\n ]\\n },\\n \\"MaxNodesPerCycle\\": 20,\\n \\"MinNodesPerCycle\\": 5,\\n \\"AutoMinNodesPerCycle\\": false,\\n \\"SortedByInventory\\": false\\n }\\n ]\\n },\\n \\"ComputeEnableHt\\": true,\\n \\"DnsConfig\\": \\"\\\\\\"{\\\\\\\\\\\\\\"DnsType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PrivateZone\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DnsName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxxxx\\\\\\\\\\\\\\"}\\\\\\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAutoScaleConfigResponse>\\n <MaxNodesInCluster>300</MaxNodesInCluster>\\n <GrowTimeoutInMinutes>20</GrowTimeoutInMinutes>\\n <SpotStrategy>SpotWithPriceLimit</SpotStrategy>\\n <EnableAutoShrink>true</EnableAutoShrink>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n <EnableAutoGrow>true</EnableAutoGrow>\\n <ClusterType>pbs</ClusterType>\\n <ExcludeNodes>i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****</ExcludeNodes>\\n <ShrinkIntervalInMinutes>2</ShrinkIntervalInMinutes>\\n <GrowIntervalInMinutes>2</GrowIntervalInMinutes>\\n <SpotPriceLimit>0.062</SpotPriceLimit>\\n <ExtraNodesGrowRatio>2</ExtraNodesGrowRatio>\\n <ShrinkIdleTimes>3</ShrinkIdleTimes>\\n <ImageId>m-bp10txryr4mhrrt1****</ImageId>\\n <GrowRatio>100</GrowRatio>\\n <ClusterId>ehpc-hz-FYUr32****</ClusterId>\\n <Uid>129845258050****</Uid>\\n <Queues>\\n <QueueImageId>centos_7_06_64_20G_alibase_2019071****</QueueImageId>\\n <SystemDiskCategory>cloud_efficiency</SystemDiskCategory>\\n <InstanceType>ecs.sn1ne.large</InstanceType>\\n <HostNameSuffix>000</HostNameSuffix>\\n <SpotStrategy>NoSpot</SpotStrategy>\\n <MinNodesInQueue>10</MinNodesInQueue>\\n <HostNamePrefix>compute</HostNamePrefix>\\n <SystemDiskSize>40</SystemDiskSize>\\n <MaxNodesInQueue>100</MaxNodesInQueue>\\n <EnableAutoShrink>true</EnableAutoShrink>\\n <QueueName>workq</QueueName>\\n <EnableAutoGrow>true</EnableAutoGrow>\\n <SystemDiskLevel>PL1</SystemDiskLevel>\\n <ResourceGroupId>rg-acfmxp7uc24****</ResourceGroupId>\\n <SpotPriceLimit>0.062</SpotPriceLimit>\\n <InstanceTypes>\\n <HostNamePrefix>compute</HostNamePrefix>\\n <VSwitchId>vsw-bp1lfcjbfb099rrjn****</VSwitchId>\\n <ZoneId>cn-hangzhou-b</ZoneId>\\n <SpotPriceLimit>0.062</SpotPriceLimit>\\n <InstanceType>ecs.sn1ne.large</InstanceType>\\n <SpotStrategy>NoSpot</SpotStrategy>\\n </InstanceTypes>\\n <DataDisks>\\n <DataDiskCategory>cloud_efficiency</DataDiskCategory>\\n <DataDiskSize>40</DataDiskSize>\\n <DataDiskDeleteWithInstance>true</DataDiskDeleteWithInstance>\\n <DataDiskPerformanceLevel>PL1</DataDiskPerformanceLevel>\\n <DataDiskEncrypted>false</DataDiskEncrypted>\\n <DataDiskKMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40826X</DataDiskKMSKeyId>\\n </DataDisks>\\n </Queues>\\n</GetAutoScaleConfigResponse>","errorExample":""}]', + 'title' => 'GetAutoScaleConfig', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RunCloudMetricProfiling' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The hostname.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'compute0', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the profiling process.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '29075', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The duration of the profiling process. Unit: seconds.'."\n" + ."\n" + .'Value values: 10 to 300.'."\n" + ."\n" + .'Default value: 30.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + 'default' => '300', + ], + ], + [ + 'name' => 'Freq', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sampling frequency. Unit: Hz. Valid values: 1 to 2000.'."\n" + ."\n" + .'Default value: 2000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2000', + 'default' => '2000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8442AF35-875B-4FC0-8B7AAFDC339335D5', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8442AF35-875B-4FC0-8B7AAFDC339335D5\\"\\n}","errorExample":""},{"type":"xml","example":"<RunCloudMetricProfilingResponse>\\r\\n <RequestId>8442AF35-875B-4FC0-8B7AAFDC339335D5</RequestId>\\r\\n</RunCloudMetricProfilingResponse>","errorExample":""}]', + 'title' => 'RunCloudMetricProfiling', + 'summary' => 'Starts the profiling process of a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetCloudMetricProfiling' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'ProfilingId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The profiling ID. You can call the [ListCloudMetricProfilings](~~188711~~) operation to obtain the profiling ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-i-bplukzqgl****_21687_2019-09-09-02-37-40', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '0DD6F715-85EE-4EA6-BDC4-48A75B719068', + ], + 'SvgUrls' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SvgInfo' => [ + 'description' => 'The list of profiling results.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the SVG file.'."\n", + 'type' => 'string', + 'example' => 'file', + ], + 'Url' => [ + 'description' => 'The URL of the Object Storage Service (OSS) bucket where the scalable vector graphics (SVG) file is stored.'."\n", + 'type' => 'string', + 'example' => 'https://cloudmetrics-****-hz.oss-cn-hangzhou.aliyuncs.com/112****/ehpc-hz-faRavb****njuik%Oxlftyhujmi0Y****', + ], + 'Name' => [ + 'description' => 'The name of the SVG file that contains the profiling results.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-faRavbPf6b_i-bdrftgyh890654****_21687_2019-09-09-02-37-40.bottomup.svg', + ], + 'Size' => [ + 'description' => 'The size of the SVG file. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '648', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 407 => [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0DD6F715-85EE-4EA6-BDC4-48A75B719068\\",\\n \\"SvgUrls\\": {\\n \\"SvgInfo\\": [\\n {\\n \\"Type\\": \\"file\\",\\n \\"Url\\": \\"https://cloudmetrics-****-hz.oss-cn-hangzhou.aliyuncs.com/112****/ehpc-hz-faRavb****njuik%Oxlftyhujmi0Y****\\",\\n \\"Name\\": \\"ehpc-hz-faRavbPf6b_i-bdrftgyh890654****_21687_2019-09-09-02-37-40.bottomup.svg\\",\\n \\"Size\\": 648\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCloudMetricProfilingResponse>\\n <RequestId>0DD6F715-85EE-4EA6-BDC4-48A75B719068</RequestId>\\n <SvgUrls>\\n <SvgInfo>\\n <Name>ehpc-hz-faRavbPf6b_i-bdrftgyh890654****_21687_2019-09-09-02-37-40.svg</Name>\\n <Size>648</Size>\\n <Type>file</Type>\\n <Url>https://cloudmetrics-****-hz.oss-cn-hangzhou.aliyuncs.com/112****/ehpc-hz-faRavb****njuik%Oxlftyhujmi0Y****</Url>\\n </SvgInfo>\\n </SvgUrls>\\n</GetCloudMetricProfilingResponse>","errorExample":""}]', + 'title' => 'GetCloudMetricProfiling', + 'summary' => 'Queries the profiling result of a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListCloudMetricProfilings' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9A05F620-ED46-4A57-95F1-C67D6D3C5DD2', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Profilings' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ProfilingInfo' => [ + 'description' => 'The profiling information of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProfilingId' => [ + 'description' => 'The ID of the profiling process.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-i-bplukzqgl****_21687_2019-09-09-02-37-40', + ], + 'TriggerTime' => [ + 'description' => 'The time when the profiling was triggered.'."\n", + 'type' => 'string', + 'example' => '2019-09-09 02:37:40', + ], + 'Pid' => [ + 'description' => 'The progress ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21687', + ], + 'HostName' => [ + 'description' => 'The name of the host.'."\n", + 'type' => 'string', + 'example' => 'compute5', + ], + 'Duration' => [ + 'description' => 'The duration of the profiling process. Unit: seconds.'."\n" + ."\n" + .'Valid values: 10 to 300.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'InstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'i-bp1j76z8dlukzqgl0****', + ], + 'Freq' => [ + 'description' => 'The frequency of the profiling process. Unit: Hz.'."\n" + ."\n" + .'Valid values: 1 to 2000'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 407 => [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"9A05F620-ED46-4A57-95F1-C67D6D3C5DD2\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Profilings\\": {\\n \\"ProfilingInfo\\": [\\n {\\n \\"ProfilingId\\": \\"ehpc-hz-i-bplukzqgl****_21687_2019-09-09-02-37-40\\",\\n \\"TriggerTime\\": \\"2019-09-09 02:37:40\\",\\n \\"Pid\\": 21687,\\n \\"HostName\\": \\"compute5\\",\\n \\"Duration\\": 30,\\n \\"InstanceId\\": \\"i-bp1j76z8dlukzqgl0****\\",\\n \\"Freq\\": 2000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCloudMetricProfilingsResponse>\\r\\n <PageNumber>1</PageNumber>\\r\\n <TotalCount>1</TotalCount>\\r\\n <PageSize>10</PageSize>\\r\\n <RequestId>9A05F620-ED46-4A57-95F1-C67D6D3C5DD2</RequestId>\\r\\n <Profilings>\\r\\n <ProfilingInfo>\\r\\n <InstanceId>i-bp1j76z8dlukzqgl****</InstanceId>\\r\\n <Duration>30</Duration>\\r\\n <TriggerTime>2019-09-09 02:37:40</TriggerTime>\\r\\n <ProfilingId>ehpc-hz-i-bplukzqgl****_21687_2019-09-09-02-37-40</ProfilingId>\\r\\n <Freq>2000</Freq>\\r\\n <Pid>21687</Pid>\\r\\n <HostName>compute5</HostName>\\r\\n </ProfilingInfo>\\r\\n </Profilings>\\r\\n</ListCloudMetricProfilingsResponse>","errorExample":""}]', + 'title' => 'ListCloudMetricProfilings', + 'summary' => 'Queries the profiling history of a cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetCloudMetricLogs' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. The time is a timestamp. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1583907780', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. The time is a timestamp. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1583907790', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return logs in reverse order of timestamps. Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AggregationType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data aggregation type. Valid values:'."\n" + ."\n" + .'* sum: the sum of the data'."\n" + .'* avg: the average value'."\n" + .'* max: the maximum value'."\n" + .'* min: the minimum value'."\n" + ."\n" + .'Aggregation is disabled by default.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'avg', + ], + ], + [ + 'name' => 'AggregationInterval', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data aggregation interval. Unit: seconds.'."\n" + ."\n" + .'Valid values: 1, 10, 60, 600, and 3600.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MetricScope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The dimensions of the performance metric. Valid values:'."\n" + ."\n" + .'* machine'."\n" + .'* process'."\n" + .'* network'."\n" + .'* disk'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'network', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'description' => 'The filter conditions. A JSON-formatted string that contains several key-value pairs. Valid values of the key:'."\n" + ."\n" + .'* InstanceId: the ID of the node'."\n" + .'* Hostname: the hostname of the node'."\n" + .'* NetworkInterface: the name of the network interface'."\n" + .'* DiskDevice: the name of the disk'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"Hostname":"compute000"}', + ], + ], + [ + 'name' => 'MetricCategories', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the output performance metrics. Separate multiple metrics with commas (,). Valid values:'."\n" + ."\n" + .'* cpu'."\n" + .'* memory'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cpu', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '015C2C4D-1884-4EB7-BCD3-C5BB8D7E56DB', + ], + 'MetricLogs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MetricLog' => [ + 'description' => 'The queried performance metric data.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => 'The timestamp of the log. The time is a timestamp. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1583907780', + ], + 'DiskDevice' => [ + 'description' => 'The name of the disk.'."\n", + 'type' => 'string', + 'example' => 'vda1', + ], + 'NetworkInterface' => [ + 'description' => 'The name of the network interface.'."\n", + 'type' => 'string', + 'example' => 'eth1', + ], + 'MetricData' => [ + 'description' => 'A JSON-formatted serialized string that contains performance metric data of multiple categories.'."\n", + 'type' => 'string', + 'example' => '{\\"process|cpusage\\":0,\\"process|cpuser\\":0,\\"process|cpusys\\":0,******}', + ], + 'Hostname' => [ + 'description' => 'The hostname of the node.'."\n", + 'type' => 'string', + 'example' => 'compute000', + ], + 'InstanceId' => [ + 'description' => 'The node ID.'."\n", + 'type' => 'string', + 'example' => 'i-bp132g97g7zwnvta****', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'SlsError', + 'errorMessage' => 'SLS API request failed.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"015C2C4D-1884-4EB7-BCD3-C5BB8D7E56DB\\",\\n \\"MetricLogs\\": {\\n \\"MetricLog\\": [\\n {\\n \\"Time\\": 1583907780,\\n \\"DiskDevice\\": \\"vda1\\",\\n \\"NetworkInterface\\": \\"eth1\\",\\n \\"MetricData\\": \\"{\\\\\\\\\\\\\\"process|cpusage\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"process|cpuser\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"process|cpusys\\\\\\\\\\\\\\":0,******}\\",\\n \\"Hostname\\": \\"compute000\\",\\n \\"InstanceId\\": \\"i-bp132g97g7zwnvta****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCloudMetricLogsResponse>\\n <RequestId>DD186204-A3D6-533C-B57E-576466E92C92</RequestId>\\n <MetricLogs>\\n <MetricLog>\\n <InstanceId>i-uf69kb5o3mz68wpmvadg</InstanceId>\\n <Hostname>account</Hostname>\\n <Time>1664603931</Time>\\n <MetricData>{\\"process|cpusage\\":0,\\"process|cpuser\\":0,\\"process|cpusys\\":0,\\"process|memusage\\":0,\\"process|procName\\":\\"\\\\\\"edac-poller\\\\\\"\\",\\"process|stat\\":\\"\\\\\\"S\\\\\\"\\",\\"process|pid\\":28,\\"process|vss\\":0,\\"process|rss\\":0,\\"network|recv_rate\\":0.6191,\\"network|sent_rate\\":3.5137,\\"network|max_bw\\":4.1328,\\"disk_usage|max_usage\\":0.1016,\\"disk_usage|total\\":\\"null\\",\\"disk_usage|used\\":\\"null\\",\\"disk_usage|avail\\":\\"null\\",\\"disk_usage|usage\\":\\"null\\",\\"cputil|idle\\":1,\\"cputil|user\\":0,\\"cputil|sys\\":0,\\"cputil|iowait\\":0,\\"cputil|usage\\":0,\\"disk_bw|max_bw\\":0,\\"disk_bw|read\\":\\"null\\",\\"disk_bw|write\\":\\"null\\",\\"memory|memusage\\":0.0612,\\"memory|memcached\\":0.7073,\\"memory|swapusage\\":0}</MetricData>\\n </MetricLog>\\n <MetricLog>\\n <InstanceId>i-uf6bbo03kfnm1ld3st4p</InstanceId>\\n <Hostname>scheduler</Hostname>\\n <Time>1664603931</Time>\\n <MetricData>{\\"process|cpusage\\":0.005,\\"process|cpuser\\":0.005,\\"process|cpusys\\":0,\\"process|memusage\\":0.0113,\\"process|procName\\":\\"\\\\\\"AliYunDun\\\\\\"\\",\\"process|stat\\":\\"\\\\\\"S\\\\\\"\\",\\"process|pid\\":16246,\\"process|vss\\":172457984,\\"process|rss\\":10527,\\"network|recv_rate\\":0.959,\\"network|sent_rate\\":4.3711,\\"network|max_bw\\":5.3301,\\"memory|memusage\\":0.0815,\\"memory|memcached\\":0.7892,\\"memory|swapusage\\":0,\\"cputil|idle\\":0.995,\\"cputil|user\\":0.005,\\"cputil|sys\\":0,\\"cputil|iowait\\":0,\\"cputil|usage\\":0.005,\\"disk_usage|max_usage\\":0.1074,\\"disk_usage|total\\":\\"null\\",\\"disk_usage|used\\":\\"null\\",\\"disk_usage|avail\\":\\"null\\",\\"disk_usage|usage\\":\\"null\\",\\"disk_bw|max_bw\\":0,\\"disk_bw|read\\":\\"null\\",\\"disk_bw|write\\":\\"null\\"}</MetricData>\\n </MetricLog>\\n <MetricLog>\\n <InstanceId>i-uf609tfkmu7wct642ob2</InstanceId>\\n <Hostname>compute000</Hostname>\\n <Time>1664603931</Time>\\n <MetricData>{\\"memory|memusage\\":0.058,\\"memory|memcached\\":0.5132,\\"memory|swapusage\\":0,\\"disk_usage|max_usage\\":0.0918,\\"disk_usage|total\\":\\"null\\",\\"disk_usage|used\\":\\"null\\",\\"disk_usage|avail\\":\\"null\\",\\"disk_usage|usage\\":\\"null\\",\\"process|cpusage\\":0,\\"process|cpuser\\":0,\\"process|cpusys\\":0,\\"process|memusage\\":0,\\"process|procName\\":\\"\\\\\\"watchdogd\\\\\\"\\",\\"process|stat\\":\\"\\\\\\"S\\\\\\"\\",\\"process|pid\\":29,\\"process|vss\\":0,\\"process|rss\\":0,\\"network|recv_rate\\":0.6602,\\"network|sent_rate\\":3.5166,\\"network|max_bw\\":4.1768,\\"cputil|idle\\":1,\\"cputil|user\\":0,\\"cputil|sys\\":0,\\"cputil|iowait\\":0,\\"cputil|usage\\":0,\\"disk_bw|max_bw\\":0,\\"disk_bw|read\\":\\"null\\",\\"disk_bw|write\\":\\"null\\"}</MetricData>\\n </MetricLog>\\n <MetricLog>\\n <InstanceId>i-uf6275hb357f2r0zz8iy</InstanceId>\\n <Hostname>login0</Hostname>\\n <Time>1664603931</Time>\\n <MetricData>{\\"memory|memusage\\":0.2802,\\"memory|memcached\\":0.6,\\"memory|swapusage\\":0,\\"disk_usage|max_usage\\":0.1609,\\"disk_usage|total\\":\\"null\\",\\"disk_usage|used\\":\\"null\\",\\"disk_usage|avail\\":\\"null\\",\\"disk_usage|usage\\":\\"null\\",\\"network|recv_rate\\":0.9404,\\"network|sent_rate\\":5.2568,\\"network|max_bw\\":6.1973,\\"process|cpusage\\":0,\\"process|cpuser\\":0,\\"process|cpusys\\":0,\\"process|memusage\\":0,\\"process|procName\\":\\"\\\\\\"rpciod\\\\\\"\\",\\"process|stat\\":\\"\\\\\\"S\\\\\\"\\",\\"process|pid\\":2590,\\"process|vss\\":0,\\"process|rss\\":0,\\"cputil|idle\\":0.9949,\\"cputil|user\\":0,\\"cputil|sys\\":0.0051,\\"cputil|iowait\\":0,\\"cputil|usage\\":0.0051,\\"disk_bw|max_bw\\":4,\\"disk_bw|read\\":\\"null\\",\\"disk_bw|write\\":\\"null\\"}</MetricData>\\n </MetricLog>\\n </MetricLogs>\\n</GetCloudMetricLogsResponse>","errorExample":""}]', + 'title' => 'GetCloudMetricLogs', + 'summary' => 'Reads performance metrics (CloudMetrics) logs of E-HPC.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetAccountingReport' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '1576922873', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '1577441873', + ], + ], + [ + 'name' => 'ReportType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query type. Valid values:'."\n" + ."\n" + .'* total_report: Queries the number of CPU cores in different dimensions.'."\n" + .'* job_report: Collects the historical node data of a node.'."\n" + .'* number_report: Queries job information in different dimensions.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'job_report', + ], + ], + [ + 'name' => 'FilterValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The actual name of the dimension to be queried. Valid values:'."\n" + ."\n" + .'* If you set the value of the parameter Dim to user, the value of FilterValue is the name of the specified user.'."\n" + .'* If you set the value of the parameter Dim to queue, the value of FilterValue is the name of the specified queue.'."\n" + .'* If you set the value of the parameter Dim to instance, the value of FilterValue is the instance name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'userNo1', + ], + ], + [ + 'name' => 'Dim', + 'in' => 'query', + 'schema' => [ + 'description' => 'The layers at which you want to query the bandwidth and traffic data. Valid values:'."\n" + ."\n" + .'* user: Query by user.'."\n" + .'* queue: Query by queue.'."\n" + .'* instance: Query by instance.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{Id: 1.scheduler}]', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the returned page.'."\n" + ."\n" + .'Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCoreTime' => [ + 'description' => 'The total number of CPU cores in the queried cluster.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '261300', + ], + 'Metrics' => [ + 'description' => 'The list serialized in the JSON format. The list contains the column names of each record in the Data.'."\n", + 'type' => 'string', + 'example' => '[\\"user\\",\\"coreTime\\",\\"usedMem\\"]', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'B1DCB399-9333-4B38-A35A-0BDFABC71881', + ], + 'PageSize' => [ + 'description' => 'The number of entries returned per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Data' => [ + 'description' => 'The list serialized in the JSON format. The list contains multiple records.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[[\\"userNo1\\",49856,7062192],[\\"userNo2\\",29904,4317280]]', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'Cluster.NotSupported', + 'errorMessage' => 'Current cluster does not support this operation.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ObjectNotFound', + 'errorMessage' => 'The specified object is not found.', + ], + [ + 'errorCode' => 'ComputeNotFound', + 'errorMessage' => 'The specified compute node does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'SlsError', + 'errorMessage' => 'SLS API request failed.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'ExecFail', + 'errorMessage' => 'Failed to execute the command: %s.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCoreTime\\": 261300,\\n \\"Metrics\\": \\"[\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"coreTime\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"usedMem\\\\\\\\\\\\\\"]\\",\\n \\"RequestId\\": \\"B1DCB399-9333-4B38-A35A-0BDFABC71881\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 10,\\n \\"Data\\": {\\n \\"Data\\": [\\n \\"[[\\\\\\\\\\\\\\"userNo1\\\\\\\\\\\\\\",49856,7062192],[\\\\\\\\\\\\\\"userNo2\\\\\\\\\\\\\\",29904,4317280]]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAccountingReportResponse>\\n <Metrics>[\\"user\\",\\"coreTime\\",\\"usedMem\\"]</Metrics>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <RequestId>B1DCB399-9333-4B38-A35A-0BDFABC71881</RequestId>\\n <Data>[[\\"userNo1\\",49856,7062192],[\\"userNo2\\",29904,4317280]]</Data>\\n <TotalCoreTime>261300</TotalCoreTime>\\n <TotalCount>10</TotalCount>\\n</GetAccountingReportResponse>","errorExample":""}]', + 'title' => 'GetAccountingReport', + 'summary' => 'Queries the resource report information of a specified cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListClusterLogs' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: 1 to 100.'."\n" + ."\n" + .'Default value: 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BBC2F93D-003A-49C4-850C-B826EECF6667', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'Logs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogInfo' => [ + 'description' => 'The queried operations logs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Operation' => [ + 'description' => 'The type of the operation. Valid values:'."\n" + ."\n" + .'* CreateCluster'."\n" + .'* StartCluster'."\n" + .'* StopCluster'."\n" + .'* DeleteCluster'."\n" + .'* AddNodes'."\n" + .'* StartNodes'."\n" + .'* ResetNodes'."\n" + .'* StopNodes'."\n" + .'* DeleteNodes'."\n", + 'type' => 'string', + 'example' => 'CreateCluster', + ], + 'Message' => [ + 'description' => 'The content of the log.'."\n", + 'type' => 'string', + 'example' => 'Begin to create cluster', + ], + 'CreateTime' => [ + 'description' => 'The time when the log was created.'."\n", + 'type' => 'string', + 'example' => '2019-09-18T13:24:13.000', + ], + 'Level' => [ + 'description' => 'The level of the log entry. Valid values:'."\n" + ."\n" + .'* warn'."\n" + .'* error'."\n" + .'* info', + 'type' => 'string', + 'example' => 'info', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"BBC2F93D-003A-49C4-850C-B826EECF6667\\",\\n \\"TotalCount\\": 2,\\n \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\",\\n \\"Logs\\": {\\n \\"LogInfo\\": [\\n {\\n \\"Operation\\": \\"CreateCluster\\",\\n \\"Message\\": \\"Begin to create cluster\\",\\n \\"CreateTime\\": \\"2019-09-18T13:24:13.000\\",\\n \\"Level\\": \\"info\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListClusterLogsResponse>\\r\\n\\t<PageNumber>1</PageNumber>\\r\\n\\t<Logs>\\r\\n\\t\\t<LogInfo>\\r\\n\\t\\t\\t<Operation>CreateCluster</Operation>\\r\\n\\t\\t\\t<Message>Begin to create cluster</Message>\\r\\n\\t\\t\\t<CreateTime>2019-09-18T13:24:13.000Z</CreateTime>\\r\\n\\t\\t\\t<Level>info</Level>\\r\\n\\t\\t</LogInfo>\\r\\n\\t</Logs>\\r\\n\\t<TotalCount>1</TotalCount>\\r\\n\\t<ClusterId>ehpc-hz-FYUr32****</ClusterId>\\r\\n\\t<PageSize>20</PageSize>\\r\\n\\t<RequestId>BBC2F93D-003A-49C4-850C-B826EECF6667</RequestId>\\r\\n</ListClusterLogsResponse>","errorExample":""}]', + 'title' => 'ListClusterLogs', + 'summary' => 'Queries the operation logs of a cluster within the last three days.', + ], + 'ListCurrentClientVersion' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ClientVersion' => [ + 'description' => 'The latest version number of ehpcutil.'."\n", + 'type' => 'string', + 'example' => '1.1.1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ClientVersion\\": \\"1.1.1\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<ListCurrentClientVersionResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n <ClientVersion>1.0.24</ClientVersion>\\r\\n</ListCurrentClientVersionResponse>","errorExample":""}]', + 'title' => 'ListCurrentClientVersion', + 'summary' => 'Query the latest version number of the cluster client (ehpcutil).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpgradeClient' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version to which you want to update ehpcutil. By default, ehpcutil is updated to the latest version. You can call the [ListCurrentClientVersion](~~87223~~) to query the latest ehpcutil version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2.0.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4994fbcd-2a09-4045-b2b2-2c3bee8e9296', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + [ + 'errorCode' => 'InvalidClientVersion', + 'errorMessage' => 'The client version is invalid.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4994fbcd-2a09-4045-b2b2-2c3bee8e9296\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>4994fbcd-2a09-4045-b2b2-2c3bee8e9296</RequestId>","errorExample":""}]', + 'title' => 'UpgradeClient', + 'summary' => 'Updates the client (ehpcutil) in a cluster to a new version.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListUpgradeClients' => [ + 'summary' => 'Queries the latest version to which the client (ehpcutil) in a cluster can be updated and historical update records of the client.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '89A1AC0F-4A6C-4F3D-98F9-BEF9A823****', + ], + 'LatestVersion' => [ + 'description' => 'The latest version of ehpcutil that is released.'."\n", + 'type' => 'string', + 'example' => '1.2.22', + ], + 'ClientRecords' => [ + 'description' => 'The update records of ehpcutil in the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The upgrade records of the cluster client.'."\n", + 'type' => 'object', + 'properties' => [ + 'SubUid' => [ + 'description' => 'The user ID (UID) whose ehpcutil is updated.'."\n", + 'type' => 'string', + 'example' => '129******84', + ], + 'OldVersion' => [ + 'description' => 'The version of ehpcutil before the update.'."\n", + 'type' => 'string', + 'example' => '1.2.16', + ], + 'NewVersion' => [ + 'description' => 'The version of ehpcutil after the update.'."\n", + 'type' => 'string', + 'example' => '1.2.21', + ], + 'UpdateTime' => [ + 'description' => 'The update time.'."\n", + 'type' => 'string', + 'example' => '2022-08-26T06:26:57.000Z', + ], + ], + ], + ], + 'CurrentVersion' => [ + 'description' => 'The current version of ehpcutil in the cluster.'."\n", + 'type' => 'string', + 'example' => '1.2.21', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"89A1AC0F-4A6C-4F3D-98F9-BEF9A823****\\",\\n \\"LatestVersion\\": \\"1.2.22\\",\\n \\"ClientRecords\\": [\\n {\\n \\"SubUid\\": \\"129******84\\",\\n \\"OldVersion\\": \\"1.2.16\\",\\n \\"NewVersion\\": \\"1.2.21\\",\\n \\"UpdateTime\\": \\"2022-08-26T06:26:57.000Z\\"\\n }\\n ],\\n \\"CurrentVersion\\": \\"1.2.21\\"\\n}","errorExample":""},{"type":"xml","example":"<ListUpgradeClientsResponse>\\n <RequestId>89A1AC0F-4A6C-4F3D-98F9-BEF9A823****</RequestId>\\n <LatestVersion>1.2.22</LatestVersion>\\n <ClientRecords>\\n <SubUid>129******84</SubUid>\\n <OldVersion>1.2.16</OldVersion>\\n <NewVersion>1.2.21</NewVersion>\\n <UpdateTime>2022-08-26T06:26:57.000Z</UpdateTime>\\n </ClientRecords>\\n <CurrentVersion>1.2.21</CurrentVersion>\\n</ListUpgradeClientsResponse>","errorExample":""}]', + 'title' => 'ListUpgradeClients', + ], + 'QueryServicePackAndPrice' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OriginalAmount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3191', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3B2E8108-7068-413E-BCA7-CAAB25D46408', + ], + 'DiscountPrice' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.418', + ], + 'TradePrice' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '2.922', + ], + 'OriginalPrice' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '3.34', + ], + 'ChargeAmount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '167', + ], + 'Currency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'CNY', + ], + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ServicePack' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ServicePackInfo' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1612705988', + ], + 'Capacity' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1610027588', + ], + 'InstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EHPCBAG-cn-78v12vbme0****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 406 => [ + [ + 'errorCode' => 'OrderError', + 'errorMessage' => 'An order request error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"OriginalAmount\\": 3191,\\n \\"RequestId\\": \\"3B2E8108-7068-413E-BCA7-CAAB25D46408\\",\\n \\"DiscountPrice\\": 0.418,\\n \\"TradePrice\\": 2.922,\\n \\"OriginalPrice\\": 3.34,\\n \\"ChargeAmount\\": 167,\\n \\"Currency\\": \\"CNY\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ServicePack\\": {\\n \\"ServicePackInfo\\": [\\n {\\n \\"EndTime\\": 1612705988,\\n \\"Capacity\\": 2000,\\n \\"StartTime\\": 1610027588,\\n \\"InstanceName\\": \\"EHPCBAG-cn-78v12vbme0****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryServicePackAndPriceResponse>\\n <OriginalPrice>3.34</OriginalPrice>\\n <RequestId>3B2E8108-7068-413E-BCA7-CAAB25D46408</RequestId>\\n <DiscountPrice>0.418</DiscountPrice>\\n <Currency>CNY</Currency>\\n <ServicePack>\\n <ServicePackInfo>\\n <InstanceName>EHPCBAG-cn-78v12vbme0****</InstanceName>\\n <EndTime>1612705988</EndTime>\\n <Capacity>2000</Capacity>\\n <StartTime>1610027588</StartTime>\\n </ServicePackInfo>\\n </ServicePack>\\n <RegionId>cn-hangzhou</RegionId>\\n <TradePrice>2.922</TradePrice>\\n <OriginalAmount>3191</OriginalAmount>\\n <ChargeAmount>167</ChargeAmount>\\n</QueryServicePackAndPriceResponse>","errorExample":""}]', + 'title' => 'QueryServicePackAndPrice', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddSecurityGroup' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the E-HPC cluster.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The security group ID of the instance.'."\n" + ."\n" + .'You can call the [DescribeSecurityGroups](~~25556~~) operation to query available security groups in the current region.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sg-bp13n61xsydodfyg****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but make sure that the value is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How do I ensure the idempotence of a request?](~~25693~~)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSecurityGroup', + 'errorMessage' => 'The security group ID is invalid.', + ], + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'SecurityGroupNotSupported', + 'errorMessage' => 'The security group is not supported.', + ], + [ + 'errorCode' => 'SecurityGroupAlreadyExists', + 'errorMessage' => 'The security group already exists.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'ECS api request error', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'Aliyun api service error', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<AddSecurityGroupResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</AddSecurityGroupResponse>","errorExample":""}]', + 'title' => 'AddSecurityGroup', + 'summary' => 'Adds a cluster to a security group.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListSecurityGroups' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of security groups that are assigned to the E-HPC cluster.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '6D9A3378-61CA-4415-BEB0-1168C2A15975', + ], + 'SecurityGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SecurityGroup' => [ + 'description' => 'The security group ID.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the security group to which the instances belong.'."\n", + 'type' => 'string', + 'example' => '["sg-bp13n61xsydodfyg****"]', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'ECS api request error', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'Aliyun api service error', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"6D9A3378-61CA-4415-BEB0-1168C2A15975\\",\\n \\"SecurityGroups\\": {\\n \\"SecurityGroup\\": [\\n \\"[\\\\\\"sg-bp13n61xsydodfyg****\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListSecurityGroupsResponse>\\n <SecurityGroups>\\n <SecurityGroup>sg-bp13n61xsydodfyg****</SecurityGroup>\\n </SecurityGroups>\\n <TotalCount>1</TotalCount>\\n <RequestId>6D9A3378-61CA-4415-BEB0-1168C2A15975</RequestId>\\n</ListSecurityGroupsResponse>","errorExample":""}]', + 'title' => 'ListSecurityGroups', + 'summary' => 'Queries the security groups that are assigned to an E-HPC cluster.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSecurityGroup' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The security group ID of the instance.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sg-bp13n61xsydodfyg****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'SecurityGroupNotSupported', + 'errorMessage' => 'The security group is not supported.', + ], + [ + 'errorCode' => 'InvalidSecurityGroup', + 'errorMessage' => 'The security group ID is invalid.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'ECS api request error', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'Aliyun api service error', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<AddSecurityGroupResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\r\\n</AddSecurityGroupResponse>","errorExample":""}]', + 'title' => 'DeleteSecurityGroup', + 'summary' => 'Removes a cluster from a specified security group.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => 'Creates tags and attach the tags to a specified resource.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => 'The region ID of the resource.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'The resource type. Set the value to cluster, which indicates E-HPC clusters.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => 'The resource IDs. You can specify up to 50 resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource IDs. You can specify up to 50 resource IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-xxxx', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => 'The resource tags. You can specify up to 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource tags. You can specify up to 20 tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => 'The tag key. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => 'The tag value. The tag value cannot be an empty string. It can be up to 128 characters in length and cannot contain `http://` or `https://`. It cannot start with `acs:` or `aliyun`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'Duplicate.TagKey', + 'errorMessage' => 'The Tag.N.Key contain duplicate key.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'TagError', + 'errorMessage' => 'TAG API request failed.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => 'TagResources', + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags that are attached to a specified resource.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => 'The region ID of the resource.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '下一个查询开始Token', + 'description' => 'The token used to start the next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0axxxx', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => 'The resource type. Set the value to cluster, which indicates E-HPC clusters.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => 'The resource IDs. You can specify up to 50 IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource IDs. You can specify up to 50 IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-xxxx', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => 'The resource tags. You can specify up to 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource tags. You can specify up to 20 tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => 'The token that is required for the next query. If the NextToken parameter is empty, no subsequent query is available.'."\n", + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0axxxx', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '484256DA-D816-44D2-9D86-B6EE4D5BA78C', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'title' => '资源列表', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => 'The type of the resource whose tags are queried. Set the value to cluster, which indicates E-HPC clusters.'."\n", + 'type' => 'string', + 'example' => 'cluster', + ], + 'TagValue' => [ + 'title' => '标签值', + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'TestValue', + ], + 'ResourceId' => [ + 'title' => '资源ID', + 'description' => 'The resource ID. Set the value to the ID of the cluster.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-xxxx', + ], + 'TagKey' => [ + 'title' => '标签键', + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'TestKey', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'TagError', + 'errorMessage' => 'TAG API request failed.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0axxxx\\",\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5BA78C\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"cluster\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"ehpc-hz-xxxx\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0axxxx</NextToken>\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\n <TagResources>\\n <ResourceType>cluster</ResourceType>\\n <TagValue>TestValue</TagValue>\\n <ResourceId>ehpc-hz-xxxx</ResourceId>\\n <TagKey>TestKey</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => 'ListTagResources', + ], + 'UnTagResources' => [ + 'summary' => 'Removes tags from a specified resource.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource from which you want to remove tags. Set the value to cluster, which indicates E-HPC clusters.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The resource IDs. You can specify up to 50 resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource IDs. You can specify up to 50 resource IDs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-xxxx', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tag key of the resource. You can specify up to 20 tag keys.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to remove all tags from the resource. This parameter is valid only when the TagKey.N parameter is not specified. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'TagError', + 'errorMessage' => 'TAG API request failed.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"<UnTagResourcesResponse>\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>\\n</UnTagResourcesResponse>","errorExample":""}]', + 'title' => 'UnTagResources', + ], + 'ListRegions' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionInfo' => [ + 'description' => 'The list of regions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The array of regions.', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => 'The name of the region.'."\n", + 'type' => 'string', + 'example' => 'China East 1 (Hangzhou)', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 406 => [ + [ + 'errorCode' => 'OrderError', + 'errorMessage' => 'An order request error occurred.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Regions\\": {\\n \\"RegionInfo\\": [\\n {\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListRegionsResponse>\\n <Regions>\\n <RegionInfo>\\n <RegionId>cn-hangzhou</RegionId>\\n <LocalName>华东 1 (杭州)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>cn-beijing</RegionId>\\n <LocalName>华北 2 (北京)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>cn-shanghai</RegionId>\\n <LocalName>华东 2 (上海)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>cn-shenzhen</RegionId>\\n <LocalName>华南 1 (深圳)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>cn-qingdao</RegionId>\\n <LocalName>华北 1 (青岛)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>cn-zhangjiakou</RegionId>\\n <LocalName>华北 3 (张家口)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>cn-huhehaote</RegionId>\\n <LocalName>华北 5 (呼和浩特)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>ap-southeast-1</RegionId>\\n <LocalName>亚太东南 1 (新加坡)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>cn-hongkong</RegionId>\\n <LocalName>中国 (香港)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>eu-central-1</RegionId>\\n <LocalName>欧洲中部 1 (法兰克福)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>ap-southeast-2</RegionId>\\n <LocalName>亚太东南 2 (悉尼)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>ap-northeast-1</RegionId>\\n <LocalName>亚太东北 1 (东京)</LocalName>\\n </RegionInfo>\\n <RegionInfo>\\n <RegionId>cn-wulanchabu</RegionId>\\n <LocalName>华北 6（乌兰察布）</LocalName>\\n </RegionInfo>\\n </Regions>\\n</ListRegionsResponse>","errorExample":""}]', + 'title' => 'ListRegions', + 'summary' => 'Queries a list of regions where Elastic High Performance Computing (E-HPC) is supported.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTasks' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Valid values: 1 to 999.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '999', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task ID. You can call the following asynchronous API operations to obtain the task ID.'."\n" + ."\n" + .'* [CreateCluster](~~87100~~)'."\n" + .'* [StartCluster](~~200345~~)'."\n" + .'* [StopCluster](~~200346~~)'."\n" + .'* [DeleteCluster](~~87110~~)'."\n" + .'* [AddNodes](~~87147~~)'."\n" + .'* [StartNodes](~~87159~~)'."\n" + .'* [ResetNodes](~~87158~~)'."\n" + .'* [StopNodes](~~87160~~)'."\n" + .'* [DeleteNodes](~~87155~~)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + ], + [ + 'name' => 'Archived', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to display the response history of the asynchronous API operation. Valid values:'."\n" + ."\n" + .'* true: displays the current response and response history of the asynchronous API operation.'."\n" + .'* false: displays only the current response of the asynchronous API operation. If no tasks are running, `[]` is returned.'."\n" + ."\n" + .'Default value: false.'."\n" + ."\n" + .'> If you specify the TaskId parameter, the Archived parameter is invalid.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '89A1AC0F-4A6C-4F3D-98F9-BEF9A823****', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Tasks' => [ + 'description' => 'The queried tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* Processing: The task is running.'."\n" + .'* Success: The task succeeded.'."\n" + .'* Failed: The task failed.'."\n" + .'* PartialFail: The task partially failed.'."\n", + 'type' => 'string', + 'example' => 'Processing', + ], + 'TaskType' => [ + 'description' => 'The task type. Valid values:'."\n" + ."\n" + .'* CreateCluster: creates a cluster by calling the [CreateCluster](~~87100~~) operation.'."\n" + .'* StartCluster: starts a cluster by calling the [StartCluster](~~200345~~) operation.'."\n" + .'* StopCluster: stops a cluster by calling the [StopCluster](~~200346~~) operation.'."\n" + .'* DeleteCluster: releases a cluster by calling the [DeleteCluster](~~87110~~) operation.'."\n" + .'* AddComputes: adds nodes to a cluster by calling the [AddNodes](~~87147~~) operation.'."\n" + .'* StartComputes: starts nodes by calling the [StartNodes](~~87159~~) operation.'."\n" + .'* ResetCompute: resets nodes by calling the [ResetNodes](~~87158~~) operation.'."\n" + .'* StopComputes: stops nodes by calling the [StopNodes](~~87160~~) operation.'."\n" + .'* DeleteComputes: deletes nodes by calling the [DeleteNodes](~~87155~~) operation.'."\n", + 'type' => 'string', + 'example' => 'StopCluster', + ], + 'TotalSteps' => [ + 'description' => 'The total number of steps of the task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '35', + ], + 'CurrentStep' => [ + 'description' => 'The current step of the task.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'Result' => [ + 'description' => 'The result of the task. Valid values:'."\n" + ."\n" + .'* If you set TaskType to CreateCluster or AddComputes, the value of this parameter is in the `{\\"Instances\\":[]}` format. The value indicates the information about the nodes that are added to the cluster.'."\n" + .'* If you set TaskType to a value other than CreateCluster and AddComputes, the value of this parameter is in the `{}` format.'."\n", + 'type' => 'string', + 'example' => '{\\"Instances\\":[{\\"InstanceId\\":\\"i-bp1inb1j2xz8pnoi****\\",\\"Ip\\":\\"192.168.*.*\\",\\"Hostname\\":\\"login0\\",\\"role\\":\\"login\\"}]}', + ], + 'Errors' => [ + 'description' => 'The error messages returned for the task.'."\n" + ."\n" + .'You can view the error messages and the corresponding solutions in the [Error Center](https://error-center.alibabacloud.com/status/product/EHPC).'."\n", + 'type' => 'string', + 'example' => '[]', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'Request' => [ + 'description' => 'The request parameters of the task. The value is a JSON string.'."\n", + 'type' => 'string', + 'example' => '{\\"requestId\\":\\"0A6CA33E-BFBF-4F92-BDAE-4E8860DA****\\",\\"uid\\":\\"160998252992****\\",\\"bid\\":\\"268**\\",\\"clusterId\\":\\"ehpc-hz-ysQtcZ****\\"}', + ], + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'RedisError', + 'errorMessage' => 'A Redis service error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"89A1AC0F-4A6C-4F3D-98F9-BEF9A823****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 10,\\n \\"Tasks\\": [\\n {\\n \\"Status\\": \\"Processing\\",\\n \\"TaskType\\": \\"StopCluster\\",\\n \\"TotalSteps\\": 35,\\n \\"CurrentStep\\": 16,\\n \\"Result\\": \\"{\\\\\\\\\\\\\\"Instances\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"InstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"i-bp1inb1j2xz8pnoi****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"192.168.*.*\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Hostname\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"login0\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"login\\\\\\\\\\\\\\"}]}\\",\\n \\"Errors\\": \\"[]\\",\\n \\"TaskId\\": \\"B745C159-3155-4B94-95D0-4B73D4D2****\\",\\n \\"Request\\": \\"{\\\\\\\\\\\\\\"requestId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0A6CA33E-BFBF-4F92-BDAE-4E8860DA****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"uid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"160998252992****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bid\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"268**\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"clusterId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ehpc-hz-ysQtcZ****\\\\\\\\\\\\\\"}\\",\\n \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTasksResponse>\\n<TotalCount>10</TotalCount>\\n<Tasks>\\n <Status>Processing</Status>\\n <Errors>[]</Errors>\\n <TaskId>B745C159-3155-4B94-95D0-4B73D4D2****</TaskId>\\n <ClusterId>ehpc-hz-FYUr32****</ClusterId>\\n <TaskType>StopCluster</TaskType>\\n <Request>{\\\\\\"requestId\\\\\\":\\\\\\"0A6CA33E-BFBF-4F92-BDAE-4E8860DA****\\\\\\",\\\\\\"uid\\\\\\":\\\\\\"160998252992****\\\\\\",\\\\\\"bid\\\\\\":\\\\\\"268**\\\\\\",\\\\\\"clusterId\\\\\\":\\\\\\"ehpc-hz-ysQtcZ****\\\\\\"}</Request>\\n <CurrentStep>16</CurrentStep>\\n <TotalSteps>35</TotalSteps>\\n <Result>{\\\\\\"Instances\\\\\\":[{\\\\\\"InstanceId\\\\\\":\\\\\\"i-bp1inb1j2xz8pnoi****\\\\\\",\\\\\\"Ip\\\\\\":\\\\\\"192.168.*.*\\\\\\",\\\\\\"Hostname\\\\\\":\\\\\\"login0\\\\\\",\\\\\\"role\\\\\\":\\\\\\"login\\\\\\"}]}</Result>\\n</Tasks>\\n<PageSize>10</PageSize>\\n<RequestId>89A1AC0F-4A6C-4F3D-98F9-BEF9A823****</RequestId>\\n<PageNumber>1</PageNumber>\\n</ListTasksResponse>","errorExample":""}]', + 'title' => 'ListTasks', + 'summary' => 'Queries the response of an asynchronous API operation for a cluster.', + 'description' => 'For some asynchronous API operations such as AddNodes, the system immediately returns a result without waiting for the node to be created if the request succeeds. In this case, you can use the TaskId returned by the asynchronous API operation to query the result of the task.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InitializeEHPC' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the service-linked role is created.'."\n" + ."\n" + .'You can call the [ListRegions](~~188593~~) operation to obtain the IDs of regions supported by E-HPC.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the service for which you must create a service-linked role. Valid values:'."\n" + ."\n" + .'* E-HPC: You must create the AliyunServiceRoleForEHPC service-linked role.'."\n" + .'* E-HPC Instant: You must create the AliyunServiceRoleForEHPCManagedNetwork service-linked role.'."\n" + ."\n" + .'> This parameter is not publicly available.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'E-HPC', + 'enum' => [ + 'E-HPC', + 'E-HPC Instant', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'EntityAlreadyExists.RoleError', + 'errorMessage' => 'AliyunServiceRoleForEHPC already exists.', + ], + ], + [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","errorExample":""},{"type":"xml","example":"<InitializeEHPCResponse>\\r\\n <RequestId>04F0F334-1335-436C-A1D7-6C044FE7****</RequestId>\\r\\n </InitializeEHPCResponse> ","errorExample":""}]', + 'title' => 'InitializeEHPC', + 'summary' => 'Creates a service-linked role for Elastic High Performance Computing (E-HPC). A service-linked role is required for you to use E-HPC.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'ehpc.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'ehpc.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'ehpc.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'ehpc.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'ehpc.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'ehpc.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'ehpc.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'ehpc.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'ehpc.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'ehpc.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'ehpc.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'ehpc.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'ehpc.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'ehpc.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ehpc.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'ehpc.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'ehpc.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'ehpc.eu-central-1.aliyuncs.com', + ], + ], +]; |