diff options
Diffstat (limited to 'data/zh_cn/ehpc')
| -rw-r--r-- | data/zh_cn/ehpc/2018-04-12/api-docs.php | 27304 | ||||
| -rw-r--r-- | data/zh_cn/ehpc/2024-07-30/api-docs.php | 10728 |
2 files changed, 38032 insertions, 0 deletions
diff --git a/data/zh_cn/ehpc/2018-04-12/api-docs.php b/data/zh_cn/ehpc/2018-04-12/api-docs.php new file mode 100644 index 0000000..a94ddb6 --- /dev/null +++ b/data/zh_cn/ehpc/2018-04-12/api-docs.php @@ -0,0 +1,27304 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'EHPC', + 'version' => '2018-04-12', + ], + 'directories' => [ + [ + 'id' => 181976, + 'title' => '集群', + 'type' => 'directory', + 'children' => [ + 'DescribePrice', + 'CreateCluster', + 'DescribeCluster', + 'ModifyClusterAttributes', + 'ListClusters', + 'ListClustersMeta', + 'StartCluster', + 'StopCluster', + 'RecoverCluster', + 'DeleteCluster', + ], + ], + [ + 'id' => 181434, + 'title' => '混合云集群', + 'type' => 'directory', + 'children' => [ + 'CreateHybridCluster', + 'AddLocalNodes', + 'GetHybridClusterConfig', + 'SyncUsers', + ], + ], + [ + 'id' => 181509, + 'title' => 'ECS实例', + 'type' => 'directory', + 'children' => [ + 'ListPreferredEcsTypes', + 'ListAvailableEcsTypes', + 'GetIfEcsTypeSupportHtConfig', + ], + ], + [ + 'id' => 62742, + 'title' => '镜像', + 'type' => 'directory', + 'children' => [ + 'ListImages', + 'ListCustomImages', + 'ListCommunityImages', + 'DescribeImagePrice', + ], + ], + [ + 'id' => 62758, + 'title' => '用户', + 'type' => 'directory', + 'children' => [ + 'AddUsers', + 'ListUsers', + 'ListUsersAsync', + 'ModifyUserGroups', + 'ModifyUserPasswords', + 'DeleteUsers', + ], + ], + [ + 'id' => 62714, + 'title' => '节点', + 'type' => 'directory', + 'children' => [ + 'AddNodes', + 'ApplyNodes', + 'AddExistedNodes', + 'ListNodes', + 'ListNodesNoPaging', + 'StartNodes', + 'StopNodes', + 'ResetNodes', + 'DeleteNodes', + ], + ], + [ + 'id' => 181435, + 'title' => '队列', + 'type' => 'directory', + 'children' => [ + 'AddQueue', + 'ListQueues', + 'UpdateQueueConfig', + 'ListNodesByQueue', + 'SetQueue', + 'DeleteQueue', + ], + ], + [ + 'id' => 181510, + 'title' => '调度器', + 'type' => 'directory', + 'children' => [ + 'SetSchedulerInfo', + 'GetSchedulerInfo', + ], + ], + [ + 'id' => 181437, + 'title' => '软件', + 'type' => 'directory', + 'children' => [ + 'ListSoftwares', + 'InstallSoftware', + 'ListInstalledSoftware', + 'UninstallSoftware', + ], + ], + [ + 'id' => 62709, + 'title' => '存储', + 'type' => 'directory', + 'children' => [ + 'ListFileSystemWithMountTargets', + 'ListCpfsFileSystems', + 'GetClusterVolumes', + 'ListVolumes', + 'UpdateClusterVolumes', + ], + ], + [ + 'id' => 62693, + 'title' => '作业', + 'type' => 'directory', + 'children' => [ + 'SubmitJob', + 'CreateJobFile', + 'ListJobs', + 'DescribeJob', + 'ListJobsWithFilters', + 'RerunJobs', + 'StopJobs', + 'GetJobLog', + 'DeleteJobs', + ], + ], + [ + 'id' => 190861, + 'title' => 'Serverless作业', + 'type' => 'directory', + 'children' => [ + 'SubmitServerlessJob', + 'ListServerlessJobs', + 'DescribeServerlessJobs', + 'StopServerlessJobs', + ], + ], + [ + 'id' => 62769, + 'title' => '作业模板', + 'type' => 'directory', + 'children' => [ + 'CreateJobTemplate', + 'ListJobTemplates', + 'EditJobTemplate', + 'DeleteJobTemplates', + ], + ], + [ + 'id' => 62737, + 'title' => '交互命令', + 'type' => 'directory', + 'children' => [ + 'InvokeShellCommand', + 'ListCommands', + 'ListInvocationResults', + 'ListInvocationStatus', + ], + ], + [ + 'id' => 181511, + 'title' => '后处理脚本', + 'type' => 'directory', + 'children' => [ + 'SetPostScripts', + 'GetPostScripts', + ], + ], + [ + 'id' => 62731, + 'title' => 'VNC', + 'type' => 'directory', + 'children' => [ + 'GetVisualServiceStatus', + 'ModifyVisualServicePasswd', + 'StartVisualService', + 'StopVisualService', + ], + ], + [ + 'id' => 62705, + 'title' => '自动伸缩', + 'type' => 'directory', + 'children' => [ + 'SetAutoScaleConfig', + 'DescribeAutoScaleConfig', + 'GetAutoScaleConfig', + ], + ], + [ + 'id' => 181439, + 'title' => '性能管理', + 'type' => 'directory', + 'children' => [ + 'RunCloudMetricProfiling', + 'GetCloudMetricProfiling', + 'ListCloudMetricProfilings', + 'GetCloudMetricLogs', + ], + ], + [ + 'id' => 62772, + 'title' => '报表', + 'type' => 'directory', + 'children' => [ + 'GetAccountingReport', + ], + ], + [ + 'id' => 62728, + 'title' => '操作日志', + 'type' => 'directory', + 'children' => [ + 'ListClusterLogs', + ], + ], + [ + 'id' => 181438, + 'title' => '集群客户端', + 'type' => 'directory', + 'children' => [ + 'ListCurrentClientVersion', + 'UpgradeClient', + 'ListUpgradeClients', + ], + ], + [ + 'id' => 62726, + 'title' => '服务包', + 'type' => 'directory', + 'children' => [ + 'QueryServicePackAndPrice', + ], + ], + [ + 'id' => 62754, + 'title' => '安全组', + 'type' => 'directory', + 'children' => [ + 'AddSecurityGroup', + 'ListSecurityGroups', + 'DeleteSecurityGroup', + ], + ], + [ + 'id' => 181515, + 'title' => '标签', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'ListTagResources', + 'UnTagResources', + ], + ], + [ + 'id' => 62673, + 'title' => '地域', + 'type' => 'directory', + 'children' => [ + 'ListRegions', + ], + ], + [ + 'id' => 181440, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'ListTasks', + 'InitializeEHPC', + ], + ], + [ + 'id' => 203958, + 'title' => '废弃', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 181436, + 'title' => '高性能容器应用', + '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' => 'ECS实例的计费周期单位。仅当ChargeType=PrePaid时该参数有效。取值范围：'."\n" + ."\n" + .'<props="china">'."\n" + .'- Month：按月计费'."\n" + .'- Year：按年计费'."\n" + .'- Hour：按小时计费'."\n" + .'- Week：按周计费'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + .'- Month：按月计费'."\n" + .'- Year：按年计费'."\n" + .'- Hour：按小时计费'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'默认值：Hour'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Hour', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群节点ECS实例的计费方式。取值范围：'."\n" + .'- PostPaid：按量付费'."\n" + .'- PrePaid：包年包月'."\n" + ."\n" + .'默认值：PostPaid', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型，仅支持设置为商品购买。取值：INSTANCE-BUY', + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCE-BUY', + ], + ], + [ + 'name' => 'Commodities', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '商品列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Amount' => [ + 'description' => '第N个该类型节点的数量。取值范围：1~1000'."\n" + ."\n" + .'默认值：1'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '2', + ], + 'SystemDiskSize' => [ + 'description' => '第N个该节点的系统盘大小。单位：GB'."\n" + ."\n" + .'取值范围：40~500'."\n" + ."\n" + .'默认值：40'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + 'SystemDiskPerformanceLevel' => [ + 'description' => '第N个该节点的系统盘类型为ESSD云盘时，区分性能等级。仅当Commodities.N.SystemDiskCategory=cloud_essd时该参数有效。取值范围：'."\n" + .'- PL0：单盘最高随机读写IOPS 1万'."\n" + .'- PL1：单盘最高随机读写IOPS 5万'."\n" + .'- PL2：单盘最高随机读写IOPS 10万'."\n" + .'- PL3：单盘最高随机读写IOPS 100万'."\n" + ."\n" + .'默认值：PL1'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'NodeType' => [ + 'description' => '第N个节点类型。取值范围：'."\n" + .'- Compute：计算节点'."\n" + .'- Manager：管控节点'."\n" + .'- Login：登录节点'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'string', + 'required' => true, + 'example' => 'Compute', + ], + 'SystemDiskCategory' => [ + 'description' => '第N个该节点的系统盘类型。可能值：'."\n" + .'- cloud_efficiency：高效云盘'."\n" + .'- cloud_ssd：SSD云盘'."\n" + .'- cloud_essd：ESSD云盘'."\n" + .'- cloud：普通云盘'."\n" + ."\n" + .'默认值：cloud_efficiency'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + 'InternetChargeType' => [ + 'description' => '第N个该节点的公网付费方式。取值范围：'."\n" + ."\n" + .'- PayByBandwidth：按固定带宽收费'."\n" + .'- PayByTraffic：按流量计费'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'string', + 'required' => false, + 'example' => 'PayByBandwidth', + ], + 'NetworkType' => [ + 'description' => '第N个该节点的网络类型，仅支持设置为专有网络VPC。取值：VPC'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + 'InstanceType' => [ + 'description' => '第N个该节点的ECS实例规格。'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs.n1.tiny', + ], + 'Period' => [ + 'description' => '第N个该节点的ECS实例的计费时长。取值范围：'."\n" + ."\n" + .'<props="china">'."\n" + .'- 当参数PriceUnit取值为Year时：1~3'."\n" + .'- 当参数PriceUnit取值为Month时：1~9'."\n" + .'- 当参数PriceUnit取值为Hour时：1'."\n" + .'- 当参数PriceUnit取值为Week时：1~4'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + .'- 当参数PriceUnit取值为Year时：1~3'."\n" + .'- 当参数PriceUnit取值为Month时：1~9'."\n" + .'- 当参数PriceUnit取值为Hour时：1'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'默认值：1'."\n" + ."\n" + .'N的取值范围：1~10'."\n" + ."\n\n" + ."\n\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + 'InternetMaxBandWidthOut' => [ + 'description' => '第N个该节点公网出带宽最大值。单位为Mbit/s。'."\n" + ."\n" + .'取值范围：0~100'."\n" + ."\n" + .'默认值：0'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + 'DataDisks' => [ + 'description' => '随节点创建的数据盘信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'size' => [ + 'description' => '第N个随节点创建的数据盘容量大小。单位：GB'."\n" + ."\n" + .'取值范围：40~500'."\n" + ."\n" + .'默认值：40'."\n" + ."\n" + .'N的取值范围：0~4', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + 'category' => [ + 'description' => '第N个随节点创建的数据盘类型。可能值：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘'."\n" + ."\n" + .'- cloud_ssd：SSD云盘'."\n" + ."\n" + .'- cloud_essd：ESSD云盘'."\n" + ."\n" + .'- cloud：普通云盘'."\n" + ."\n" + .'默认值：cloud_efficiency'."\n" + ."\n" + .'N的取值范围：0~4', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_efficiency', + ], + 'deleteWithInstance' => [ + 'description' => '第N个随节点创建的数据盘是否随实例释放。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'默认值：true'."\n" + ."\n" + .'N的取值范围：0~4', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'performanceLevel' => [ + 'description' => '第N个随节点创建的数据盘类型为ESSD云盘时，区分性能等级。仅当Commodities.N.DataDisks.N.category=cloud_essd时该参数有效。取值范围：'."\n" + .'- PL0：单盘最高随机读写IOPS 1万'."\n" + .'- PL1：单盘最高随机读写IOPS 5万'."\n" + .'- PL2：单盘最高随机读写IOPS 10万'."\n" + .'- PL3：单盘最高随机读写IOPS 100万'."\n" + ."\n" + .'默认值：PL1'."\n" + ."\n" + .'N的取值范围：0~4', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'encrypted' => [ + 'description' => '第N个随节点创建的数据盘是否加密。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'默认值：false'."\n" + ."\n" + .'N的取值范围：0~4', + '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' => '总价格。'."\n" + ."\n" + .'<props="china">单位：元</props>'."\n" + ."\n" + .'<props="intl">单位：美元</props>', + 'type' => 'number', + 'format' => 'float', + 'example' => '1258', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '54FF9025-2C2F-42EB-870D-0DF5B0ACF24E', + ], + 'Prices' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PriceInfo' => [ + 'description' => '集群价格列表。当请求参数查询集群的多个节点配置价格时，返回值PriceInfo内多个元素的顺序与请求参数设置的多个节点信息的顺序依次对应。例如，请求参数中N=1的节点信息，对应的返回值为PriceInfo内的第一个元素。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OriginalPrice' => [ + 'description' => '原价。'."\n" + ."\n" + .'<props="china">单位：元</props>'."\n" + ."\n" + .'<props="intl">单位：美元</props>', + 'type' => 'number', + 'format' => 'float', + 'example' => '1258', + ], + 'NodeType' => [ + 'description' => '节点类型。可能值：'."\n" + .'- Manager：管控节点'."\n" + .'- Login：登录节点'."\n" + .'- Compute：计算节点', + 'type' => 'string', + 'example' => 'Compute', + ], + 'Currency' => [ + 'description' => '货币单位。可能值：'."\n" + ."\n" + .'<props="china">CNY：人民币</props>'."\n" + ."\n" + .'<props="intl">USD：美元</props>', + 'type' => 'string', + 'example' => '<props="china">CNY</props>'."\n" + ."\n" + .'<props="intl">USD</props>', + ], + 'TradePrice' => [ + 'description' => '成交价。'."\n" + ."\n" + .'<props="china">单位：元</props>'."\n" + ."\n" + .'<props="intl">单位：美元</props>', + 'type' => 'number', + 'format' => 'float', + 'example' => '1258', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群配置价格', + 'summary' => '查询集群价格配置信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateCluster' => [ + 'summary' => '创建一个按量付费或者预付费（包年包月）集群。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。'."\n" + ."\n" + .'您可以调用[ListRegions](~~188593~~)和[DescribeZones](~~25610~~)接口获取可以使用E-HPC的可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称，长度为2~64个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述信息。长度为2~256个英文或中文字符，不能以`http://`和`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestDescription', + ], + ], + [ + 'name' => 'EhpcVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'E-HPC产品版本，默认为最新版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '集群客户端版本，默认为最新版本。'."\n" + ."\n" + .'您可以调用[ListCurrentClientVersion](~~87223~~)查询当前最新客户端版本号。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.64', + ], + ], + [ + 'name' => 'OsTag', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统镜像标签。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '域账号服务类型。取值范围：'."\n" + .'- nis'."\n" + .'- ldap'."\n" + ."\n" + .'默认值：nis。', + 'type' => 'string', + 'required' => false, + 'example' => 'nis', + 'default' => 'nis', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '本地集群域名。'."\n" + ."\n" + .'仅当AccoutType取值为Idap时，支持配置该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ldap', + ], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'query', + 'schema' => [ + 'description' => '调度器类型。取值范围：'."\n" + .'- pbs'."\n" + .'- slurm'."\n" + .'- opengridscheduler'."\n" + .'- deadline'."\n" + ."\n" + .'默认值：pbs。', + 'type' => 'string', + 'required' => false, + 'example' => 'pbs', + 'default' => 'pbs', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定新创建集群所属的安全组ID。'."\n" + ."\n" + .'您可以调用[DescribeSecurityGroups](~~25556~~)查询当前地域可以使用的安全组。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp13n61xsydodfyg****', + ], + ], + [ + 'name' => 'SecurityGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '如果不使用已有安全组，则使用此名称创建新安全组，应用默认安全组策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-SecurityGroup', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所属的VPC ID。'."\n" + ."\n" + .'您可以调用[DescribeVpcs](~~35739~~)查询已创建的VPC信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-b3f3edefefeep0760yju****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'VPC中交换机ID。E-HPC当前仅支持VPC网络。'."\n" + ."\n" + .'您可以调用[DescribeVSwitches](~~35748~~)查询已创建的交换机的相关信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + ], + [ + 'name' => 'VolumeType', + 'in' => 'query', + 'schema' => [ + 'description' => '共享存储类型，目前仅支持配置为`nas`，表示NAS文件系统。', + 'type' => 'string', + 'required' => false, + 'example' => 'nas', + 'default' => 'nas', + ], + ], + [ + 'name' => 'VolumeId', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云NAS实例ID。如果该参数为空，创建集群的流程会默认创建一个性能型的NAS实例。'."\n" + ."\n" + .'您可以调用[ListFileSystemWithMountTargets](~~204364~~)查询可用的NAS的VPC挂载点。', + 'type' => 'string', + 'required' => false, + 'example' => '008b64****', + ], + ], + [ + 'name' => 'VolumeProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '共享存储的协议类型。取值范围：'."\n" + .'- NFS'."\n" + .'- SMB'."\n" + ."\n" + .'默认值：NFS。', + 'type' => 'string', + 'required' => false, + 'example' => 'NFS', + 'default' => 'nfs', + ], + ], + [ + 'name' => 'VolumeMountpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAS的VPC挂载点。VolumeMountpoint有以下限制：'."\n" + ."\n" + .'- 如果VolumeId参数为空，VolumeMountpoint可以为空，创建集群的流程会默认创建一个VPC挂载点。'."\n" + .'- 如果VolumeId参数不为空，VolumeMountpoint为必填，您可以调用[ListFileSystemWithMountTargets](~~204364~~)查询可用的NAS的VPC挂载点。 '."\n", + 'type' => 'string', + 'required' => false, + 'example' => '008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com', + ], + ], + [ + 'name' => 'VolumeMountOption', + 'in' => 'query', + 'schema' => [ + 'description' => '采用mount命令手动挂载NFS文件系统时的挂载参数。 '."\n" + ."\n" + .' <props="china">具体请参见[手动挂载NFS文件系统](https://help.aliyun.com/document_detail/90529.html#section-jyi-hyd-hbr)。</props>'."\n" + ."\n" + .'<props="intl">具体请参见[手动挂载NFS文件系统](https://www.alibabacloud.com/help/en/nas/latest/mount-an-nfs-file-system-on-a-linux-ecs-instance#section-jyi-hyd-hbr)。</props>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-t nfs -o vers=4', + ], + ], + [ + 'name' => 'RemoteDirectory', + 'in' => 'query', + 'schema' => [ + 'description' => '挂载共享存储的远程目录。', + 'type' => 'string', + 'required' => false, + 'example' => 'NasMountpoint:/RemoteDirectory', + ], + ], + [ + 'name' => 'DeployMode', + 'in' => 'query', + 'schema' => [ + 'description' => '集群部署模式。取值范围：'."\n" + .'- Standard：账号节点、调度节点、登录节点、计算节点分离部署。'."\n" + .'- Simple：账号节点和调度节点混合部署在一个节点上，登录节点和计算节点分离部署。'."\n" + .'- Tiny：账号节点、调度节点、登录节点混合部署在一个节点上，计算节点分离部署。'."\n" + ."\n" + .'默认值：Standard。', + 'type' => 'string', + 'required' => false, + 'example' => 'Simple', + ], + ], + [ + 'name' => 'HaEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启高可用。取值范围：'."\n" + .'- true：开启。'."\n" + .'- false：不开启。'."\n" + ."\n" + .'默认值：false。'."\n" + .'>若开启高可用则集群中的每种管控角色将会使用主备2个节点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'EcsChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群中所有节点的付费类型，取值范围：'."\n" + .'- PostPaid：按量付费。'."\n" + .'- PrePaid：包年包月。'."\n" + ."\n" + .'若选择包年包月类型，默认开启自动续费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'default' => 'PostPaid', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '登录节点的root密码。'."\n" + .'> 建议使用HTTPS协议调用API避免密码泄露。'."\n" + ."\n" + .'密码格式要求：'."\n" + ."\n" + .'- 长度为8至30个字符。'."\n" + .'- 必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是`( ) ~ ! @ # $ % ^ & * - + = | { } [ ] : ; ‘ < > , . ? / `。'."\n" + ."\n" + .'> 集群的登录凭证支持密码和密钥对两种，Password和KeyPairName二者必选其一，如果二者都指定，则Password优先级高。', + 'type' => 'string', + 'required' => false, + 'example' => '123****', + ], + ], + [ + 'name' => 'KeyPairName', + 'in' => 'query', + 'schema' => [ + 'description' => '登录节点绑定的密钥对名称。关于如何创建密钥对，请参见[创建密钥对](~~51793~~)。'."\n" + ."\n" + .'> 集群的登录凭证支持密码和密钥对两种，Password和KeyPairName二者必选其一，如果二者都指定，则Password优先级高。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像类型。取值范围：'."\n" + .'- system：公共镜像'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像'."\n" + ."\n" + .'默认值：system。', + 'type' => 'string', + 'required' => false, + 'example' => 'self', + 'default' => 'system', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像ID。'."\n" + ."\n" + .'您可以调用[ListImages](~~87213~~)和[ListCustomImages](~~87215~~)查询E-HPC可以使用的镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_02_64_20G_alibase_20170818****', + ], + ], + [ + 'name' => 'EcsOrder.Manager.Count', + 'in' => 'query', + 'schema' => [ + 'description' => '集群管控节点数量。取值范围：1~2。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EcsOrder.Manager.InstanceType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '集群管控节点规格。'."\n" + ."\n" + .'您可以调用[ListPreferredEcsTypes](~~188592~~)接口获取推荐的节点规格信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'EcsOrder.Compute.Count', + 'in' => 'query', + 'schema' => [ + 'description' => '集群计算节点数量。取值范围：0~99。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'EcsOrder.Compute.InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群计算节点规格。'."\n" + ."\n" + .'您可以调用[ListPreferredEcsTypes](~~188592~~)接口获取推荐的节点规格信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'EcsOrder.Login.Count', + 'in' => 'query', + 'schema' => [ + 'description' => '集群登录节点数量，仅支持配置1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + 'default' => '0', + ], + ], + [ + 'name' => 'EcsOrder.Login.InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群登录节点规格。'."\n" + ."\n" + .'您可以调用[ListPreferredEcsTypes](~~188592~~)接口获取推荐的节点规格信息。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'SccClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'SCC实例ID。'."\n" + ."\n" + .'如果配置该参数，则将已有的SCC实例纳管到新创建的SCC集群中。', + 'type' => 'string', + 'required' => false, + 'example' => '00b648b****', + ], + ], + [ + 'name' => 'ComputeSpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点竞价策略。取值范围：'."\n" + .'- NoSpot：正常按量付费节点。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式节点。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式节点。'."\n" + ."\n" + .'默认值：NoSpot。', + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + ], + [ + 'name' => 'ComputeSpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点每小时最高价格。最大支持3位小数，参数ComputeSpotStrategy取值为SpotWithPriceLimit时生效。', + 'type' => 'string', + 'required' => false, + 'example' => '0.034', + ], + ], + [ + 'name' => 'ComputeEnableHt', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点是否支持超线程。取值范围：'."\n" + .'- true：支持。'."\n" + .'- false：不支持。'."\n" + ."\n" + .'默认值：true。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '购买集群节点的时长。单位由`PeriodUnit`指定，取值范围：'."\n" + ."\n" + .'<props="china">'."\n" + .'- 当参数PriceUnit取值为Year时：1~3。'."\n" + .'- 当参数PriceUnit取值为Month时：1~9。'."\n" + .'- 当参数PriceUnit取值为Hour时：1。'."\n" + .'- 当参数PriceUnit取值为Week时：1~4。'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + .'- 当参数PriceUnit取值为Year时：1~3。'."\n" + .'- 当参数PriceUnit取值为Month时：1~9。'."\n" + .'- 当参数PriceUnit取值为Hour时：1。'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '购买集群节点的时长单位。取值范围：'."\n" + ."\n" + .'<props="china">'."\n" + .'- Year'."\n" + .'- Month'."\n" + .'- Hour'."\n" + .'- Week'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + .'- Year'."\n" + .'- Month'."\n" + .'- Hour'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'默认值：Month。', + 'type' => 'string', + 'required' => false, + 'example' => 'Year', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动续费。取值范围：'."\n" + .'- true：自动续费。'."\n" + .'- false：不自动续费。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '每次自动续费的时长，当参数AutoRenew取值true时生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'InputFileUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '上传到OSS的作业文件的URL地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://ehpc-tianshui.oss-cn-beijing.aliyuncs.com/test-u****/testlist_ehpc.sh', + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点加入的队列名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'SystemDiskType', + 'in' => 'query', + 'schema' => [ + 'description' => '系统盘的云盘种类。取值范围：'."\n" + .'- cloud_efficiency：高效云盘。'."\n" + .'- cloud_ssd：SSD云盘。'."\n" + .'- cloud_essd：ESSD云盘。'."\n" + .'- cloud：普通云盘，已售罄。'."\n" + ."\n" + .'默认值：cloud_ssd。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + ], + [ + 'name' => 'SystemDiskSize', + 'in' => 'query', + 'schema' => [ + 'description' => '系统盘大小。单位：GB。'."\n" + ."\n" + .'取值范围：40~500。'."\n" + ."\n" + .'默认值：40。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + ], + [ + 'name' => 'RemoteVisEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启远程可视化。取值范围：'."\n" + .'- true：开启。'."\n" + .'- false：不开启。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + ."\n" + .'您可以调用[ListResourceGroups](~~158855~~)查询资源组ID。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxazb4ph****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'WithoutElasticIp', + 'in' => 'query', + 'schema' => [ + 'description' => '登录节点是否使用弹性公网IP。默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + [ + 'name' => 'SystemDiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '创建ESSD云盘作为系统盘使用时，设置云盘的性能等级。取值范围：'."\n" + .'- PL0：单盘最高随机读写IOPS 1万。'."\n" + .'- PL1：单盘最高随机读写IOPS 5万。'."\n" + .'- PL2：单盘最高随机读写IOPS 10万。'."\n" + .'- PL3：单盘最高随机读写IOPS 100万。'."\n" + ."\n" + .'默认值：PL1。'."\n" + ."\n" + .'关于如何选择ESSD性能等级，请参见[ESSD云盘](~~122389~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL0', + ], + ], + [ + 'name' => 'IsComputeEss', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用自动伸缩。取值范围：'."\n" + .'- true：启用。'."\n" + .'- false：未启用。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClusterVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '集群版本号。'."\n" + ."\n" + .'默认值：1.0。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0', + ], + ], + [ + 'name' => 'Application', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用软件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '应用软件信息。', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'description' => '应用软件的标签。'."\n" + ."\n" + .'N的取值范围：0~100'."\n" + ."\n" + .'您可以调用[ListSoftwares](~~87216~~)查询应用软件标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenMPI_11.1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'AdditionalVolumes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '挂载的共享存储信息。', + 'type' => 'array', + 'items' => [ + 'description' => '挂载的共享存储信息。', + 'type' => 'object', + 'properties' => [ + 'JobQueue' => [ + 'description' => '挂载共享存储的节点作业所处队列。'."\n" + ."\n" + .'N的取值范围：1~10。', + 'type' => 'string', + 'required' => false, + 'example' => 'high', + ], + 'VolumeId' => [ + 'description' => '挂载的NAS实例ID。'."\n" + ."\n\n" + .'N的取值范围：1~10。', + 'type' => 'string', + 'required' => false, + 'example' => 'extreme-00b88****', + ], + 'Roles' => [ + 'description' => '共享存储挂载到新NAS上的节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '共享存储挂载到新NAS上的节点信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '共享存储挂载到新NAS上的节点类型。'."\n" + ."\n" + .'AdditionalVolumes.N.Roles中N的取值范围：1~10。'."\n" + ."\n" + .'Roles.N.Name中N的取值范围：0~8。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["Compute"]', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 8, + ], + 'VolumeMountpoint' => [ + 'description' => '挂载的NAS的VPC挂载点。'."\n" + ."\n" + .'N的取值范围：1~10。', + 'type' => 'string', + 'required' => false, + 'example' => '0088****-sihc.cn-hangzhou.extreme.nas.aliyuncs.com', + ], + 'VolumeMountOption' => [ + 'description' => 'NAS的挂载选项。'."\n" + ."\n" + .'N的取值范围：1~10。', + 'type' => 'string', + 'required' => false, + 'example' => '-t nfs -o vers=4.0', + ], + 'RemoteDirectory' => [ + 'description' => '挂载的共享存储的远程目录。'."\n" + ."\n" + .'N的取值范围：1~10。', + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'VolumeType' => [ + 'description' => '挂载的共享存储类型。目前仅支持NAS。'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'string', + 'required' => false, + 'example' => 'nas', + ], + 'LocalDirectory' => [ + 'description' => '挂载的共享存储的本地挂载目录。'."\n" + ."\n" + .'N的取值范围：1~10。', + 'type' => 'string', + 'required' => false, + 'example' => '/ff', + ], + 'VolumeProtocol' => [ + 'description' => '挂载的共享存储协议类型。取值范围：'."\n" + .'- NFS'."\n" + .'- SMB'."\n" + ."\n" + .'N的取值范围：1~10。'."\n" + ."\n" + .'默认值：NFS。', + 'type' => 'string', + 'required' => false, + 'example' => 'NFS', + ], + 'Location' => [ + 'description' => '挂载的共享存储的集群类型，只能配置PublicCloud。'."\n" + ."\n" + .'N的取值范围：1~10。', + 'type' => 'string', + 'required' => false, + 'example' => 'PublicCloud', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PostInstallScript', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '安装后脚本信息。', + 'type' => 'array', + 'items' => [ + 'description' => '安装后脚本信息。', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => '安装后脚本的执行参数。'."\n" + ."\n" + .'N的取值范围：0~16。', + 'type' => 'string', + 'required' => false, + 'example' => 'bashfile.sh', + ], + 'Url' => [ + 'description' => '安装后脚本的下载地址。'."\n" + ."\n" + .'N的取值范围：0~16。', + 'type' => 'string', + 'required' => false, + 'example' => '/opt/job.sh', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'Plugin', + 'in' => 'query', + 'schema' => [ + 'description' => '插件模式配置，仅当SchedulerType为custom生效。'."\n" + ."\n" + .'格式为JSON字符串，包含pluginMod、pluginLocalPath、pluginOssPath三个参数，具体参数说明如下：'."\n" + ."\n" + .'- pluginMod：插件模式，支持以下两种模式：'."\n" + .' '."\n" + .' - oss模式：将从OSS上下载插件解压到本地pluginLocalPath中。'."\n" + ."\n" + .' - image模式：默认插件已经放置到pluginLocalPath。'."\n" + ."\n" + .'- pluginLocalPath：插件存放的本地路径，建议在oss模式下选择共享存储目录，image模式下选择非共享存储目录。'."\n" + ."\n" + .'- pluginOssPath：插件放置在OSS上的远程路径，仅当pluginMod等于oss生效。', + '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' => '是否不安装Agent客户端。'."\n" + ."\n" + .'- true：不安装。'."\n" + ."\n" + .'- false：安装。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'WithoutNas', + 'in' => 'query', + 'schema' => [ + 'description' => '是否不使用NAS作为共享存储。取值范围：'."\n" + ."\n" + .'- true：不使用NAS。'."\n" + .'- false：使用NAS。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false'."\n", + ], + ], + [ + 'name' => 'RamRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例RAM角色名称。'."\n" + ."\n" + .'您可以使用RAM API [ListRoles](~~28713~~)查询您已创建的实例RAM角色。'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testRamRoleName', + ], + ], + [ + 'name' => 'NetworkInterfaceTrafficMode', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性网卡的通讯模式。取值范围：'."\n" + ."\n" + .'- Standard：使用TCP通讯模式。'."\n" + .'- HighPerformance：开启ERI（Elastic RDMA Interface）接口，使用RDMA通讯模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'DeploymentSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '部署集ID。'."\n" + .'您可以通过[DescribeDeploymentSets](~~91313~~)获取部署集ID，当前仅支持网络低时延策略的部署集。', + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp1frxuzdg87zh4pzq****', + ], + ], + [ + 'name' => 'RamNodeTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '授权实例角色的节点名称详情。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '授权实例角色的节点名称。'."\n" + ."\n" + .'N的取值范围：0~4。'."\n" + ."\n" + .'- 当DeployMode取值为Standard时，取值范围：scheduler、account、login、compute，支持多选，多个取值间用半角逗号（,）隔开。'."\n" + ."\n" + .'- 当DeployMode取值为Simple时，取值范围：manager、login、compute，支持多选，多个取值间用半角逗号（,）隔开。'."\n" + ."\n" + .'- 当DeployMode取值为Tiny时，取值范围：manager、compute。', + 'type' => 'string', + 'required' => false, + 'example' => 'manager', + ], + 'required' => false, + 'example' => 'Standard', + 'maxItems' => 5, + 'minItems' => 0, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '标签数组。', + 'type' => 'array', + 'items' => [ + 'description' => '标签数组。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + 'example' => 'scheduler', + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'AddOns', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '自定义组件服务。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义组件服务。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '组件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cromwell', + ], + 'Version' => [ + 'description' => '组件版本号。', + 'type' => 'string', + 'required' => false, + 'example' => '85', + ], + 'DeployMode' => [ + 'description' => '部署模式。取值范围：local，ecs。', + 'type' => 'string', + 'required' => false, + 'example' => 'local', + ], + 'DBType' => [ + 'description' => '数据库类型。取值范围：Mysql，null。', + 'type' => 'string', + 'required' => false, + 'example' => 'Mysql', + ], + 'ConfigFile' => [ + 'description' => '配置文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/addon/cromwell/cromwell.conf', + ], + 'Port' => [ + 'description' => '自定义组件访问端口。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '10000', + ], + 'DefaultStart' => [ + 'description' => '自定义组件是否自启动。取值范围：true，false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C084****', + ], + 'TaskId' => [ + 'description' => '任务ID。'."\n" + ."\n" + .'>由于CreateCluster是异步操作，请求成功就会立即返回结果，不会等待节点创建成功。您可以调用[ListTasks](~~268225~~)查询任务运行结果。', + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C084****', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + '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' => '创建集群', + 'description' => '## 接口说明'."\n" + ."\n" + .'创建集群会涉及相关资源计费，建议您提前了解E-HPC的计费方式。更多信息，请参见[计费方式](~~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' => '集群ID。您可以调用[ListClusters](~~87116~~)查询指定地域下的集群列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-QKKVqO****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ClusterInfo' => [ + 'description' => '集群信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '集群状态。可能值：'."\n" + .'- uninit：未初始化'."\n" + .'- creating：创建中'."\n" + .'- Init：初始化中'."\n" + .'- running：运行中'."\n" + .'- exception：异常'."\n" + .'- releasing：释放中', + 'type' => 'string', + 'example' => 'creating', + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp1pxkcvmmz53ki89****', + ], + 'KeyPairName' => [ + 'description' => '密钥对名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'EcsChargeType' => [ + 'description' => '集群实例付费类型。可能值：'."\n" + .'- PostPaid：按量付费'."\n" + .'- PrePaid：包年包月', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'SecurityGroupId' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-bp1asugr34gzn****', + ], + 'SccClusterId' => [ + 'description' => '集群使用的SccCluster ID。如果集群不是SCC机型则为空。', + 'type' => 'string', + 'example' => '00b648b****', + ], + 'CreateTime' => [ + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2020-12-24T03:18:23.000Z', + ], + 'AccountType' => [ + 'description' => '账户服务器类型。可能值：'."\n" + .'- nis'."\n" + .'- ldap', + 'type' => 'string', + 'example' => 'nis', + ], + 'VolumeProtocol' => [ + 'description' => '网络共享存储协议。可能值：'."\n" + .'- nfs'."\n" + .'- smb', + 'type' => 'string', + 'example' => 'nfs', + ], + 'Description' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'VolumeId' => [ + 'description' => '阿里云NAS实例ID。目前不支持自动创建阿里云NAS实例。', + 'type' => 'string', + 'example' => '008b64****', + ], + 'HaEnable' => [ + 'description' => '是否开启高可用。'."\n" + .' >若开启高可用，则集群中的每种管控角色将会使用主备2台实例。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'BaseOsTag' => [ + 'description' => '集群基础镜像。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Name' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'centos_7_02_64_20G_alibase_20170818****', + ], + 'SchedulerType' => [ + 'description' => '调度服务器类型。可能值范围：'."\n" + .'- pbs'."\n" + .'- slurm'."\n" + .'- opengridscheduler'."\n" + .'- deadline', + 'type' => 'string', + 'example' => 'pbs', + ], + 'SchedulerVersion' => [ + 'description' => '调度器软件版本。', + 'type' => 'string', + 'example' => '18.1.1', + ], + 'DeployMode' => [ + 'description' => '集群部署模式。可能值：'."\n" + .'- Standard：账号节点、调度节点、登录节点、计算节点分离部署。'."\n" + .'- Advanced：HA模式部署。'."\n" + .'- Simple：账号节点和调度节点混合部署在一个节点上，登录节点和计算节点分离部署。'."\n" + .'- Tiny：账号节点、调度节点、登录节点混合部署在一个节点上，计算节点分离部署。', + 'type' => 'string', + 'example' => 'Simple', + ], + 'ImageOwnerAlias' => [ + 'description' => '镜像类型。可能值：'."\n" + .'- system：公共镜像'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像'."\n" + .'- marketplace：镜像市场镜像', + 'type' => 'string', + 'example' => 'system', + ], + 'OsTag' => [ + 'description' => '操作系统镜像标签。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'VolumeMountpoint' => [ + 'description' => 'NAS的VPC挂载点。目前不支持自动创建阿里云NAS挂载点。', + 'type' => 'string', + 'example' => '008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com', + ], + 'RemoteDirectory' => [ + 'description' => '挂载共享存储的远程目录。', + 'type' => 'string', + 'example' => 'NasMountpoint:/RemoteDirectory', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VSwitchId' => [ + 'description' => 'VPC中交换机ID。产品目前只支持VPC网络。', + 'type' => 'string', + 'example' => 'vsw-bp1e47optm9g58zcu****', + ], + 'ImageName' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'test_for_Image', + ], + 'VolumeType' => [ + 'description' => '网络共享存储类型，目前仅支持阿里云NAS。', + 'type' => 'string', + 'example' => 'NAS', + ], + 'Location' => [ + 'description' => '集群所在位置。可能值：'."\n" + .'- OnPremise：混合云集群。'."\n" + .'- PublicCloud：公有云集群。', + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'Id' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-bp15de54eet1c43f****', + ], + 'ClientVersion' => [ + 'description' => '集群所使用的客户端版本号。', + 'type' => 'string', + 'example' => '1.0.1', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-k', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek23szz5i2****', + ], + 'RamRoleName' => [ + 'description' => '实例RAM角色名称。', + 'type' => 'string', + 'example' => 'AliyunEHPCFullAccess', + ], + 'RamNodeTypes' => [ + 'description' => '授权实例角色的节点名称详情。', + 'type' => 'string', + 'example' => '["manager", "compute"]', + ], + 'Applications' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApplicationInfo' => [ + 'description' => '集群应用软件列表，包含软件的名称和版本号。', + 'type' => 'array', + 'items' => [ + 'description' => '集群应用软件列表，包含软件的名称和版本号。', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'description' => '应用软件标签。', + 'type' => 'string', + 'example' => 'OpenMPI_1.8.7', + ], + 'Name' => [ + 'description' => '应用软件名称。', + 'type' => 'string', + 'example' => 'openmpi', + ], + 'Version' => [ + 'description' => '应用软件版本。', + 'type' => 'string', + 'example' => '1.10', + ], + ], + ], + ], + ], + ], + 'PostInstallScripts' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'PostInstallScriptInfo' => [ + 'description' => '安装后脚本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安装后脚本列表。', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '脚本下载路径。', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Args' => [ + 'description' => '脚本执行参数。', + 'type' => 'string', + 'example' => 'bash file.sh', + ], + ], + ], + ], + ], + ], + 'EcsInfo' => [ + 'description' => '描述集群中ECS数量和规格的数据结构。', + 'type' => 'object', + 'properties' => [ + 'Manager' => [ + 'description' => '管控节点信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => '管控节点实例规格。', + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'Count' => [ + 'description' => '管控节点的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Compute' => [ + 'description' => '计算节点信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => '计算节点ECS实例规格。', + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'Count' => [ + 'description' => '计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Login' => [ + 'description' => '登录节点信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => '登录节点实例规格。', + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'Count' => [ + 'description' => '登录节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'ProxyMgr' => [ + 'description' => '云上代理节点信息。'."\n" + ."\n" + .'仅当集群为混合云集群，并开启混合云代理模式时，返回该参数。'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => '云上代理节点的实例类型。', + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'Count' => [ + 'description' => '云上代理节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'OnPremiseInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OnPremiseInfo' => [ + 'description' => '本地集群管理节点信息。'."\n" + ."\n" + .'仅当集群为混合云集群，并开启混合云代理模式时，返回该参数。', + 'type' => 'array', + 'items' => [ + 'description' => '本地集群管理节点信息。'."\n" + ."\n" + .'仅当集群为混合云集群，并开启混合云代理模式时，返回该参数。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '本地集群管理节点类型，可能值：'."\n" + ."\n" + .'- scheduler'."\n" + .'- account'."\n" + .'- account，scheduler', + 'type' => 'string', + 'example' => 'scheduler', + ], + 'HostName' => [ + 'description' => '本地集群管理节点主机名。', + 'type' => 'string', + 'example' => 'testecs', + ], + 'IP' => [ + 'description' => '本地集群管理节点IP地址。', + 'type' => 'string', + 'example' => '192.168.*.*', + ], + ], + ], + ], + ], + ], + 'AddOnsInfo' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AddOnsInfo' => [ + 'description' => '自定义组件服务信息。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义组件服务信息。', + 'type' => 'object', + 'properties' => [ + 'SoftwareId' => [ + 'description' => '组件的软件ID。', + 'type' => 'string', + 'example' => 'CROMWELL_85', + ], + 'DeployMode' => [ + 'description' => '自定义组件的部署模式。可能值：'."\n" + ."\n" + .'- local'."\n" + .'- ecs', + 'type' => 'string', + 'example' => 'local', + ], + 'Port' => [ + 'description' => '自定义组件的服务TCP端口号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'Status' => [ + 'description' => '自定义组件的运行状态。可能值：'."\n" + ."\n" + .'- running'."\n" + .'- stopped'."\n" + .'- exception', + 'type' => 'string', + 'example' => 'running', + ], + 'URL' => [ + 'description' => '自定义组件服务的访问链接。', + 'type' => 'string', + 'example' => 'http://172.16.10.12:10000/', + ], + ], + ], + ], + ], + ], + 'ClusterVersion' => [ + 'description' => '集群版本号。', + 'type' => 'string', + 'example' => '1.0', + ], + 'WithoutAgent' => [ + 'description' => '是否不安装Agent客户端。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'false', + ], + 'Plugin' => [ + 'description' => '插件模式配置，仅当SchedulerType为custom生效。'."\n" + ."\n" + .'格式为JSON字符串，包含pluginMod、pluginLocalPath、pluginOssPath三个参数，具体参数说明如下：'."\n" + ."\n" + .'- pluginMod：插件模式，支持以下两种模式：'."\n" + .' '."\n" + .' - oss模式：将从OSS上下载插件解压到本地pluginLocalPath中。'."\n" + ."\n" + .' - image模式：默认插件已经放置到pluginLocalPath。'."\n" + ."\n" + .'- pluginLocalPath：插件存放的本地路径，建议在oss模式下选择共享存储目录，image模式下选择非共享存储目录。'."\n" + ."\n" + .'- pluginOssPath：插件放置在OSS上的远程路径，仅当pluginMod等于oss生效。', + 'type' => 'string', + 'example' => '{\\"pluginMod\\":\\"image\\",\\"pluginLocalPath\\":\\"/opt/plugin\\"}', + ], + 'SchedulerPreInstall' => [ + 'description' => '业务镜像是否已预安装调度器。可能值：'."\n" + .'- true：已预安装，创建或扩容节点时无需执行安装调度器流程。'."\n" + .'- false：未预安装，创建或扩容节点时需要执行安装调度器流程。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'true', + ], + 'Domain' => [ + 'description' => '本地集群域名。'."\n" + ."\n" + .'仅当AccoutType取值为Idap时，支持配置该参数。', + 'type' => 'string', + 'example' => 'ldap', + ], + 'OpenldapPar' => [ + 'description' => '对接OpenLDAP服务器参数。', + 'type' => 'string', + 'example' => '{'."\n" + .' "LdapServerIp": "192.168.XX.XX",'."\n" + .' "BaseDn": "ehpctest",'."\n" + .' "FallbackHomeDir": "/home"'."\n" + .'}', + ], + 'WinAdPar' => [ + 'description' => '连接Windows AD参数。', + 'type' => 'string', + 'example' => '{ "AdUser": "Administrator", "AdUserPasswd": "xxxxxx", "AdDc": "ad-hybrid001.ehpcad.com", "AdIp": "192.168.XX.XX"}', + ], + 'Period' => [ + 'description' => '购买集群节点的时长。单位由`PeriodUnit`指定，取值范围：'."\n" + ."\n" + .'<props="china">'."\n" + .'- 当参数PriceUnit取值为Year时：1~3。'."\n" + .'- 当参数PriceUnit取值为Month时：1~9。'."\n" + .'- 当参数PriceUnit取值为Hour时：1。'."\n" + .'- 当参数PriceUnit取值为Week时：1~4。'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + .'- 当参数PriceUnit取值为Year时：1~3。'."\n" + .'- 当参数PriceUnit取值为Month时：1~9。'."\n" + .'- 当参数PriceUnit取值为Hour时：1。'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'默认值：1。', + 'type' => 'string', + 'example' => '1', + ], + 'PeriodUnit' => [ + 'description' => '购买集群节点的时长单位。取值范围：'."\n" + ."\n" + .'<props="china">'."\n" + .'- Year'."\n" + .'- Month'."\n" + .'- Hour'."\n" + .'- Week'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">'."\n" + .'- Year'."\n" + .'- Month'."\n" + .'- Hour'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'默认值：Month。', + 'type' => 'string', + 'example' => 'Month', + ], + 'AutoRenewPeriod' => [ + 'description' => '每次自动续费的时长。参数AutoRenew取值true时生效。'."\n" + .'- PeriodUnit为Week时，AutoRenewPeriod取值{"1", "2", "3"}。'."\n" + .'- PeriodUnit为Month时，AutoRenewPeriod取值{"1", "2", "3", "6", "12"}。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'string', + 'example' => '1', + ], + 'AutoRenew' => [ + 'description' => '是否自动续费，当参数EcsChargeType取值为PrePaid时才生效。取值范围：'."\n" + .'- true：自动续费'."\n" + .'- false：不自动续费'."\n" + ."\n" + .'默认值：true', + 'type' => 'string', + 'example' => 'false', + ], + 'ComputeSpotStrategy' => [ + 'description' => '计算节点竞价策略。可能值：'."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'ComputeSpotPriceLimit' => [ + 'description' => '计算节点每小时最高价格。最大支持3位小数，参数ComputeSpotStrategy取值为SpotWithPriceLimit时生效。', + 'type' => 'string', + 'example' => '0.56', + ], + 'Nodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodesInfo' => [ + 'description' => '本地集群节点信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '本地集群节点信息列表。', + 'type' => 'object', + 'properties' => [ + 'Role' => [ + 'description' => '本地集群节点的角色。可能值：'."\n" + ."\n" + .'- Manager：管控节点'."\n" + .'- Login：登录节点'."\n" + .'- Compute：计算节点', + 'type' => 'string', + 'example' => 'Compute', + ], + 'HostName' => [ + 'description' => '本地集群节点的主机名称。', + 'type' => 'string', + 'example' => 'compute000', + ], + 'IpAddress' => [ + 'description' => '本地集群节点的IP地址。', + 'type' => 'string', + 'example' => '192.168.XX.XX', + ], + 'AccountType' => [ + 'description' => '本地集群节点的域账号服务类型。可能值：'."\n" + ."\n" + .'- nis'."\n" + .'- ldap'."\n" + ."\n" + .'默认值：nis', + 'type' => 'string', + 'example' => 'nis', + ], + 'Dir' => [ + 'description' => '本地集群节点的配置目录。', + 'type' => 'string', + 'example' => '/opt/sge/default/', + ], + 'SchedulerType' => [ + 'description' => '本地集群节点的调度器类型。可能值：'."\n" + ."\n" + .'- pbs'."\n" + .'- slurm'."\n" + .'- opengridscheduler'."\n" + .'- deadline'."\n" + ."\n" + .'默认值：pbs。', + 'type' => 'string', + 'example' => 'pbs', + ], + ], + ], + ], + ], + ], + 'InitialImage' => [ + 'description' => '操作系统镜像信息汇总。', + 'type' => 'object', + 'properties' => [ + 'OsTag' => [ + 'description' => 'E-HPC支持的操作系统镜像。', + 'type' => 'string', + 'example' => 'CentOS_7.6_64', + ], + 'ImageOwnerAlias' => [ + 'description' => '镜像类型，可能值：'."\n" + .'- system：公共镜像'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像'."\n" + .'- marketplace：镜像市场镜像', + 'type' => 'string', + 'example' => 'system', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'centos_7_6_x64_20G_alibase_20211130.vhd', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询单个集群信息', + 'summary' => '查询指定集群信息。', + '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' => '指定修改的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的集群描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-description', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => '集群修改后的镜像类型。取值范围：'."\n" + .'- system：公共镜像'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像'."\n" + .'- marketplace：镜像市场镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'self', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_06_64_20G_alibase_2019071****', + ], + ], + [ + 'name' => 'RamRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => '授权实例配置时，实例RAM角色的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testRamRoleName', + ], + ], + [ + 'name' => 'RamNodeTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '授权实例配置时，要绑定RAM角色的节点类型。', + 'type' => 'array', + 'items' => [ + 'description' => '授权实例配置时，要绑定RAM角色的节点类型。'."\n" + ."\n" + .'- 当DeployMode取值为Standard时，取值范围：scheduler、account、login、compute，支持多选，多个取值间用半角逗号（,）隔开。'."\n" + .'- 当DeployMode取值为Simple时，取值范围：manager、login、compute，支持多选，多个取值间用半角逗号（,）隔开。'."\n" + .'- 当DeployMode取值为Tiny时，取值范围：manager、compute。', + 'type' => 'string', + 'required' => false, + 'example' => 'manager,compute', + ], + 'required' => false, + 'maxItems' => 5, + 'minItems' => 0, + ], + ], + [ + 'name' => 'WinAdPar', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '连接Windows AD参数。', + 'type' => 'object', + 'properties' => [ + 'AdUser' => [ + 'description' => 'Windows AD服务器管理员。', + 'type' => 'string', + 'required' => false, + 'example' => 'administrator', + ], + 'AdUserPasswd' => [ + 'description' => 'Windows AD服务器管理员密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxxx', + ], + 'AdDc' => [ + 'description' => 'Windows AD服务器域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpcad.com', + ], + 'AdIp' => [ + 'description' => 'Windows AD服务器IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.2', + ], + 'FallbackHomeDir' => [ + 'description' => 'Linux服务器home目录。', + 'type' => 'string', + 'required' => false, + 'example' => '/home', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7336', + ], + ], + ], + ], + ], + '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' => '修改一个集群的属性', + 'summary' => '修改指定集群的基本信息，包括修改集群名称、集群描述和集群镜像。', + 'description' => '## 接口说明'."\n" + .'修改集群基本信息前，您可以调用[DescribeCluster](~~87126~~)查询选择集群的详细信息。', + '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' => '显示的页码，起始值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。取值范围：1~50'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Clusters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ClusterInfoSimple' => [ + 'description' => '集群详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-b3f3edefefeep0760yju****', + ], + 'Status' => [ + 'description' => '集群状态。可能值：'."\n" + .'- uninit：未初始化'."\n" + .'- creating：创建中'."\n" + .'- init：初始化中'."\n" + .'- running：运行中'."\n" + .'- exception：异常'."\n" + .'- releasing：释放中', + 'type' => 'string', + 'example' => 'running', + ], + 'CreateTime' => [ + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2020-10-30T07:39:20.000Z', + ], + 'IsComputeEss' => [ + 'description' => '是否启用弹性伸缩组。可能值：'."\n" + .'- true：启用'."\n" + .'- false：未启用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ComputeSpotStrategy' => [ + 'description' => '计算节点竞价策略。可能值：'."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'AccountType' => [ + 'description' => '账户服务器类型。可能值：'."\n" + .'- nis'."\n" + .'- ldap', + 'type' => 'string', + 'example' => 'nis', + ], + 'Count' => [ + 'description' => '集群计算节点数目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'EhpcVersion' => [ + 'description' => 'EHPC版本。', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'Description' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'clusterdescription', + ], + 'BaseOsTag' => [ + 'description' => '基础镜像操作系统标签，仅管控节点使用。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Name' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'wi_1607_x64_dtc_zh_40G_alibase****', + ], + 'ComputeSpotPriceLimit' => [ + 'description' => '计算节点下ECS实例的每小时最高价格。返回值最多保留小数点后3位。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.034', + ], + 'SchedulerType' => [ + 'description' => '调度服务器类型。可能值：'."\n" + .'- pbs'."\n" + .'- slurm'."\n" + .'- opengridscheduler'."\n" + .'- deadline', + 'type' => 'string', + 'example' => 'pbs', + ], + 'DeployMode' => [ + 'description' => '集群部署模式。可能值：'."\n" + .'- Standard：账号节点、调度节点、登录节点、计算节点分离部署。'."\n" + .'- Advanced：HA模式部署。'."\n" + .'- Simple：账号节点和调度节点混合部署在一个节点上，登录节点和计算节点分离部署。'."\n" + .'- Tiny：账号节点、调度节点、登录节点混合部署在一个节点上，计算节点分离部署。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'NodeSuffix' => [ + 'description' => '主机后缀名。', + 'type' => 'string', + 'example' => 'name', + ], + 'ImageOwnerAlias' => [ + 'description' => '镜像类型。可能值：'."\n" + .'- system：公共镜像'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像'."\n" + .'- marketplace：镜像市场镜像', + 'type' => 'string', + 'example' => 'system', + ], + 'OsTag' => [ + 'description' => '操作系统镜像标签。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'NodePrefix' => [ + 'description' => '主机前缀名。', + 'type' => 'string', + 'example' => 'test', + ], + 'InstanceType' => [ + 'description' => '计算节点实例规格。', + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'InstanceChargeType' => [ + 'description' => '集群实例付费类型。可能值：'."\n" + ."\n" + .'- PostPaid：按量付费'."\n" + .'- PrePaid：包年包月', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-c', + ], + 'LoginNodes' => [ + 'description' => '登录节点列表。', + 'type' => 'string', + 'example' => '{"Id": "i-bp13x4is8pvdhws7e****"}', + ], + 'Id' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-jeJki6****', + ], + 'Location' => [ + 'description' => '集群所在位置。可能值：'."\n" + .'- OnPremise：混合云集群。'."\n" + .'- PublicCloud：公有云集群。', + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'ClientVersion' => [ + 'description' => '集群客户端版本。', + 'type' => 'string', + 'example' => '1.0.64', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。您可以调用ListResourceGroups查询资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxazb4ph****', + ], + 'Managers' => [ + 'description' => '管理节点信息。', + 'type' => 'object', + 'properties' => [ + 'OperatingCount' => [ + 'description' => '操作进行中的节点数量，包括初始化、安装中、释放中等状态的节点。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExceptionCount' => [ + 'description' => '异常节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StoppedCount' => [ + 'description' => '停止节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Total' => [ + 'description' => '总管理节点数目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NormalCount' => [ + 'description' => '正常节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Computes' => [ + 'description' => '计算节点信息。', + 'type' => 'object', + 'properties' => [ + 'OperatingCount' => [ + 'description' => '操作进行中的节点数量，包括初始化、安装中、释放中等状态的节点。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExceptionCount' => [ + 'description' => '异常节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StoppedCount' => [ + 'description' => '停止节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Total' => [ + 'description' => '总节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NormalCount' => [ + 'description' => '正常节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'TotalResources' => [ + 'description' => '集群资源总量。', + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'GPU资源。单位：卡。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'CPU资源。单位：核。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => '内存大小。单位为MiB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'UsedResources' => [ + 'description' => '集群资源使用量。', + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'GPU资源。单位：卡。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'CPU资源。单位：核。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => '内存大小。单位为MiB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'HasPlugin' => [ + 'description' => '集群是否使用了插件。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'默认值：false', + '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' => '查询每个地域拥有的集群列表', + 'summary' => '查询用户账号中在每个地域拥有的所有集群的列表。', + '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' => '显示的页码，起始值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。取值范围：1~50'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数。可能值：1~50', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DD517102-B314-4665-BDAC-A32DE7834D02', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Clusters' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ClusterInfoSimple' => [ + 'description' => '集群简要信息数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '集群状态。可能值：'."\n" + .'- uninit：未初始化'."\n" + .'- creating：创建中'."\n" + .'- Init：初始化中'."\n" + .'- running：运行中'."\n" + .'- exception：异常'."\n" + .'- releasing：释放中', + 'type' => 'string', + 'example' => 'running', + ], + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-b3f3edefefeep0760yju****', + ], + 'SchedulerType' => [ + 'description' => '调度服务器类型。可能值：'."\n" + .'- pbs'."\n" + .'- slurm'."\n" + .'- opengridscheduler'."\n" + .'- deadline', + 'type' => 'string', + 'example' => 'pbs', + ], + 'DeployMode' => [ + 'description' => '集群部署模式。可能值：'."\n" + .'- Standard：账号节点、调度节点、登录节点、计算节点分离部署。'."\n" + .'- Advanced：HA模式部署。'."\n" + .'- Simple：账号节点和调度节点混合部署在一个节点上，登录节点和计算节点分离部署。'."\n" + .'- Tiny：账号节点、调度节点、登录节点混合部署在一个节点上，计算节点分离部署。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'IsComputeEss' => [ + 'description' => '是否启用弹性伸缩组。可能值：'."\n" + .'- true：启用'."\n" + .'- false：未启用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'OsTag' => [ + 'description' => '操作系统镜像标签。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'AccountType' => [ + 'description' => '账户服务器类型。可能值：'."\n" + .'- nis'."\n" + .'- ldap', + 'type' => 'string', + 'example' => 'nis', + ], + 'Description' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'clusterdescription', + ], + 'Name' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'cluster1', + ], + 'Id' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-jeJki6****', + ], + 'Location' => [ + 'description' => '集群所在位置。可能值：'."\n" + .'- OnPremise：混合云集群。'."\n" + .'- PublicCloud：公有云集群。', + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'ClientVersion' => [ + 'description' => '集群客户端版本。', + 'type' => 'string', + 'example' => '1.0.64', + ], + 'HasPlugin' => [ + 'description' => '集群是否使用了插件，取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'默认值：false', + 'type' => 'boolean', + 'example' => 'false', + ], + 'EhpcVersion' => [ + 'description' => 'EHPC版本。', + 'type' => 'string', + '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' => '查询集群元列表', + 'summary' => '查询集群元数据列表。', + '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' => '指定启动的集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '76E1ADE7-D15A-457F-AAFD-06C5A5F0****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '76E1ADE7-D15A-457F-AAFD-06C5A5F0****', + ], + ], + ], + ], + ], + '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' => '启动一个集群', + 'summary' => '启动指定集群。', + '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' => '指定停止的集群ID。'."\n" + ."\n" + .'您可以调用[ListClusters](~~87116~~)查询集群列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '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' => '停止一个集群', + 'summary' => '停止指定集群。', + 'description' => '停止集群后，集群中包年包月的节点计费不受影响，按量付费的节点如果开启了<i>节省停机模式</i>功能，将不再收取计算资源的费用。更多信息，请参见[按量付费实例节省停机模式](~~63353~~)。', + ], + 'RecoverCluster' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定重置并修复的集群ID。并且，集群状态必须为exception（异常）时才能修复。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID及集群状态。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'OsTag', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统镜像标签。'."\n" + ."\n" + .'您可以通过[ListImages](~~87213~~)和[ListCustomImages](~~87215~~)查询E-HPC支持的镜像标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => '账户服务类型。取值范围：'."\n" + .'- nis'."\n" + .'- ldap'."\n" + ."\n" + .'默认值：nis', + 'type' => 'string', + 'required' => false, + 'example' => 'nis', + ], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'query', + 'schema' => [ + 'description' => '调度服务器类型。取值范围：'."\n" + .'- pbs'."\n" + .'- slurm'."\n" + .'- opengridscheduler'."\n" + .'- deadline'."\n" + ."\n" + .'默认值：pbs', + 'type' => 'string', + 'required' => false, + 'example' => 'pbs', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像类型。取值范围：'."\n" + .'- system：公共镜像'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像'."\n" + ."\n" + .'默认值：system', + 'type' => 'string', + 'required' => false, + 'example' => 'system', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像ID。'."\n" + ."\n" + .'您可以通过[ListImages](~~87213~~)和[ListCustomImages](~~87215~~)查询E-HPC可安装的镜像。', + 'type' => 'string', + 'required' => false, + 'example' => 'm-bp18133n0335yq****', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所使用的客户端版本号，默认为最新版本。'."\n" + ."\n" + .'您可以调用[ListCurrentClientVersion](~~87223~~)查询当前最新客户端版本号。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.76', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '18FB21E3-F423-4B84-BB63-D8887A29****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '18FB21E3-F423-4B84-BB63-D8887A29****', + ], + ], + ], + ], + ], + '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' => '重置并修复集群', + 'summary' => '重置并修复异常集群。', + 'description' => '仅当集群状态为exception（异常）时，才能调用该接口重置并修复集群。您可以通过调用[ListClusters](~~87116~~)获取集群ID及集群状态。'."\n" + .'建议您操作前导出所有作业数据。重置并修复集群会有以下影响：'."\n" + .'- 集群所有节点执行更换系统盘的操作，按创建集群时的配置重新配置系统盘。'."\n" + .'- 集群所有节点的系统盘和数据盘的数据将会丢失，包括用户信息、作业信息、调度器队列信息、自动伸缩队列配置信息，但文件存储NAS上的数据仍然保留。'."\n" + .'- 集群自建队列被清除，节点实例继续保留，并全部迁移到集群默认队列中。', + ], + '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' => '指定释放的集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-QKKVqO****', + ], + ], + [ + 'name' => 'ReleaseInstance', + 'in' => 'query', + 'schema' => [ + 'description' => '是否释放由E-HPC创建的ECS实例。'."\n" + ."\n" + .'默认值：true', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'enum' => [ + 'true', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'F1AB6D8D-E185-4D94-859C-7CE7B8B7****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F1AB6D8D-E185-4D94-859C-7CE7B8B7****', + ], + ], + ], + ], + ], + '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' => '释放一个集群', + 'summary' => '调用DeleteCluster释放指定集群。', + 'description' => '## 接口说明'."\n" + .'集群释放后不可恢复，集群中按量付费的节点将立即释放，到期前的包年包月节点会保留，到期后的包年包月节点会自动释放。如果您需要释放到期前的包年包月节点，请申请退款或转为按量付费实例后再释放。请确认不再使用该集群后再进行释放集群的操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateHybridCluster' => [ + 'summary' => '调用CreateHybridCluster创建一个混合云集群。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。长度2~64字符，只允许包含中文、字母、数字、短划线（-）和下划线（_），必须以字母或中文开头。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hybridcluster', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述信息。长度为2~256个英文或中文字符，不能以http://和https://开头。'."\n" + ."\n" + .'默认值：空', + 'type' => 'string', + 'required' => false, + 'example' => 'TestDescription', + ], + ], + [ + 'name' => 'EhpcVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'E-HPC产品版本号。默认使用最新版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '集群客户端版本。默认使用最新版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.64', + ], + ], + [ + 'name' => 'OsTag', + 'in' => 'query', + 'schema' => [ + 'description' => '操作系统镜像标签，您可以调用[ListImages](~~87213~~)接口查询。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '域账号服务类型。取值范围：'."\n" + .'- nis'."\n" + .'- ldap'."\n" + ."\n" + .'默认值：nis', + 'type' => 'string', + 'required' => false, + 'example' => 'nis', + ], + ], + [ + 'name' => 'Location', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所在的位置。位置固定为混合云集群，取值：OnPremise。', + 'type' => 'string', + 'required' => false, + 'example' => 'OnPremise', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '使用已有安全组ID创建集群。'."\n" + .'> 当指定该参数时，不能同时指定`SecurityGroupName`参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp13n61xsydodfyg****', + ], + ], + [ + 'name' => 'SecurityGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '如果不使用已有安全组，则使用此名称创建新安全组，应用默认策略。'."\n" + .'> 当指定该参数时，不能同时指定`SecurityGroupId`参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-SecurityGroup', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所属的VPC ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vpc-b3f3edefefeep0760yju****', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + ], + [ + 'name' => 'EcsOrder.Manager.InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '混合云集群云上管理节点规格。目前仅支持代理模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'EcsOrder.Compute.InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群计算节点实例规格。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'VolumeType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统类型。目前仅支持NAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'NAS', + 'default' => 'nas', + ], + ], + [ + 'name' => 'VolumeId', + 'in' => 'query', + 'schema' => [ + 'description' => '存储实例ID。目前不支持自动创建阿里云NAS实例。', + 'type' => 'string', + 'required' => false, + 'example' => '008b64****', + ], + ], + [ + 'name' => 'VolumeProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '共享存储的协议类型。目前仅支持NFS。', + 'type' => 'string', + 'required' => false, + 'example' => 'NFS', + 'default' => 'nfs', + ], + ], + [ + 'name' => 'VolumeMountpoint', + 'in' => 'query', + 'schema' => [ + 'description' => 'NAS的VPC挂载点。目前不支持自动创建阿里云NAS挂载点。', + 'type' => 'string', + 'required' => false, + 'example' => '008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com', + ], + ], + [ + 'name' => 'RemoteDirectory', + 'in' => 'query', + 'schema' => [ + 'description' => '挂载文件系统的远程目录。', + 'type' => 'string', + 'required' => false, + 'example' => '/RemoteDirectory', + ], + ], + [ + 'name' => 'OnPremiseVolumeProtocol', + 'in' => 'query', + 'schema' => [ + 'description' => '本地共享存储协议。目前仅支持NFS。', + 'type' => 'string', + 'required' => false, + 'example' => 'NFS', + ], + ], + [ + 'name' => 'OnPremiseVolumeMountPoint', + 'in' => 'query', + 'schema' => [ + 'description' => '本地文件系统挂载点。', + 'type' => 'string', + 'required' => false, + 'example' => 'RemoteNasDomain.com', + ], + ], + [ + 'name' => 'OnPremiseVolumeRemotePath', + 'in' => 'query', + 'schema' => [ + 'description' => '本地文件系统挂载路径。', + 'type' => 'string', + 'required' => false, + 'example' => ' /RemoteDirectory', + ], + ], + [ + 'name' => 'OnPremiseVolumeLocalPath', + 'in' => 'query', + 'schema' => [ + 'description' => '本地文件系统挂载到云上节点的路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/OnCloudDirectory', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '登录节点的root密码。长度为8至30个字符，必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是：'."\n" + .'`() ~ ! @ # $ % ^ & * - = + | { } [ ] : ; ‘ < > , . ? / `'."\n" + ."\n" + .'> 建议使用HTTPS协议调用API避免密码泄露。', + 'type' => 'string', + 'required' => false, + 'example' => '123****', + ], + ], + [ + 'name' => 'KeyPairName', + 'in' => 'query', + 'schema' => [ + 'description' => '密钥对名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头，不能以http://和https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。'."\n" + .'>如果您要使用ECS密钥对功能，具体操作，请参见[创建密钥对](~~51793~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => '扩容节点默认加入的队列。', + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxazb4ph****', + ], + ], + [ + 'name' => 'HybridClusterOpMode', + 'in' => 'query', + 'schema' => [ + 'description' => '代理节点管理线下节点模式。取值范围：'."\n" + ."\n" + .'- SSH：表示SSH登录方式管理。'."\n" + .'- CA：表示云助手方式下发管理。', + 'type' => 'string', + 'required' => false, + 'example' => 'SSH', + ], + ], + [ + 'name' => 'SchedulerPreInstall', + 'in' => 'query', + 'schema' => [ + 'description' => '业务镜像是否已预安装调度器。取值范围：'."\n" + .'- true：已预安装，创建或扩容节点时无需执行安装调度器流程。'."\n" + .'- false：未预安装，创建或扩容节点时需要执行安装调度器流程。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ComputeSpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点抢占策略。取值范围：'."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。'."\n" + ."\n" + .'默认值：NoSpot', + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + ], + [ + 'name' => 'ComputeSpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点下ECS实例的每小时最高价格。支持最多3位小数，参数ComputeSpotStrategy取值为SpotWithPriceLimit时生效。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.034', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像类型。取值范围：'."\n" + .'- system：公共镜像'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像'."\n" + .'- marketplace：镜像市场镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'system', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'wi_1607_x64_dtc_zh_40G_alibase****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'MultiOs', + 'in' => 'query', + 'schema' => [ + 'description' => '集群是否支持多操作系统。取值范围：'."\n" + .'- true：支持多操作系统。'."\n" + .'- false：不支持多操作系统。'."\n" + ."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '本地集群节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息数组。', + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => [ + 'description' => '本地集群节点的调度器类型。取值范围：'."\n" + .'- pbs'."\n" + .'- slurm'."\n" + .'- opengridscheduler'."\n" + .'- deadline'."\n" + ."\n" + .'默认值：pbs', + 'type' => 'string', + 'required' => false, + 'example' => 'pbs', + ], + 'IpAddress' => [ + 'description' => '本地集群节点的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '00b648b****', + ], + 'HostName' => [ + 'description' => '本地集群节点的主机名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + 'Role' => [ + 'description' => '本地集群节点的角色。取值范围：'."\n" + .'- Manager：管控节点'."\n" + .'- Login：登录节点'."\n" + .'- Compute：计算节点', + 'type' => 'string', + 'required' => false, + 'example' => 'Compute', + ], + 'AccountType' => [ + 'description' => '本地集群节点的域账号服务类型。取值范围：'."\n" + .'- nis'."\n" + .'- ldap'."\n" + ."\n" + .'默认值：nis', + 'type' => 'string', + 'required' => false, + 'example' => 'nis', + ], + 'Dir' => [ + 'description' => '本地集群节点的配置目录。', + 'type' => 'string', + 'required' => false, + 'example' => '/opt/sge/default/', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Application', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用软件信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用软件标签信息。最多可绑定5个标签。', + 'type' => 'object', + 'properties' => [ + 'Tag' => [ + 'description' => '应用软件的标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'OpenMPI_11.1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'PostInstallScript', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '安装后脚本信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '安装后脚本信息。最多可配置16个安装后脚本。', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => '安装后脚本的执行参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'bash file.sh', + ], + 'Url' => [ + 'description' => '安装后脚本的全路径。', + 'type' => 'string', + 'required' => false, + 'example' => '/opt/job.sh', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + ], + [ + 'name' => 'Plugin', + 'in' => 'query', + 'schema' => [ + 'description' => '插件模式配置，仅当SchedulerType为custom生效。'."\n" + ."\n" + .'格式为JSON字符串，包含pluginMod、pluginLocalPath、pluginOssPath三个参数，具体参数说明如下：'."\n" + ."\n" + .'- pluginMod：插件模式，支持以下两种模式：'."\n" + ."\n" + .' - oss模式：将从OSS上下载插件解压到本地pluginLocalPath中。'."\n" + ."\n" + .' - image模式：默认插件已经放置到pluginLocalPath。'."\n" + ."\n" + .'- pluginLocalPath：插件存放的本地路径，建议在oss模式下选择共享存储目录，image模式下选择非共享存储目录。'."\n" + ."\n" + .'- pluginOssPath：插件放置在OSS上的远程路径，仅当pluginMod等于oss生效。', + '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' => '对接OpenLDAP服务器参数。', + 'type' => 'object', + 'properties' => [ + 'LdapServerIp' => [ + 'description' => 'LDAP服务器IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.2', + ], + 'BaseDn' => [ + 'description' => 'LDAP服务器BaseDN。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpctest', + ], + 'FallbackHomeDir' => [ + 'description' => 'Linux服务器home目录。', + 'type' => 'string', + 'required' => false, + 'example' => '/home', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'WinAdPar', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '对接Windows AD服务器参数。', + 'type' => 'object', + 'properties' => [ + 'AdUser' => [ + 'description' => 'AD用户。', + 'type' => 'string', + 'required' => false, + 'example' => 'Administrator', + ], + 'AdUserPasswd' => [ + 'description' => 'AD用户密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxx', + ], + 'AdDc' => [ + 'description' => 'AD域名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ad-hybrid001.ehpcad.com', + ], + 'AdIp' => [ + 'description' => 'AD域IP。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C0842122', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C0842122', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + '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' => '创建一个E-HPC混合云集群', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'schema' => [ + 'description' => '本地计算节点信息。JSON格式的字符串，包含本地节点的HostName、IpAddress、CpuCores、Memory（单位MB）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"HostName":"test-HostName","IpAddress":"192.168.**.**"},{"CpuCores":2,"Memory":1024}]', + ], + ], + [ + 'name' => 'Queue', + 'in' => 'query', + 'schema' => [ + 'description' => '本地计算节点所加入的调度器队列信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test.q', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'description' => '集群中本地计算节点的信息列表。', + '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' => '增加本地计算节点到云集群', + 'summary' => '增加本地计算节点到混合云集群或者云上集群。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Node', + 'in' => 'query', + 'schema' => [ + 'description' => '本地计算节点名称，获取本地计算节点配置信息。'."\n" + ."\n" + .'默认获取集群的配置信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'testNode', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterConfig' => [ + 'description' => '配置信息。用于配置本地集群节点。'."\n" + .'- 若参数Node为空，获取的是混合云集群的配置信息。'."\n" + .'- 若参数Node为指定本地计算节点，获取的是本地计算节点的配置信息。', + 'type' => 'string', + 'example' => 'ClNjaGcyI6W119Cg****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '获取混合云集群配置', + 'summary' => '调用GetHybridClusterConfig获取指定混合云集群或指定计算节点的配置信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SyncUsers' => [ + 'summary' => '调用SyncUsers在混合云代理模式下，同步本地集群用户到线上混合云集群中。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n" + .'您可以调用[ListRegions](~~188593~~)查询可以使用E-HPC的地域列表。'."\n" + ."\n\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以调用[ListClusters](~~87116~~)查询可以使用E-HPC的集群列表。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-gh5WKb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '同步本地集群用户到线上混合云集群', + ], + 'ListPreferredEcsTypes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'ECS实例竞价策略。取值范围：'."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。', + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + 'default' => 'NoSpot', + ], + ], + [ + 'name' => 'InstanceChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'ECS实例的付费类型。取值范围：'."\n" + .'- PostPaid：按量付费。'."\n" + .'- PrePaid：包年包月。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'default' => 'PostPaid', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SupportSpotInstance' => [ + 'description' => '是否支持竞价实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Series' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SeriesInfo' => [ + 'description' => '推荐的ECS实例列表，每个系列包含E-HPC集群各种节点对应的推荐规格。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SeriesName' => [ + 'description' => '实例系列名称。可能值：'."\n" + .'- SeriesHighCompute。'."\n" + .'- SeriesHighMem。'."\n" + .'- SeriesGPU。'."\n" + .'- SeriesAll。', + 'type' => 'string', + 'example' => 'SeriesAll', + ], + 'SeriesId' => [ + 'description' => 'ECS实例系列ID。可能值：'."\n" + .'- HighCompute：高计算。'."\n" + .'- HighMem：高存储。'."\n" + .'- GPU：GPU。'."\n" + .'- All：代表全部可选项。', + 'type' => 'string', + 'example' => 'All', + ], + 'Roles' => [ + 'description' => 'E-HPC集群各类节点推荐的规格信息。', + 'type' => 'object', + 'properties' => [ + 'Manager' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceTypeId' => [ + 'description' => '管控节点推荐使用的ECS规格列表。', + 'type' => 'array', + 'items' => [ + 'description' => '管控节点推荐使用的ECS规格列表。', + 'type' => 'string', + 'example' => '[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]', + ], + ], + ], + ], + 'Compute' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceTypeId' => [ + 'description' => '计算节点推荐使用的ECS规格列表。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点推荐使用的ECS规格列表。', + 'type' => 'string', + 'example' => '[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]', + ], + ], + ], + ], + 'Login' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceTypeId' => [ + 'description' => '登录节点推荐使用的ECS规格列表。', + 'type' => 'array', + 'items' => [ + 'description' => '登录节点推荐使用的ECS规格列表。', + 'type' => 'string', + 'example' => '[ "ecs.sn1ne.2xlarge", "ecs.sn1ne.4xlarge", "ecs.n1.tiny" ]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询推荐的ECS实例规格', + 'summary' => '查询 E-HPC 推荐的 ECS 实例规格。', + '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' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => 'ECS实例抢占策略。取值范围：'."\n" + .'- NoSpot：按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式实例。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + 'default' => 'NoSpot', + ], + ], + [ + 'name' => 'InstanceChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'ECS实例的付费类型。取值范围：'."\n" + .'- PostPaid：按量付费'."\n" + .'- PrePaid：包年包月', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'default' => 'PostPaid', + ], + ], + [ + 'name' => 'ShowSoldOut', + 'in' => 'query', + 'schema' => [ + 'description' => '是否显示ECS实例已售罄。取值范围：'."\n" + .'- false：未售罄'."\n" + .'- true：已售罄'."\n" + ."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SupportSpotInstance' => [ + 'description' => '是否支持抢占式实例。可能值：'."\n" + .'- false：不支持'."\n" + .'- true：支持', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D9DD3AF8-1F91-4075-8669-55D10E45****', + ], + 'InstanceTypeFamilies' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceTypeFamilyInfo' => [ + 'description' => '实例规格所属的规格族。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Generation' => [ + 'description' => '实例规格族。', + 'type' => 'string', + 'example' => 'ecs-3', + ], + 'InstanceTypeFamilyId' => [ + 'description' => '实例规格所属的规格族ID。更多详情，请参见[实例规格族](~~25378~~)。', + 'type' => 'string', + 'example' => 'ecs.n4', + ], + 'Types' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TypesInfo' => [ + 'description' => '规格列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'ECS实例状态。可能值：'."\n" + .'- SoldOut：资源已售罄'."\n" + .'- Available：资源充足'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'InstanceTypeId' => [ + 'description' => 'ECS实例规格ID。', + 'type' => 'string', + 'example' => 'ecs.n4.xlarge', + ], + 'InstanceBandwidthRx' => [ + 'description' => '内网入方向带宽限制。单位：kbit/s', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10240000', + ], + 'GPUSpec' => [ + 'description' => 'ECS实例安装的GPU类型。', + 'type' => 'string', + 'example' => 'NVIDIA V100', + ], + 'InstanceBandwidthTx' => [ + 'description' => '内网出方向带宽限制。单位：kbit/s', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10240000', + ], + 'InstancePpsRx' => [ + 'description' => '内网入方向网络收发包能力。单位：Pps', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9000000', + ], + 'InstancePpsTx' => [ + 'description' => '内网出方向网络收发包能力。单位：Pps', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9000000', + ], + 'GPUAmount' => [ + 'description' => 'ECS实例安装的GPU数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'CpuCoreCount' => [ + 'description' => 'vCPU内核数目。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'MemorySize' => [ + 'description' => 'ECS实例内存大小。单位：GiB', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'EniQuantity' => [ + 'description' => 'ECS实例支持挂载的弹性网卡上限。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ZoneIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ZoneId' => [ + 'description' => '可用区ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区ID列表。', + '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' => '查询可用的ECS实例规格资源', + 'summary' => '调用ListAvailableEcsTypes查询可用的ECS实例规格资源。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + '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' => 'ECS实例规格。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ecs.g6.large', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '80CA7A93-7291-4402-B63D-86DF334E0A1F', + ], + 'DefaultHtEnabled' => [ + 'description' => '是否默认开启超线程。可能值：'."\n" + .'- true：默认开启超线程'."\n" + .'- false：默认不开启超线程'."\n" + .'>SCC规格族默认不开启超线程，其他规格族默认开启超线程。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceType' => [ + 'description' => 'ECS实例规格。', + 'type' => 'string', + 'example' => 'ecs.g6.large', + ], + 'SupportHtConfig' => [ + 'description' => '是否支持超线程配置。可能值：'."\n" + .'- true：支持超线程'."\n" + .'- false：不支持超线程', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '查询ECS实例规格是否支持开启和关闭超线程', + 'summary' => '调用GetIfEcsTypeSupportHtConfig查询指定的实例规格是否支持开启和关闭超线程。', + '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' => '基础镜像标签，仅管控节点使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格。'."\n" + .'- 该参数传入值，查询指定实例规格支持安装的镜像信息。'."\n" + .'- 该参数不传值，默认查询所有实例规格支持安装的镜像信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.medium', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'OsTags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'OsInfo' => [ + 'description' => 'E-HPC支持的镜像列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '操作系统版本。', + 'type' => 'string', + 'example' => '7.2', + ], + 'BaseOsTag' => [ + 'description' => '基础镜像标签，仅管控节点使用。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Platform' => [ + 'description' => '操作系统平台。可能值：'."\n" + .'- CentOS'."\n" + .'- windows', + 'type' => 'string', + 'example' => 'CentOS', + ], + 'OsTag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'm-bp1h8aoe73p71iow****', + ], + 'Architecture' => [ + 'description' => '操作系统架构。可能值：'."\n" + .'- i386'."\n" + .'- x86_64', + 'type' => 'string', + 'example' => 'i386', + ], + 'OSName' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'OSNameEn' => [ + 'description' => '镜像名称（英文）。', + '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' => '查询E-HPC支持安装的镜像列表', + 'summary' => '调用ListImages查询E-HPC支持的镜像列表。', + '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' => '镜像来源。取值范围：'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'self', + ], + ], + [ + 'name' => 'BaseOsTag', + 'in' => 'query', + 'schema' => [ + 'description' => '基础镜像标签，仅管控节点使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定实例规格。如果不指定实例规格，则默认查询所有实例规格支持的镜像列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'- 如果指定集群ID，则查询集群所在地域下的所有镜像列表。'."\n" + .'- 如果不指定集群ID，则默认查询所有集群支持的镜像列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Images' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ImageInfo' => [ + 'description' => 'E-HPC支持的自定义镜像和共享镜像的列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '>该参数未开放使用。', + 'type' => 'string', + 'example' => 'Available', + ], + 'PostInstallScript' => [ + 'description' => '>该参数未开放使用。', + 'type' => 'string', + 'example' => 'example.sh', + ], + 'Description' => [ + 'description' => '镜像描述。', + 'type' => 'string', + 'example' => 'ExampleDescription', + ], + 'Size' => [ + 'description' => '镜像大小。单位：GiB', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'ImageOwnerAlias' => [ + 'description' => '镜像类型。可能值：'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像', + 'type' => 'string', + 'example' => 'self', + ], + 'ImageName' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'CHESS5V5.0.27', + ], + 'SkuCode' => [ + 'description' => '>该参数未开放使用。', + 'type' => 'string', + 'example' => 'ECS', + ], + 'PricingCycle' => [ + 'description' => '>该参数未开放使用。', + 'type' => 'string', + 'example' => 'Month', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'm-bp181x855551ww5yq****', + ], + 'ProductCode' => [ + 'description' => '>该参数未开放使用。', + 'type' => 'string', + 'example' => 'cmjj028279', + ], + 'Uid' => [ + 'description' => '>该参数未开放使用。', + 'type' => 'string', + 'example' => '127****', + ], + 'BaseOsTag' => [ + 'description' => '基础镜像标签。', + 'type' => 'object', + 'properties' => [ + 'Platform' => [ + 'description' => '操作系统平台。可能值：'."\n" + .'- CentOS'."\n" + .'- windows', + 'type' => 'string', + 'example' => 'CentOS', + ], + 'OsTag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Version' => [ + 'description' => '操作系统版本。', + 'type' => 'string', + 'example' => '7.2', + ], + 'Architecture' => [ + 'description' => '操作系统架构。可能值：'."\n" + .'- i386'."\n" + .'- x86_64', + 'type' => 'string', + 'example' => 'i386', + ], + ], + ], + 'OsTag' => [ + 'description' => 'E-HPC支持的操作系统镜像。', + 'type' => 'object', + 'properties' => [ + 'Platform' => [ + 'description' => '操作系统平台。', + 'type' => 'string', + 'example' => 'CentOS', + ], + 'OsTag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Version' => [ + 'description' => '操作系统版本。', + 'type' => 'string', + 'example' => '7.2', + ], + 'Architecture' => [ + 'description' => '操作系统架构。可能值：'."\n" + .'- i386'."\n" + .'- x86_64', + 'type' => 'string', + 'example' => 'x86_64', + ], + 'BaseOsTag' => [ + 'description' => '基础镜像标签。', + '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 \\"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' => '查询自定义和共享的镜像列表', + 'summary' => '查询E-HPC产品支持的自定义和共享的镜像列表。', + ], + 'ListCommunityImages' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BaseOsTag', + 'in' => 'query', + 'schema' => [ + 'description' => '基础镜像操作系统标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定实例规格。如果不指定实例规格，则默认查询所有实例规格支持的镜像列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定集群ID。如果该集群支持多操作系统，则查询集群所在地域下的所有镜像列表。'."\n" + ."\n" + .'如果不指定集群ID，则默认查询所有集群支持的镜像列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Images' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ImageInfo' => [ + 'description' => 'E-HPC支持的自定义镜像和共享镜像的列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '镜像状态。可能值：'."\n" + ."\n" + .'- UnAvailable：不可用'."\n" + ."\n" + .'- Available：可用'."\n" + ."\n" + .'- Creating：创建中'."\n" + ."\n" + .'- CreateFailed：创建失败', + 'type' => 'string', + 'example' => 'Available', + ], + 'PostInstallScript' => [ + 'description' => '安装镜像后执行的脚本。', + 'type' => 'string', + 'example' => 'example.sh', + ], + 'Description' => [ + 'description' => '镜像描述。', + 'type' => 'string', + 'example' => 'ExampleDescription', + ], + 'Size' => [ + 'description' => '镜像大小。单位：GiB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'ImageOwnerAlias' => [ + 'description' => '镜像类型。可能值：'."\n" + ."\n" + .'- self：自定义镜像'."\n" + ."\n" + .'- others：共享镜像', + 'type' => 'string', + 'example' => 'self', + ], + 'ImageName' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'linux_CentOS7.2_OceanBase_OBD_1ECS-3OB_3.0', + ], + 'SkuCode' => [ + 'description' => '商品规格码。可能值：'."\n" + ."\n" + .'- ECS：按量付费'."\n" + ."\n" + .'- package：预付费', + 'type' => 'string', + 'example' => 'ECS', + ], + 'PricingCycle' => [ + 'description' => '镜像计费单位，可能值：'."\n" + ."\n" + .'- Hour：按小时付费'."\n" + ."\n" + .'- Month：按月付费'."\n" + ."\n" + .'- Year：按年付费', + 'type' => 'string', + 'example' => 'Month', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'm-bp181x855551ww5yq****', + ], + 'ProductCode' => [ + 'description' => '云市场的商品标识。', + 'type' => 'string', + 'example' => 'cmjj028279', + ], + 'Uid' => [ + 'description' => '镜像所有者。'."\n" + ."\n", + 'type' => 'string', + 'example' => '127****', + ], + 'BaseOsTag' => [ + 'description' => '对应的基础镜像操作系统标签。', + 'type' => 'object', + 'properties' => [ + 'Platform' => [ + 'description' => "\n" + .'操作系统发行版。可能值：'."\n" + ."\n" + .'- CentOS'."\n" + ."\n" + .'- Ubuntu'."\n" + ."\n" + .'- SUSE'."\n" + ."\n" + .'- OpenSUSE'."\n" + ."\n" + .'- Debian'."\n" + ."\n" + .'- CoreOS'."\n" + ."\n" + .'- Aliyun'."\n" + ."\n" + .'- Windows Server 2003'."\n" + ."\n" + .'- Windows Server 2008'."\n" + ."\n" + .'- Windows Server 2012'."\n" + ."\n" + .'- Others Linux'."\n" + ."\n" + .'- Customized Linux', + 'type' => 'string', + 'example' => 'CentOS', + ], + 'OsTag' => [ + 'description' => '操作系统镜像标签。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Version' => [ + 'description' => '操作系统版本。'."\n" + ."\n", + 'type' => 'string', + 'example' => '7.2', + ], + 'Architecture' => [ + 'description' => '操作系统架构。可能值：'."\n" + ."\n" + .'- i386'."\n" + ."\n" + .'- x86_64'."\n", + 'type' => 'string', + 'example' => 'x86_64', + ], + ], + ], + 'OsTag' => [ + 'description' => 'E-HPC支持的操作系统镜像。', + 'type' => 'object', + 'properties' => [ + 'Platform' => [ + 'description' => '操作系统平台。', + 'type' => 'string', + 'example' => 'CentOS', + ], + 'OsTag' => [ + 'description' => '操作系统镜像标签。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'Version' => [ + 'description' => '操作系统版本。', + 'type' => 'string', + 'example' => '7.2', + ], + 'Architecture' => [ + 'description' => '操作系统架构。可能值：'."\n" + .'- i386'."\n" + ."\n" + .'- x86_64', + 'type' => 'string', + 'example' => 'x86_64', + ], + 'BaseOsTag' => [ + 'description' => '对应的基础镜像操作系统标签。', + '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-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' => '查询社区镜像', + 'summary' => '查询社区镜像。', + ], + 'DescribeImagePrice' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'm-bp198jigq7l1ga11****', + ], + ], + [ + 'name' => 'PriceUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '购买时长的单位。取值范围：'."\n" + ."\n" + .'- Day：日'."\n" + .'- Month：月'."\n" + .'- Year：年'."\n" + ."\n" + .'默认值：Day', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Day', + ], + ], + [ + 'name' => 'SkuCode', + 'in' => 'query', + 'schema' => [ + 'description' => '商品规格码。当前仅支持：package（预付费）', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'package', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '购买时长。取值范围：'."\n" + .'- 当参数PriceUnit取值为Day时：1~30'."\n" + .'- 当参数PriceUnit取值为Month时：1~9'."\n" + .'- 当参数PriceUnit取值为Year时：1~3'."\n" + ."\n\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Amount', + 'in' => 'query', + 'schema' => [ + 'description' => '购买数量。取值范围：1~1000'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '订单类型，仅支持设置为商品购买。取值：INSTANCE-BUY'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'INSTANCE-BUY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Amount' => [ + 'description' => '购买数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '47ca3ac4-2a03-48f1-8bf2-ba6de0f3****', + ], + 'DiscountPrice' => [ + 'description' => '折扣。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + 'TradePrice' => [ + 'description' => '交易价格。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'OriginalPrice' => [ + 'description' => '原价。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.8', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'm-bp198jigq7l1ga11****', + ], + ], + ], + ], + ], + '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' => '查询E-HPC支持的镜像市场镜像价格', + 'summary' => '调用DescribeImagePrice查询E-HPC支持的镜像市场的镜像价格。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户信息。可以传入1~100个用户信息。', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息数组。', + 'type' => 'object', + 'properties' => [ + 'Password' => [ + 'description' => '新增用户的密码。长度为8~30个字符，必须同时包含以下四项中的三项：'."\n" + ."\n" + .'- 大写英文字母'."\n" + .'- 小写英文字母'."\n" + .'- 数字'."\n" + .'- 特殊字符：`()~!@#$%^&*-_+=|{}[]:;\'/<>,.?/`'."\n" + ."\n" + .'> 建议使用HTTPS协议调用API以避免可能发生的密码泄露。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1@a2****', + ], + 'Name' => [ + 'description' => '新增用户的用户名。长度为6~30个字符，必须以英文字母开头，可以包含数字、特殊字符（.）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'user1', + ], + 'Group' => [ + 'description' => '新增用户的用户组。取值范围：'."\n" + .'- users：普通权限组，适用于只有提交、调试作业需求的普通用户。 '."\n" + .'- wheel：sudo权限组，适用于需要管理集群的管理员，除提交、调试作业外，还可以执行sudo命令进行安装软件、重启节点等操作。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'users', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '是否采用异步消息链路新增用户。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '批量新增集群用户', + 'summary' => '调用AddUsers为指定集群新增一个或多个用户。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'起始值：1'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。取值范围：1~50'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Users' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UserInfo' => [ + 'description' => '用户列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'user1', + ], + 'AddTime' => [ + 'description' => '添加用户的时间。', + 'type' => 'string', + 'example' => '2018-07-18T17:46:47', + ], + 'Group' => [ + 'description' => '用户组。可能值：'."\n" + ."\n" + .'- users：普通权限组，适用于只有提交、调试作业需求的普通用户。'."\n" + .'- wheel：sudo权限组，适用于需要管理集群的管理员，除提交、调试作业外，还可以执行sudo命令进行安装软件、重启节点等操作。', + 'type' => 'string', + 'example' => 'wheel', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群用户列表', + 'summary' => '调用ListUsers查询集群用户列表。', + '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' => '集群ID。您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-vu7c2WkVGx', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。 '."\n" + .'起始值：1。 '."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。 '."\n" + .'取值范围：1~50。 '."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'AsyncId', + 'in' => 'query', + 'schema' => [ + 'description' => '异步任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 't-hz02xltxaex1q80', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9A05F620-ED46-4A57-95F1-C67D6D3C5DD2', + ], + 'PageNumber' => [ + 'description' => '显示的页码，起始值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '用户总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Users' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UserInfo' => [ + 'description' => '用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'testuser', + ], + 'AddTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-09-28T09:05:26.000Z', + ], + 'Group' => [ + 'description' => '用户组。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'wheel', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '1000', + ], + 'GroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => '10', + ], + ], + ], + ], + ], + ], + 'AsyncId' => [ + 'description' => '异步任务ID。', + 'type' => 'string', + 'example' => 't-sh03egi3mls****', + ], + 'AsyncStatus' => [ + 'description' => '异步任务状态。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + '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' => '异步查询集群用户列表', + 'summary' => '调用ListUsersAsync异步查询集群中的用户列表。', + ], + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户信息。可以传入1~100个用户信息。', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息数组。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '要修改权限的用户名。'."\n" + ."\n" + .'您可以通过调用[ListUsers](~~188572~~)获取该集群中的用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'user11', + ], + 'Group' => [ + 'description' => '需要修改的用户组。取值范围：'."\n" + ."\n" + .'- users：普通权限组，适用于只有提交、调试作业需求的普通用户。'."\n" + .'- wheel：sudo权限组，适用于需要管理集群的管理员，除提交、调试作业外，还可以执行sudo命令进行安装软件、重启节点等操作。', + 'type' => 'string', + 'required' => false, + 'example' => 'users', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '是否采用异步消息链路修改用户组。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '批量修改用户所属用户组', + 'summary' => '调用ModifyUserGroups修改一个或多个用户所属的用户组。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户信息。可以传入1~100个用户信息。', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息数组。', + 'type' => 'object', + 'properties' => [ + 'Password' => [ + 'description' => '用户的新密码。长度为8~30个字符，必须同时包含一下四项中的三项：'."\n" + ."\n" + .'- 大写英文字母'."\n" + .'- 小写英文字母'."\n" + .'- 数字'."\n" + .'- 特殊字符：`()~!@#$%^&*-_+=|{}[]:;\'/<>,.?/`'."\n" + ."\n" + .'>建议使用HTTPS协议调用API以避免可能发生的密码泄露。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1@a****', + ], + 'Name' => [ + 'description' => '要修改密码的用户的用户名。'."\n" + ."\n" + .'您可以通过调用[ListUsers](~~188572~~)获取该集群中的用户名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'user1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '采用异步消息链路修改用户密码。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '批量修改用户的密码', + 'summary' => '调用ModifyUserPasswords修改一个或多个用户的密码。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用户信息。', + 'type' => 'array', + 'items' => [ + 'description' => '用户信息数组。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '第N个要删除的用户名。N的取值范围：1~100'."\n" + ."\n" + .'您可以通过调用[ListUsers](~~188572~~)获取该集群中的用户名。', + 'type' => 'string', + 'required' => true, + 'example' => 'user1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '采用异步消息链路删除用户。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '批量删除用户账号', + 'summary' => '调用DeleteUsers删除一个或多个集群用户。', + 'description' => '## 接口说明'."\n" + .'删除用户时仅删除用户信息，不删除存储在用户home目录下的文件。例如删除一个名为user1的用户，集群目录`/home/user1/`下的文件不会被删除。但被删除的用户不可恢复，即使再次创建同名用户也不会复用保留的数据。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddNodes' => [ + 'summary' => '调用AddNodes添加一个或多个计算节点到指定集群。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '待添加节点的集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像类型。取值范围：'."\n" + .'- system：公共镜像'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像'."\n" + .'- marketplace：镜像市场镜像'."\n" + ."\n" + .'默认值：system', + 'type' => 'string', + 'required' => false, + 'example' => 'system', + 'default' => 'system', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '为待加入集群的计算节点指定的镜像，该镜像需满足以下条件：'."\n" + ."\n" + .'- 指定的镜像的操作系统应与集群中节点的操作系统保持一致。如：集群中节点的操作系统为CentOS时，只能指定CentOS镜像。'."\n" + .'> 如果集群为混合云集群，并且开启支持多系统功能，当集群中节点的操作系统为Windows时，指定的镜像可以为Windows、CentOS。'."\n" + ."\n" + .'- 指定的镜像应与集群节点的镜像大版本号保持一致，如待加入集群为CentOS 7.x，指定的镜像也应该为CentOS 7.x。'."\n" + ."\n" + .'您可以通过调用[ListImages](~~87213~~)和[ListCustomImages](~~87215~~)接口获取镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_06_64_20G_alibase_20190711.vhd', + ], + ], + [ + 'name' => 'Count', + 'in' => 'query', + 'schema' => [ + 'description' => '添加的计算节点数量。取值范围：1~99，并且MinCount<Count。'."\n" + ."\n" + .'- ECS库存数量<MinCount，添加节点失败。'."\n" + ."\n" + .'- MinCount<ECS库存数量<Count，按照MinCount指定的数量添加节点。'."\n" + ."\n" + .'- Count<ECS库存数量，按照Count指定的数量添加节点。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '扩容的实例规格，默认使用上次扩容或者创建集群时的计算节点实例规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'ComputeSpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点抢占策略。当参数EcsChargeType取值为PostPaid时才生效。取值范围：'."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式实例。'."\n" + ."\n" + .'默认值：NoSpot', + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + ], + [ + 'name' => 'ComputeSpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点每小时最高价格，支持最多3位小数。参数SpotStrategy取值为SpotWithPriceLimit时生效。', + 'type' => 'string', + 'required' => false, + 'example' => '0.68', + ], + ], + [ + 'name' => 'EcsChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群使用节点的付费类型。取值范围：'."\n" + .'- PostPaid：按量付费'."\n" + .'- PrePaid：包年包月'."\n" + ."\n" + .'默认值：PostPaid'."\n" + ."\n" + .'若选择包年包月类型，默认开启自动续费，集群释放后节点将关闭自动续费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + 'default' => 'PostPaid', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => [ + 'description' => '购买资源的时长，单位由PeriodUnit指定。当参数InstanceChargeType取值为PrePaid时才生效且为必选值。取值范围：'."\n" + .'- PeriodUnit=Week时，Period取值：{“1”, “2”, “3”, “4”}。'."\n" + .'- PeriodUnit=Month时，Period取值：{“1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “12”, “24”, “36”, ”48”, ”60”}。'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'query', + 'schema' => [ + 'description' => '购买资源的时长。取值范围：'."\n" + .'- Week'."\n" + .'- Month'."\n" + ."\n" + .'默认值：Month', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动续费，当参数EcsChargeType取值为PrePaid时才生效。取值范围：'."\n" + .'- true：自动续费'."\n" + .'- false：不自动续费'."\n" + ."\n" + .'默认值：true', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'AutoRenewPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '每次自动续费的时长。参数AutoRenew取值true时生效。'."\n" + .'- PeriodUnit为Week时，AutoRenewPeriod取值{"1", "2", "3"}。'."\n" + .'- PeriodUnit为Month时，AutoRenewPeriod取值{"1", "2", "3", "6", "12"}。'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点加入的队列名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'CreateMode', + 'in' => 'query', + 'schema' => [ + 'description' => '节点创建方式。取值范围：'."\n" + .'- manual：手动扩容'."\n" + .'- autoscale：自动扩容'."\n" + ."\n" + .'默认值：manual', + 'type' => 'string', + 'required' => false, + 'example' => 'manual', + ], + ], + [ + 'name' => 'SystemDiskType', + 'in' => 'query', + 'schema' => [ + 'description' => '系统盘的云盘类型。取值范围：'."\n" + .'- cloud_efficiency：高效云盘'."\n" + .'- cloud_ssd：SSD云盘'."\n" + .'- cloud_essd：ESSD云盘'."\n" + .'- cloud：普通云盘，已停售。'."\n" + ."\n" + .'默认值：cloud_efficiency', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + ], + [ + 'name' => 'SystemDiskSize', + 'in' => 'query', + 'schema' => [ + 'description' => '系统盘的大小。单位：GiB'."\n" + ."\n" + .'取值范围：40~500'."\n" + ."\n" + .'默认值：40', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + ], + [ + 'name' => 'HostNamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '主机名前缀。方便您分类管理节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + ], + [ + 'name' => 'HostNameSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => '主机名后缀。方便您分类管理节点。', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'ComputeEnableHt', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点是否支持超线程。取值范围：'."\n" + .'- true：支持超线程'."\n" + .'- false：不支持超线程'."\n" + ."\n" + .'默认值：true', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AllocatePublicAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '是否分配公网地址。取值范围：'."\n" + .'- true：分配公网地址'."\n" + .'- false：不分配公网地址'."\n" + ."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'InternetChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性公网IP付费类型。取值范围：'."\n" + .'- PayByBandwidth：按固定带宽收费'."\n" + .'- PayByTraffic：按使用流量计费', + 'type' => 'string', + 'required' => false, + 'example' => 'PayByTraffic', + 'default' => 'PayByTraffic', + ], + ], + [ + 'name' => 'InternetMaxBandWidthIn', + 'in' => 'query', + 'schema' => [ + 'description' => '公网入带宽最大值，单位为Mbit/s。取值范围：'."\n" + ."\n" + .'- 当所购公网出带宽小于等于10Mbit/s时：1~10，默认为10。'."\n" + .'- 当所购公网出带宽大于10Mbit/s时：1~InternetMaxBandWidthOut的取值，默认为InternetMaxBandWidthOut的取值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '0', + ], + ], + [ + 'name' => 'InternetMaxBandWidthOut', + 'in' => 'query', + 'schema' => [ + 'description' => '公网出带宽最大值，单位为Mbit/s。取值范围：0~100'."\n" + ."\n" + .'默认值：0', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '0', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'SystemDiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '创建ESSD云盘作为系统盘使用时，设置云盘的性能等级。取值范围：'."\n" + .'- PL0：单盘最高随机读写IOPS 1万'."\n" + .'- PL1：单盘最高随机读写IOPS 5万'."\n" + .'- PL2：单盘最高随机读写IOPS 10万'."\n" + .'- PL3：单盘最高随机读写IOPS 100万'."\n" + ."\n" + .'默认值：PL1'."\n" + ."\n" + .'更多ESSD性能参数，请参见[ESSD云盘](~~122389~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL0', + ], + ], + [ + 'name' => 'MinCount', + 'in' => 'query', + 'schema' => [ + 'description' => '指定最小添加的节点数量。取值范围：1~99，并且MinCount<Count。'."\n" + ."\n" + .'- ECS库存数量<MinCount，添加节点失败。'."\n" + ."\n" + .'- MinCount<ECS库存数量<Count，按照MinCount指定的数量添加节点。'."\n" + ."\n" + .'- Count<ECS库存数量，按照Count指定的数量添加节点。'."\n" + ."\n" + .'默认值：1'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Sync', + 'in' => 'query', + 'schema' => [ + 'description' => '是否设置该接口为同步接口。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DataDisks', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '随节点创建的数据盘信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DataDiskSize' => [ + 'description' => '第N个随节点创建的数据盘容量大小。单位：GB'."\n" + ."\n" + .'取值范围：40~500'."\n" + ."\n" + .'默认值：40'."\n" + ."\n" + .'N的取值范围：0~16', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + 'DataDiskCategory' => [ + 'description' => '第N个随节点创建的数据盘类型。可能值：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘'."\n" + ."\n" + .'- cloud_ssd：SSD云盘'."\n" + ."\n" + .'- cloud_essd：ESSD云盘'."\n" + ."\n" + .'- cloud：普通云盘'."\n" + ."\n" + .'默认值：cloud_efficiency'."\n" + ."\n" + .'N的取值范围：0~16', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_efficiency', + ], + 'DataDiskDeleteWithInstance' => [ + 'description' => '第N个随节点创建的数据盘是否随实例释放。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'默认值：true'."\n" + ."\n" + .'N的取值范围：0~16', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'DataDiskPerformanceLevel' => [ + 'description' => '第N个随节点创建的数据盘类型为ESSD云盘时，区分性能等级。仅当DataDisks.N.DataDiskCategory=cloud_essd时该参数有效。取值范围：'."\n" + .'- PL0：单盘最高随机读写IOPS 1万'."\n" + .'- PL1：单盘最高随机读写IOPS 5万'."\n" + .'- PL2：单盘最高随机读写IOPS 10万'."\n" + .'- PL3：单盘最高随机读写IOPS 100万'."\n" + ."\n" + .'默认值：PL1'."\n" + ."\n" + .'N的取值范围：0~16', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'DataDiskEncrypted' => [ + 'description' => '第N个随节点创建的数据盘是否加密。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'默认值：false'."\n" + ."\n" + .'N的取值范围：0~16', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'DataDiskKMSKeyId' => [ + 'description' => '第N个随节点创建的数据盘使用的KMS密钥ID。'."\n" + ."\n" + .'N的取值范围：0~16'."\n" + ."\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' => '抢占式实例的保护期，单位为小时。取值范围为0~1，设置为0表示无保护期，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '6', + 'minimum' => '0', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ComputeSpotInterruptionBehavior', + 'in' => 'query', + 'schema' => [ + 'title' => '抢占实例中断模式。目前仅支持Terminate（默认）直接释放实例。', + 'description' => '抢占实例中断模式。目前仅支持Terminate（默认）直接释放实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'Terminate', + 'default' => 'Terminate', + ], + ], + [ + 'name' => 'NetworkInterfaceTrafficMode', + 'in' => 'query', + 'schema' => [ + 'description' => '网卡的通讯模式。参数取值范围：'."\n" + ."\n" + .'- Standard：使用TCP通讯模式。'."\n" + ."\n\n" + .'- HighPerformance：开启ERI（Elastic RDMA Interface）接口，使用RDMA通讯模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'DnsConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNS配置信息。', + 'type' => 'string', + 'required' => false, + 'example' => '"{\\"DnsType\\":\\"PrivateZone\\",\\"DnsName\\":\\"xxxxx\\"}"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。'."\n" + ."\n" + .' > 如果AddNodes是异步操作（请求参数Sync为False），请求成功就会立即返回结果，不会等待实例创建成功，因此InstanceIds内容为空。您可以通过[ListNodes](~~87161~~)获取InstanceId。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '批量增加计算节点', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ApplyNodes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '待添加节点的集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87126~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '待添加节点的镜像ID，仅在未指定TargetImageId时，ImageId生效。'."\n" + ."\n" + .'您可以通过调用[ListImages](~~87213~~)和[ListCustomImages](~~87215~~)接口获取镜像ID。'."\n" + ."\n" + .'>如果添加多个节点，仅指定了TargetImageId的节点会使用TargetImageId。', + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_06_64_20G_alibase_20190711.vhd', + ], + ], + [ + 'name' => 'ComputeSpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点抢占策略。取值范围：'."\n" + ."\n" + .'- NoSpot：按量计费节点。'."\n" + ."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + ."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式实例。'."\n" + ."\n" + .'默认值：NoSpot', + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + ], + [ + 'name' => 'ComputeSpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点每小时最高价格，取值是浮点数，最多支持3位小数。参数ComputeSpotStrategy取值为SpotWithPriceLimit时生效。'."\n" + ."\n" + .'当同时设置了ComputeSpotPriceLimit与InstanceTypeModel.N.MaxPrice时，按两者的最小值创建计算节点。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.68', + ], + ], + [ + 'name' => 'SystemDiskType', + 'in' => 'query', + 'schema' => [ + 'description' => '系统盘的云盘类型。取值范围：'."\n" + .'- cloud_efficiency：高效云盘'."\n" + .'- cloud_ssd：SSD云盘'."\n" + .'- cloud_essd：ESSD云盘'."\n" + .'- cloud：普通云盘，已停售', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + ], + [ + 'name' => 'SystemDiskSize', + 'in' => 'query', + 'schema' => [ + 'description' => '系统盘的大小。单位：GB'."\n" + ."\n" + .'取值范围：40~500'."\n" + ."\n" + .'默认值：40', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + ], + [ + 'name' => 'HostNamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '主机名前缀。方便您分类管理节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + ], + [ + 'name' => 'HostNameSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => '主机名后缀。方便您分类管理节点。', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + [ + 'name' => 'AllocatePublicAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '是否分配公网地址。取值范围：'."\n" + ."\n" + .'- true：分配公网地址'."\n" + ."\n" + .'- false：不分配公网地址'."\n" + ."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'InternetChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性公网IP付费类型。取值范围：'."\n" + ."\n" + .'- PayByBandwidth：按固定带宽收费'."\n" + ."\n" + .'- PayByTraffic：按使用流量计费', + 'type' => 'string', + 'required' => false, + 'example' => 'PayByTraffic', + 'default' => 'PayByTraffic', + ], + ], + [ + 'name' => 'InternetMaxBandWidthIn', + 'in' => 'query', + 'schema' => [ + 'description' => '公网入带宽最大值，单位为Mbit/s。取值范围：'."\n" + ."\n" + .'- 当所购公网出带宽小于等于10Mbit/s时：1~10，默认为10。'."\n" + ."\n" + .'- 当所购公网出带宽大于10Mbit/s时：1~InternetMaxBandWidthOut的取值，默认为InternetMaxBandWidthOut的取值。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '0', + ], + ], + [ + 'name' => 'InternetMaxBandWidthOut', + 'in' => 'query', + 'schema' => [ + 'description' => '公网出带宽最大值，单位为Mbit/s。取值范围：0~100'."\n" + ."\n" + .'默认值：0', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '0', + 'example' => '10', + 'default' => '0', + ], + ], + [ + 'name' => 'Cores', + 'in' => 'query', + 'schema' => [ + 'description' => 'vCPU个数。当参数ResourceAmountType为Cores时，该参数为必选。'."\n" + ."\n" + .'同时指定vCPU和Memory可以定义节点规格。例如，vCPU=2、Memory=16可以定义配置为2 vCPU、16 GB的所有节点规格。结合节点规格、可用区等因素确定可用节点规格集合，并根据价格排序为您创建价格最低的节点。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'query', + 'schema' => [ + 'description' => '内存大小，当参数ResourceAmountType为Cores时，该参数为必选。单位：GB。'."\n" + ."\n" + .'同时指定vCPU和Memory可以定义节点规格。例如，vCPU=2、Memory=16可以定义配置为2 vCPU、16 GB的所有节点规格。结合节点规格、可用区等因素确定可用节点规格集合，并根据价格排序为您创建价格最低的节点。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '16', + ], + ], + [ + 'name' => 'InstanceFamilyLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '实例规格族级别，在指定Cores和Memory时才生效。取值范围：'."\n" + ."\n" + .'- EntryLevel：入门级。'."\n" + ."\n" + .'- EnterpriseLevel：企业级。'."\n" + ."\n" + .'- CreditEntryLevel：积分入门级。更多信息，请参见[突发性能实例](~~59977~~)。'."\n" + ."\n" + .'默认值：EnterpriseLevel', + 'type' => 'string', + 'required' => false, + 'example' => 'EntryLevel', + ], + ], + [ + 'name' => 'TargetCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => '期望添加的资源数量，具体资源数量依赖ResourceAmountType取值。'."\n" + ."\n" + .'- 当ResourceAmountType取值为Instance时，TargetCapacity取值范围：1~200'."\n" + ."\n" + .'- 当ResourceAmountType取值为Cores时，TargetCapacity取值范围：1~1000', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'ResourceAmountType', + 'in' => 'query', + 'schema' => [ + 'description' => '期望添加的资源类型。取值范围：'."\n" + ."\n" + .'- Instances：计算节点对应的ECS实例'."\n" + ."\n" + .'- Cores：vCPU和内存'."\n" + ."\n" + .'默认值：Instances', + 'type' => 'string', + 'required' => false, + 'example' => 'Instances', + ], + ], + [ + 'name' => 'PriorityStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '抢占式节点申请策略。取值范围：'."\n" + ."\n" + .'- LowPriceResourcePlanning：按vCPU单价从低到高进行尝试创建。当设置了抢占式计费方式的多节点规格时，优先创建对应抢占式计费节点。'."\n" + ."\n" + .'- CapacityOptResourcePlanning：按照价格更低及释放率更低的方式综合编排创建。'."\n" + ."\n" + .'- CustomizedResourcePlanning：根据预先定义的可用区（ZoneIds.N）扩容。当优先级较高的可用区没有实例库存时，自动使用下一优先级的可用区。', + 'type' => 'string', + 'required' => false, + 'example' => 'LowPriceResourcePlanning', + ], + ], + [ + 'name' => 'StrictSatisfiedTargetCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => '是否满足TargetCapacity的数量要求。取值范围：'."\n" + ."\n" + .'- true：如果库存不足，则不创建任何节点并返回报错。如果库存充足，会存在以下两种情况：'."\n" + .' - StrictResourceProvision为true：检查库存，如果库存充足才会创建节点，并严格按期望数量创建节点，否则就不创建任何节点。'."\n" + .' - StrictResourceProvision为false：检查库存，如果库存充足才会创建节点，但实际可能会因为先查询库存量，创建节点时实时库存不足而创建部分节点。'."\n" + ."\n" + .'- false：如果库存不足，则按库存量创建部分节点。'."\n" + ."\n" + .'默认值：true', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'SystemDiskLevel', + 'in' => 'query', + 'schema' => [ + 'description' => '创建ESSD云盘作为系统盘使用时，设置云盘的性能等级。取值范围：'."\n" + .'- PL0：单盘最高随机读写IOPS 1万'."\n" + .'- PL1：单盘最高随机读写IOPS 5万'."\n" + .'- PL2：单盘最高随机读写IOPS 10万'."\n" + .'- PL3：单盘最高随机读写IOPS 100万'."\n" + ."\n" + .'默认值：PL0'."\n" + .'关于如何选择ESSD性能等级，请参见[ESSD云盘](~~122389~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL0', + ], + ], + [ + 'name' => 'StrictResourceProvision', + 'in' => 'query', + 'schema' => [ + 'description' => '是否必须满足TargetCapacity的数量要求。当StrictSatisfiedTargetCapacity为true时生效。取值范围：'."\n" + ."\n" + .'- true：检查库存，如果库存充足才会创建节点，并严格按期望数量创建节点，否则就不创建任何节点。'."\n" + .'- false：检查库存，如果库存充足才会创建节点，但实际可能会因为先查询库存量，创建节点时实时库存不足而创建部分节点。'."\n" + ."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Round', + 'in' => 'query', + 'schema' => [ + 'description' => '分批创建节点的总批数。 取值范围：1~10'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'Interval', + 'in' => 'query', + 'schema' => [ + 'description' => '分批创建节点的时间间隔。单位：秒，取值范围：60~600'."\n" + ."\n" + .'默认值：60', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '600', + 'minimum' => '60', + 'example' => '60', + 'default' => '60', + ], + ], + [ + 'name' => 'ZoneInfos', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '可用区信息。最多可以添加10个。', + 'type' => 'array', + 'items' => [ + 'description' => '可用区信息数组。', + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => '待添加节点的交换机ID。N的取值范围：1~10。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'vsw-bp1e47optm9g58zcu****', + ], + 'ZoneId' => [ + 'description' => '待添加节点的可用区ID。N的取值范围：1~10。'."\n" + ."\n" + .'>多个可用区ID之间不能相同。', + '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' => '抢占式实例信息。', + 'type' => 'array', + 'items' => [ + 'description' => '抢占式实例信息数组。', + 'type' => 'object', + 'properties' => [ + 'MaxPrice' => [ + 'description' => '您可以为该抢占式实例支付的每小时最高价格。取值是浮点数，最多支持3位小数。'."\n" + ."\n" + .'当参数ComputeSpotStrategy取值为SpotWithPriceLimit时才生效。'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.034', + ], + 'TargetImageId' => [ + 'description' => '待添加节点的镜像ID，该镜像必须为Windows镜像。'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'string', + 'required' => false, + 'example' => 'win2016_1607_x64_dtc_zh-cn_40G_alibase_20210516.vhd', + ], + 'InstanceType' => [ + 'description' => '待添加的节点规格，默认使用上次扩容或者创建集群时的计算节点规格。'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息数组。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '待添加节点的标签键。一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或 https://。'."\n" + ."\n" + .'N的取值范围：1~20', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '待添加节点的标签值。一旦传入该值，可以为空字符串。最多支持128个字符，不能以acs:开头，不能包含http://或者https://。'."\n" + ."\n" + .'N的取值范围：1~20', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 19, + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点加入的队列名称。'."\n" + ."\n" + .'您可以通过调用[ListQueues](~~92176~~)获取已有队列名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'description' => '实例自定义数据。需要以 Base64 方式编码，原始数据最多为 16 KB。Linux操作系统支持shell脚本；Windows操作系统支持bat和powershell两种格式，在Base64编码前，第一行为[bat]或者[powershell]。'."\n" + .'> 因为传输 API 请求时，不会加密您设置的 UserData，建议不要以明文方式传入机密的信息，例如密码和私钥等。如果必须传入，建议加密后，然后以 Base64 的方式编码后再传入，在实例内部以同样的方式反解密。', + 'type' => 'string', + 'required' => false, + 'example' => 'ZWNobyBoZWxsbyBlY3Mh'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'SatisfiedAmount' => [ + 'description' => '创建成功的计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TaskId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'Detail' => [ + 'description' => 'API调用结果详情。', + 'type' => 'string', + 'example' => 'Resources Application is satisfied. Creating...', + ], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'description' => '实例ID。'."\n" + ."\n" + .' > 由于ApplyNodes是异步操作，请求成功就会立即返回结果，不会等待实例创建成功，因此InstanceIds内容为空。您可以通过[ListNodes](~~87161~~)获取InstanceId。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。'."\n" + ."\n" + .' > 由于ApplyNodes是异步操作，请求成功就会立即返回结果，不会等待实例创建成功，因此InstanceIds内容为空。您可以通过[ListNodes](~~87161~~)获取InstanceId。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '批量添加节点到指定集群', + 'summary' => '调用ApplyNodes添加一个或多个按量计费或抢占式计算节点到指定集群中。', + 'description' => '## 接口说明'."\n" + ."\n" + .'该接口支持按照节点数量或节点设置的vCPU个数、内存大小等维度灵活申请所需资源。', + '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' => '该节点待加入的集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '为待加入集群的计算节点指定的镜像，该镜像需满足以下条件：'."\n" + ."\n" + .'- 指定的镜像的操作系统应与集群中节点的操作系统保持一致。如：集群中节点的操作系统为CentOS时，只能指定CentOS镜像。'."\n" + .'> 如果集群为混合云集群，并且开启支持多系统功能，当集群中节点的操作系统为Windows时，指定的镜像可以为Windows、CentOS。'."\n" + ."\n" + .'- 指定的镜像应与集群节点的镜像大版本号保持一致，如待加入集群为CentOS 7.x，指定的镜像也应该为CentOS 7.x。'."\n" + ."\n" + .'您可以通过调用[ListImages](~~87213~~)和[ListCustomImages](~~87215~~)接口获取镜像ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'centos_7_06_64_20G_alibase_20190711.vhd', + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => '该节点要加入的集群中的队列。', + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像类型。取值范围：'."\n" + ."\n" + .'- system：公共镜像'."\n" + ."\n" + .'- self：自定义镜像'."\n" + ."\n" + .'- others：共享镜像'."\n" + ."\n" + .'- marketplace：镜像市场镜像'."\n" + ."\n" + .'默认值：system', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'system', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要添加的节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息数组。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '第N个（N从1开始编号，可以有多条）要添加的节点ID。取值范围：1~100。', + 'type' => 'string', + 'required' => true, + 'example' => 'i-bp16mxn6mt3t7ftk****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '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' => '添加一个或多个已存在的节点', + 'summary' => '添加一个或多个已创建的ECS实例作为计算节点，加入到指定集群中。', + 'description' => '## 接口说明'."\n" + ."\n" + .'- 待添加到集群的节点处于已停止状态。'."\n" + ."\n" + .'- 加入集群后，该节点的操作系统会更换为ImageId指定的操作系统。'."\n" + ."\n" + .'- 节点主机名不能和集群内已有节点的主机名冲突，否则会添加失败。'."\n", + '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' => '待查询的集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型。取值范围：'."\n" + .'- Manager：管控节点'."\n" + .'- Login：登录节点'."\n" + .'- Compute：计算节点', + 'type' => 'string', + 'required' => false, + 'example' => 'Manager', + 'default' => 'Compute', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => '节点名称，支持模糊查询，支持MySQL的正则表达式。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-HostName', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '显示的页码，起始值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。取值范围：1~100'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '节点列表排序方式。取值范围：'."\n" + .'- Forward：正序排序。'."\n" + .'- Backward：逆序排序。'."\n" + ."\n" + .'默认值：Forward'."\n" + ."\n" + .'> 和SortBy同时使用，如SortBy设置为AddedTime，Sequence设置为Forward，表示按节点加入时间正序查询。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Forward', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '节点列表排序方式。取值范围：'."\n" + .'- AddedTime：按加入时间排序'."\n" + ."\n" + .'- HostName：按节点主机名称排序'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AddedTime', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'description' => '节点状态过滤选项。'."\n" + ."\n" + .'取值格式为：{"status":"node_status"}，请将其中node_status替换为节点的状态。节点的取值范围为：'."\n" + ."\n" + .'- uninit：安装中'."\n" + .'- exception：异常'."\n" + .'- running：运行中'."\n" + .'- initing：初始化中'."\n" + .'- releasing：释放中'."\n" + .'- untracking：未加入集群'."\n" + .'- stopped：已停止', + 'type' => 'string', + 'required' => false, + 'example' => '{"status":"running"}', + ], + ], + [ + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '私网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.**.**', + ], + ], + [ + 'name' => 'HostNamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '主机名前缀。查询具有指定前缀的节点。', + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + ], + [ + 'name' => 'HostNameSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => '主机名后缀。查询具有指定后缀的节点。', + 'type' => 'string', + 'required' => false, + 'example' => '01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '89A1AC0F-4A6C-4F3D-98F9-BEF9A823****', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Nodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeInfo' => [ + 'description' => '节点列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp1gnu8br4ay7beb2w****', + ], + 'Status' => [ + 'description' => '节点状态。可能值：'."\n" + .'- uninit：安装中'."\n" + .'- exception：异常'."\n" + .'- running：运行中'."\n" + .'- initing：初始化中'."\n" + .'- releasing：释放中'."\n" + .'- untracking：未加入集群'."\n" + .'- stopped：已停止', + 'type' => 'string', + 'example' => 'running', + ], + 'HtEnabled' => [ + 'description' => '是否开启超线程。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Expired' => [ + 'description' => '包年包月付费节点是否到期。如果是按量付费节点，返回值为false。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ImageOwnerAlias' => [ + 'description' => '镜像类型。可能值：'."\n" + .'- system：公共镜像'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像'."\n" + .'- marketplace：镜像市场镜像', + 'type' => 'string', + 'example' => 'system', + ], + 'LockReason' => [ + 'description' => '节点被锁定类型。可能值：'."\n" + .'- financial：因欠费被锁定。'."\n" + .'- security：因安全原因被锁定。'."\n" + .'- recycling：抢占式实例的待释放锁定状态。'."\n" + .'- dedicatedhostfinancial：因为专有宿主机欠费导致ECS实例被锁定。'."\n" + ."\n" + .'默认返回为空字符串。', + 'type' => 'string', + 'example' => 'financial', + ], + 'HostName' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'test-HostName', + ], + 'InstanceType' => [ + 'description' => '节点实例规格。', + 'type' => 'string', + 'example' => 'ecs.c5.large', + ], + 'PublicIpAddress' => [ + 'description' => '公网IP地址。', + 'type' => 'string', + 'example' => '172.16.**.**', + ], + 'SpotStrategy' => [ + 'description' => '计算节点竞价策略。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'CreatedByEhpc' => [ + 'description' => '是否由E-HPC创建。'."\n" + ."\n" + .'- true：E-HPC创建'."\n" + ."\n" + .'- false：非E-HPC创建', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1e47optm9g58zcu****', + ], + 'IpAddress' => [ + 'description' => '节点IP地址。', + 'type' => 'string', + 'example' => '172.16.**.**', + ], + 'ExpiredTime' => [ + 'description' => '包年包月付费节点到期时间。如果是按量付费节点，返回值为空。', + 'type' => 'string', + 'example' => '2020-06-09T06:22:02.000Z', + ], + 'Version' => [ + 'description' => '集群客户端版本。', + 'type' => 'string', + 'example' => '1.0.78', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'AddTime' => [ + 'description' => '加入集群的时间。', + 'type' => 'string', + 'example' => '2020-06-09T06:22:02.000Z', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'centos_7_06_64_20G_alibase_20190711.vhd', + ], + 'Location' => [ + 'description' => '节点所在位置。可能值：'."\n" + .'- OnPremise：本地节点'."\n" + .'- PublicCloud：公共云节点', + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'Id' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'i-bp15707mys2rsy0j****', + ], + 'CreateMode' => [ + 'description' => '节点创建方式。可能值：'."\n" + .'- manual：手动扩容'."\n" + .'- autoscale：自动扩容', + 'type' => 'string', + 'example' => 'manual', + ], + 'Roles' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Role' => [ + 'description' => '节点类别。可能值：'."\n" + .'- Scheduler：主调度器'."\n" + .'- SchedulerBackup：备用调度器'."\n" + .'- Account：主域服务器'."\n" + .'- AccountBackup：备用域服务器'."\n" + .'- Login：登录节点'."\n" + .'- Compute：计算节点'."\n" + ."\n" + .'调度器和域服务器都属于管控节点。', + 'type' => 'array', + 'items' => [ + 'description' => '节点类别。可能值：'."\n" + .'- Scheduler：主调度器'."\n" + .'- SchedulerBackup：备用调度器'."\n" + .'- Account：主域服务器'."\n" + .'- AccountBackup：备用域服务器'."\n" + .'- Login：登录节点'."\n" + .'- Compute：计算节点'."\n" + ."\n" + .'调度器和域服务器都属于管控节点。', + 'type' => 'string', + 'example' => '[“Compute”]', + ], + ], + ], + ], + 'TotalResources' => [ + 'description' => '该节点使用的资源总量。', + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'GPU卡个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'CPU个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => '内存资源总量。单位：GB'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'UsedResources' => [ + 'description' => '计算节点资源使用量，其他类型节点返回值为空。', + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'GPU卡个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'CPU个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Memory' => [ + 'description' => '内存资源总量。单位：GB', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'StateInSched' => [ + 'description' => '从调度器查看到的节点状态，不同调度器状态不同。', + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群中节点列表', + 'summary' => '调用ListNodes查询指定集群中的节点列表。', + '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' => '待查询的集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型，取值范围： '."\n" + .'- Manager：管控节点'."\n" + .'- Login：登录节点'."\n" + .'- Compute：计算节点'."\n" + ."\n" + .'默认值：Compute', + 'type' => 'string', + 'required' => false, + 'example' => 'Compute', + 'default' => 'Compute', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => '节点名称，支持模糊查询，支持MySQL的正则表达式。', + 'type' => 'string', + 'required' => false, + 'example' => 'Compute0', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '节点列表排序方式。取值范围：'."\n" + .'- Forward：按节点的加入时间正序排序。'."\n" + .'- Backward：按节点的加入时间逆序排序。'."\n" + ."\n" + .'默认值：Forward', + 'type' => 'string', + 'required' => false, + 'example' => 'Forward', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Nodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeInfo' => [ + 'description' => '节点列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '节点状态。可能值：'."\n" + .'- uninit：安装中'."\n" + .'- exception：异常'."\n" + .'- running：运行中'."\n" + .'- initing：初始化中'."\n" + .'- releasing：释放中'."\n" + .'- untracking：未加入集群'."\n" + .'- stopped：已停止', + 'type' => 'string', + 'example' => 'untracking', + ], + 'HostName' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'compute0', + ], + 'InstanceType' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'centos_7_02_64_20G_alibase_20170818****', + ], + 'Id' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'i-bp13p7vlcb1uihfv****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群节点列表', + 'summary' => '不分页查询用户指定集群中的所有节点信息。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => '节点角色。取值范围：'."\n" + .'- Manager：管控节点'."\n" + .'- Login：登录节点'."\n" + .'- Compute：计算节点'."\n" + ."\n" + .'默认值：Compute', + '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' => '第N个要启动的节点的实例ID。N的取值范围：1~100'."\n" + ."\n" + .'请确保节点状态必须为stopped（已停止），您可以调用[ListNodes](~~87161~~)查询待启动节点的状态 。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp13p7vlcb1uihfv****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '启动集群中节点列表', + 'summary' => '调用StartNodes启动集群中的一个或多个节点。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => [ + 'description' => '节点角色。取值范围：'."\n" + .'- Manager：管控节点'."\n" + .'- Login：登录节点'."\n" + .'- Compute：计算节点'."\n" + ."\n" + .'默认值：Compute', + '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' => '第N个要停止的节点ID。N的取值范围：1~100'."\n" + ."\n" + .'您可以通过调用[ListNodes](~~87161~~)获取节点ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'i-bp13p7vlcb1uihf****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '停止集群中节点列表', + 'summary' => '调用StopNodes停止集群中的一个或多个节点。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + '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' => '第N个要重置的计算节点ID。N的取值范围：1~100'."\n" + ."\n" + .'您可以通过调用[ListNodes](~~87161~~)获取节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp13p7vlcb1uihfv****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '批量重置计算节点', + 'summary' => '调用ResetNodes重置一个或多个计算节点。', + 'description' => '## 接口说明'."\n" + .'重置节点后，节点的系统和软件将恢复初始状态。如无特殊需要（如故障修复等），请勿重置处于运行中状态的节点，以免作业无法正常运行。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以调用[ListClusters](~~87116~~)查询集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ReleaseInstance', + 'in' => 'query', + 'schema' => [ + 'description' => '是否释放由E-HPC创建的节点。'."\n" + ."\n" + .'默认值：true', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'Sync', + 'in' => 'query', + 'schema' => [ + 'description' => '是否直接删除节点。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '待删除的节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息数组。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '要删除的计算节点ID。N的取值范围：1~100'."\n" + ."\n" + .'您可以调用[DescribeCluster](~~87126~~)查询指定集群中的节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp13p7vlcb1uihfv****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。'."\n" + ."\n" + .'- 当Sync取值为true，该接口为同步接口。TaskId为Not Available。'."\n" + ."\n" + .'- 当Sync取值为false，该接口为异步接口。您可以调用[ListTasks](~~268225~~)查询任务运行结果。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '批量删除计算节点', + 'summary' => '调用DeleteNodes删除指定集群中一个或多个计算节点。', + 'description' => '## 接口说明'."\n" + .'删除节点前，建议您导出节点上所有作业数据，以免因为删除节点而导致数据丢失。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => '要添加的队列名称。长度为1~63个字符，必须以大小写英文字母开头，可以包含数字、下划线（_）。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'NetworkInterfaceTrafficMode', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性网卡的通讯模式。取值范围：'."\n" + ."\n" + .'- Standard：使用TCP通讯模式。'."\n" + .'- HighPerformance：开启ERI（Elastic RDMA Interface）接口，使用RDMA通讯模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'DeploymentSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '部署集ID。'."\n" + .'您可以通过[DescribeDeploymentSets](~~91313~~)获取部署集ID，当前仅支持网络低时延策略的部署集。', + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp1frxuzdg87zh4pzq****', + ], + ], + [ + 'name' => 'UseESS', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用弹性伸缩组。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7ABFF29F-BD9C-4663-AD5D-E620FA48****', + ], + ], + ], + ], + ], + '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' => '新建一个集群队列', + 'summary' => '调用AddQueue为指定集群新建一个队列。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListQueues' => [ + 'summary' => '调用ListQueues查询指定集群的队列列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '是否异步查询。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C6E5005C-00B0-4F27-98BB-95AB88016C22', + ], + 'Queues' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'QueueInfo' => [ + 'description' => '队列详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '队列详细信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '队列类型。可能值：'."\n" + ."\n" + .'- Execution：可以执行作业的队列。'."\n" + .'- Router：不能执行作业，只会将接受的作业转发至绑定的Execution队列执行。', + 'type' => 'string', + 'example' => 'Execution', + ], + 'HostNamePrefix' => [ + 'description' => '队列中计算节点的主机名前缀名称。', + 'type' => 'string', + 'example' => 'compute', + ], + 'QueueName' => [ + 'description' => '队列名称。', + 'type' => 'string', + 'example' => 'workq', + ], + 'EnableAutoGrow' => [ + 'description' => '队列是否启动自动扩容。可能值：'."\n" + ."\n" + .'- true：已启动'."\n" + .'- false：未启动', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ResourceGroupId' => [ + 'description' => '队列所属资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxp7uc24****', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'centos_7_06_64_20G_alibase_20****.vhd', + ], + 'HostNameSuffix' => [ + 'description' => '队列中计算节点的主机名后缀名称。', + 'type' => 'string', + 'example' => '01', + ], + 'SpotStrategy' => [ + 'description' => '计算节点抢占策略。可能值：'."\n" + ."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'SpotInstanceTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => '抢占式实例信息。', + 'type' => 'array', + 'items' => [ + 'description' => '抢占式实例信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'description' => '抢占式实例的规格。', + 'type' => 'string', + 'example' => 'ecs.n1.tiny', + ], + 'SpotPriceLimit' => [ + 'description' => '实例的每小时最高价格，支持最多3位小数。参数SpotStrategy取值为SpotWithPriceLimit时生效。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.062', + ], + ], + ], + ], + ], + ], + 'ComputeInstanceType' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceType' => [ + 'description' => '计算节点的实例规格。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点的实例规格。', + 'type' => 'string', + 'example' => 'ecs.c7.xlarge', + ], + ], + ], + ], + 'DeploymentSetId' => [ + 'description' => '部署集ID。'."\n" + .'您可以通过[DescribeDeploymentSets](~~91313~~)获取部署集ID，当前仅支持网络低时延策略的部署集。', + 'type' => 'string', + 'example' => 'ds-bp1frxuzdg87zh4pzq****', + ], + 'UseESS' => [ + 'description' => '是否使用弹性伸缩组。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'NetworkInterfaceTrafficMode' => [ + 'description' => '弹性网卡的通讯模式。取值范围：'."\n" + ."\n" + .'- Standard：使用TCP通讯模式。'."\n" + .'- HighPerformance：开启ERI（Elastic RDMA Interface）接口，使用RDMA通讯模式。', + 'type' => 'string', + 'example' => 'Standard', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群队列列表', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => '队列名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'workq', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + ."\n" + .'您可以通过调用[ListResourceGroups](~~158855~~)获取资源组ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'rg-acfmxazb4ph****', + ], + ], + [ + 'name' => 'ComputeInstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点规格。'."\n" + ."\n" + .'您可以调用[ListPreferredEcsTypes](~~188592~~)接口获取E-HPC推荐的节点规格信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + ], + [ + 'name' => 'DeploymentSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '部署集ID。'."\n" + .'您可以通过[DescribeDeploymentSets](~~91313~~)获取部署集ID，当前仅支持网络低时延策略的部署集。', + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp1frxuzdg87zh4pzq****', + ], + ], + [ + 'name' => 'NetworkInterfaceTrafficMode', + 'in' => 'query', + 'schema' => [ + 'description' => '弹性网卡的通讯模式。取值范围：'."\n" + ."\n" + .'- Standard：使用TCP通讯模式。'."\n" + .'- HighPerformance：开启ERI（Elastic RDMA Interface）接口，使用RDMA通讯模式。', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + 'enum' => [ + 'Standard', + 'HighPerformance', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '5198C3E8-85F5-4280-8547-687C1710****', + ], + ], + ], + ], + ], + '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' => '更新队列资源组和计算节点实例信息', + 'summary' => '为集群中的队列更新资源组和计算节点实例的信息。', + 'description' => '## 接口说明'."\n" + .'更新资源组后，如果您通过集群扩容新增节点，节点将会自动添加到新的资源组。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => '队列名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'workq', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '显示的页码，起始值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的行数。取值范围：1~50'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '是否异步查询。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B405FF19-2D5F-4489-A84C-BC15CC1B24BD', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Nodes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'NodeInfo' => [ + 'description' => '节点列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp1gnu8br4ay7beb2w****', + ], + 'Status' => [ + 'description' => '节点状态。可能值：'."\n" + .'- uninit：未初始化'."\n" + .'- init：初始化中'."\n" + .'- ready：空闲'."\n" + .'- running：运行中'."\n" + .'- exception：异常'."\n" + .'- untracking：未加入集群', + 'type' => 'string', + 'example' => 'untracking', + ], + 'HtEnabled' => [ + 'description' => '是否启用HT。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Expired' => [ + 'description' => '包年包月节点是否到期。如果是按量付费节点，则为false。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ImageOwnerAlias' => [ + 'description' => '镜像类型，可能值：'."\n" + .'- system：公共镜像'."\n" + .'- self：自定义镜像'."\n" + .'- others：共享镜像'."\n" + .'- marketplace：镜像市场镜像', + 'type' => 'string', + 'example' => 'system', + ], + 'LockReason' => [ + 'description' => '节点被锁定类型，可能值：'."\n" + .'- financial：因欠费被锁定。'."\n" + .'- security：因安全原因被锁定。'."\n" + .'- recycling：抢占式实例的待释放锁定状态。'."\n" + .'- dedicatedhostfinancial：因为专有宿主机欠费导致ECS实例被锁定。'."\n" + ."\n" + .'默认返回为空字符串。', + 'type' => 'string', + 'example' => 'financial', + ], + 'HostName' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'example' => 'compute0', + ], + 'PublicIpAddress' => [ + 'description' => '节点的公网IP地址。', + 'type' => 'string', + 'example' => '10.34.**.**', + ], + 'SpotStrategy' => [ + 'description' => '实例的抢占策略。可能值：'."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'CreatedByEhpc' => [ + 'description' => '是否由E-HPC创建的节点。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1e47optm9g58zcu****', + ], + 'IpAddress' => [ + 'description' => '节点私网IP地址。', + 'type' => 'string', + 'example' => '172.168.**.**', + ], + 'ExpiredTime' => [ + 'description' => '包年包月节点到期时间。如果是按量付费节点，则此项为空。', + 'type' => 'string', + 'example' => '2020-09-18T13:24:29.000Z', + ], + 'Version' => [ + 'description' => '集群所使用的客户端版本号。', + 'type' => 'string', + 'example' => '1.0.64', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'AddTime' => [ + 'description' => '节点加入集群的时间。', + 'type' => 'string', + 'example' => '2019-09-18T13:24:29.000Z', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'centos_7_02_64_20G_alibase_20170818****', + ], + 'Location' => [ + 'description' => '节点所在位置。可能值：'."\n" + .'- OnPremise：混合云集群。'."\n" + .'- PublicCloud：公有云集群。', + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'Id' => [ + 'description' => '节点实例ID。', + 'type' => 'string', + 'example' => 'i-bp13p7vlcb1uihfv****', + ], + 'CreateMode' => [ + 'description' => '节点创建方式。可能值：'."\n" + .'- manual：手动扩容'."\n" + .'- autoscale：自动扩容', + 'type' => 'string', + 'example' => 'manual', + ], + 'TotalResources' => [ + 'description' => '资源总量。', + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'GPU资源总量。单位：卡', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'CPU资源总量。单位：核', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => '内存资源总量。单位：GB', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'UsedResources' => [ + 'description' => '计算节点资源使用量，其他类型节点返回值为空。', + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'GPU资源总量。单位：卡', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'CPU资源总量。单位：核', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => '内存资源总量。单位：GB', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'StateInSched' => [ + 'description' => '从调度器查看到的节点状态，不同调度器状态不同。', + 'type' => 'string', + 'example' => 'active', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询单个集群节点信息', + 'summary' => '按队列分组查询用户账户下单个集群的节点信息。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => '目标队列名称。', + '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' => '需要移动的计算节点主机名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'compute1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '移动计算节点到指定队列', + 'summary' => '调用SetQueue移动计算节点到指定队列。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的队列名称。'."\n" + ."\n" + .'您可以通过调用[ListQueues](~~92176~~)获取队列名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'workq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '删除一个队列', + 'summary' => '调用DeleteQueue删除一个集群中的队列。', + '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' => '地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~188593~~)获取E-HPC支持的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PbsInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'PBS调度器信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'PBS调度器信息数组。', + 'type' => 'object', + 'properties' => [ + 'AclLimit' => [ + 'description' => '队列限制信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '队列限制信息数组。', + 'type' => 'object', + 'properties' => [ + 'Queue' => [ + 'description' => 'AclLimit指用户使用的队列限制。N的取值范围：0~100。'."\n" + ."\n" + .'假设`PbsInfo.N.AclLimit.N.Queue`设置为`workq`，`PbsInfo.N.AclLimit.N.AclUsers`设置为`user1,user2`，表示队列workq只能被user1和user2使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + 'AclUsers' => [ + 'description' => '限制该队列使用的用户名，多个用户用`,`隔开。'."\n" + ."\n" + .'当设置了用户名时，PbsInfo.N.AclLimit.N.Queue为必选。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1,user2', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + 'ResourceLimit' => [ + 'description' => '集群用户使用的节点信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息数组。', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '集群用户使用队列的最大节点个数。'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'Cpus' => [ + 'description' => '集群用户使用队列中节点的最大vCPU个数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'User' => [ + 'description' => '运行作业的集群用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + 'Queue' => [ + 'description' => 'PbsInfo指集群中可以设置的PBS调度信息个数。N的取值范围：0~100。'."\n" + ."\n" + .'ResourceLimit指用户使用的队列资源限制。N的取值范围：0~100。'."\n" + ."\n" + .'Queue指该集群用户运行作业使用的队列名称。'."\n" + ."\n" + .'当ResourceLimit中设置了User、Cpus、Nodes、Mem中任一一个参数时，Queue为必选。', + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + 'Mem' => [ + 'description' => '集群用户使用队列的最大内存资源。单位取值范围：'."\n" + ."\n" + .'- gb'."\n" + ."\n" + .'- mb'."\n" + ."\n" + .'- kb'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2gb', + ], + 'MaxJobs' => [ + 'description' => '集群用户提交的最大作业数目。若用户的运行和排队作业数目总和超过此数值则将无法再继续提交作业。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + 'JobHistoryDuration' => [ + 'description' => '作业保留时间，超过保留之间后，作业数据会被销毁。单位为天。 '."\n" + .'取值范围：1~30。 '."\n" + .'默认值：14。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '14', + ], + 'SchedInterval' => [ + 'description' => 'PbsInfo指集群中可以设置的PBS调度信息个数。N的取值范围：0~100。'."\n" + ."\n" + .'SchedInterval指调度周期，单位：秒'."\n" + ."\n" + .'调度周期指运行多个作业之间时间间隔，如设置为60，表示本次作业开始运行60秒后才能开始运行下次作业。'."\n" + ."\n" + .'默认值：60', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + 'SchedMaxJobs' => [ + 'description' => '集群调度的最大作业数。若集群排队和运行的作业数总和超过此数值则无法再继续提交作业。默认值：20000', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20000', + ], + 'SchedMaxQueuedJobs' => [ + 'description' => '集群调度的最大排队作业数。若集群排队作业数量超过此数值则无法再继续提交作业。默认值：10000', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'SlurmInfo', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Slurm调度器信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Slurm调度器信息数组。', + 'type' => 'object', + 'properties' => [ + 'BackfillInterval' => [ + 'description' => 'Backfill调度周期设置，单位：秒'."\n" + ."\n" + .'默认值：60', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + 'SchedInterval' => [ + 'description' => 'SlurmInfo指集群中可以设置的Slurm调度信息个数。N的取值范围：0~100。'."\n" + ."\n" + .'SchedInterval指主调度周期设置，单位：秒'."\n" + ."\n" + .'默认值：60', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1000, + ], + ], + [ + 'name' => 'Scheduler', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '调度器信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '调度器信息数组。', + 'type' => 'object', + 'properties' => [ + 'SchedName' => [ + 'description' => '调度器名，取值范围：'."\n" + ."\n" + .'- pbs'."\n" + .'- pbs19'."\n" + .'- slurm'."\n" + .'- slurm19'."\n" + .'- slurm20'."\n" + ."\n" + .'> 调度器为pbs、pbs19时，PbsInfo.N.SchedInterval、PbsInfo.N.JobHistoryDuration、PbsInfo.N.ResourceLimit、PbsInfo.N.AclLimit中至少一个参数为必选；调度器为slurm、slurm19、slurm20时，SlurmInfo.N.SchedInterval、SlurmInfo.N.BackfillInterval中至少一个参数为必选。', + 'type' => 'string', + 'required' => true, + 'example' => 'pbs', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'pbs: scheduler setting successfully.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BBC2F93D-003A-49C4-850C-B826EECF****', + ], + ], + ], + ], + ], + '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' => '设置调度器信息', + 'summary' => '为指定集群设置调度器配置信息。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Scheduler', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '调度器详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '调度器信息数组。', + 'type' => 'object', + 'properties' => [ + 'SchedName' => [ + 'description' => '调度器名称。取值范围：'."\n" + ."\n" + .'- pbs'."\n" + .'- pbs19'."\n" + .'- slurm'."\n" + .'- slurm19'."\n" + .'- slurm20', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'pbs', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 1000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BBC2F93D-003A-49C4-850C-B826EECF****', + ], + 'SchedInfo' => [ + 'description' => '调度器配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '调度器配置信息。', + 'type' => 'object', + 'properties' => [ + 'Configuration' => [ + 'description' => '调度器详细配置信息。', + 'type' => 'string', + 'example' => '{"AclInfo":[{"AclEnable":false,"UntrackUser":[],"User":[],"QueueName":"workq"}],"JobHistory":"","SchedIteration":"60","QueueResource":[{"UntrackUser":[],"User":[],"QueueName":"workq"}]}', + ], + 'SchedName' => [ + 'description' => '调度器名称。', + 'type' => 'string', + 'example' => 'pbs', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询指定集群的调度器配置', + 'summary' => '调用GetSchedulerInfo查询指定集群的调度信息。', + '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' => 'E-HPC产品版本号。'."\n" + ."\n" + .'您可以调用[ListCurrentClientVersion](~~87223~~)接口查询产品版本号。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'OsTag', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像标签。'."\n" + ."\n" + .'您可以通过[ListImages](~~87213~~)查询镜像标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.2_64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Softwares' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SoftwareInfo' => [ + 'description' => '软件信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => [ + 'description' => '调度器类型。可能值：'."\n" + .'- pbs'."\n" + .'- pbs19'."\n" + .'- slurm'."\n" + .'- slurm19'."\n" + .'- slurm20'."\n" + .'- opengridscheduler'."\n" + .'- deadline'."\n" + .'- gridengine'."\n" + .'- cube'."\n" + .'- custom', + 'type' => 'string', + 'example' => 'pbs', + ], + 'OsTag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => 'CentOS_7.2_64', + ], + 'SchedulerVersion' => [ + 'description' => '调度器软件版本。', + 'type' => 'string', + 'example' => '18.1.1', + ], + 'AccountVersion' => [ + 'description' => '域账号服务版本。', + 'type' => 'string', + 'example' => '2.31', + ], + 'AccountType' => [ + 'description' => '域账号服务类型。可能值：'."\n" + .'- nis'."\n" + .'- ldap', + 'type' => 'string', + 'example' => 'nis', + ], + 'EhpcVersion' => [ + 'description' => 'E-HPC版本。', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'Applications' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ApplicationInfo' => [ + 'description' => '集群应用软件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Required' => [ + 'description' => '是否必选软件。可能值：'."\n" + ."\n" + .'- false：非必选'."\n" + .'- true：必选', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tag' => [ + 'description' => '软件标签。', + 'type' => 'string', + 'example' => 'CUDNN_9.0', + ], + 'Name' => [ + 'description' => '软件名称。', + 'type' => 'string', + 'example' => 'cudnnt', + ], + 'Version' => [ + 'description' => '软件版本。', + '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' => '查询支持安装的软件列表', + 'summary' => '查询 E-HPC 产品支持安装的软件列表。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'Application', + 'in' => 'query', + 'schema' => [ + 'description' => '需要安装的软件名称。'."\n" + ."\n" + .'您可以调用[ListSoftwares](~~87216~~)查询可安装的软件列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ABYSS_2.1.5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + ], + ], + ], + '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' => '安装软件', + 'summary' => '调用InstallSoftware为指定集群安装软件。', + ], + 'ListInstalledSoftware' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DDCA0E7B-03E7-430D-810C-0D508539****', + ], + 'SoftwareList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SoftwareList' => [ + 'description' => '已安装的软件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已安装的软件列表。', + 'type' => 'object', + 'properties' => [ + 'SoftwareId' => [ + 'description' => '软件ID。', + 'type' => 'string', + 'example' => 'MPICH_3.2', + ], + 'SoftwareStatus' => [ + 'description' => '软件安装状态。可能值：'."\n" + .'- Installing：安装中'."\n" + .'- Installed：已安装', + 'type' => 'string', + 'example' => 'Installing', + ], + 'SoftwareVersion' => [ + 'description' => '软件版本。', + 'type' => 'string', + 'example' => '3.2', + ], + 'SoftwareName' => [ + 'description' => '软件名称。', + 'type' => 'string', + 'example' => 'mpich', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询指定集群已安装的软件列表', + 'summary' => '调用ListInstalledSoftware查询指定集群已安装的软件列表。', + ], + 'UninstallSoftware' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'Application', + 'in' => 'query', + 'schema' => [ + 'description' => '待卸载的软件名称。'."\n" + ."\n" + .'您可以通过调用[ListInstalledSoftware](~~188591~~)查询集群已安装的软件列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ABYSS_2.1.5', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C84FB8EF-5580-4B82-9BDE-6657814C****', + ], + ], + ], + ], + ], + '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' => '卸载软件', + 'summary' => '调用UninstallSoftware卸载指定集群中已安装的软件。', + ], + 'ListFileSystemWithMountTargets' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的行数。取值范围：1~50默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '分页查询时设置的每页行数。 取值范围：1~50。 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '25638B77-2F19-5DC5-B578-7790CE92052B', + ], + 'PageNumber' => [ + 'description' => '分页查询的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '显示列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FileSystemList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FileSystems' => [ + 'description' => '文件系统列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件系统列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '文件系统状态。可能值：'."\n" + .'- Pending：当前文件系统正在处理任务中。'."\n" + .'- Running：当前文件系统可用。'."\n" + .'- Stopped：当前文件系统不可用。'."\n" + .'- Extending：当前文件系统扩容中。'."\n" + .'- Stopping：当前文件系统停机中。'."\n" + .'- Deleting：当前文件系统删除中。', + 'type' => 'string', + 'example' => 'Running', + ], + 'Capacity' => [ + 'description' => '文件系统的容量。单位：GiB', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5120', + ], + 'CreateTime' => [ + 'description' => '文件系统创建时间。', + 'type' => 'string', + 'example' => '2018-07-26 16:36:27', + ], + 'StorageType' => [ + 'description' => '存储规格类型。'."\n" + ."\n" + .'- 当FileSystemType为standard时，可能值：Capacity（容量型）、Performance（性能型）'."\n" + .'- 当FileSystemType为extreme时，可能值：standard（标准型）、advance（高级型）'."\n" + .'<props="china">'."\n" + .'- 当FileSystemType为CPFS时，可能值：advance_100（100MB/s/TiB基线）、advance_200（200MB/s/TiB基线）</props>', + 'type' => 'string', + 'example' => 'Performance', + ], + 'BandWidth' => [ + 'description' => '文件系统的带宽。单位：MB/s', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '150', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '088b****', + ], + 'FileSystemType' => [ + 'description' => '文件系统类型，可能值：'."\n" + ."\n" + .'- standard：通用型NAS'."\n" + .'- extreme：极速型NAS'."\n" + .'<props="china">'."\n" + .'- cpfs：CPFS</props>', + 'type' => 'string', + 'example' => 'standard', + ], + 'MeteredSize' => [ + 'description' => 'NAS文件系统已使用的容量，单位为Byte。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1216816455', + ], + 'EncryptType' => [ + 'description' => '文件系统是否加密。'."\n" + ."\n" + .'使用KMS服务托管密钥，对文件系统落盘数据进行加密存储。在读写加密数据时，无需解密。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- 0（默认值）：不加密。'."\n" + .'- 1：NAS托管密钥。当FileSystemType=standard或extreme时，支持NAS托管密钥。'."\n" + .'- 2：用户管理密钥。仅当FileSystemType=extreme时，支持用户管理密钥。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ProtocolType' => [ + 'description' => '文件系统的协议类型。可能值：'."\n" + ."\n" + .'- NFS- SMB'."\n" + .'<props="china">'."\n" + .'- CPFS</props>', + 'type' => 'string', + 'example' => 'NFS', + ], + 'Destription' => [ + 'description' => '文件系统描述。', + 'type' => 'string', + 'example' => 'FilesDescription', + ], + 'PackageList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Packages' => [ + 'description' => '存储包信息列表。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '存储包信息列表。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'PackageId' => [ + 'description' => '存储包ID。', + 'type' => 'string', + 'example' => 'naspackage-0be9c4b624-37****', + ], + ], + ], + ], + ], + ], + 'MountTargetList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MountTargets' => [ + 'description' => '挂载点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '挂载点列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '挂载点状态。可能值：'."\n" + .'- Active：可用'."\n" + .'- Inactive：不可用'."\n" + .'- Pending：任务排队中'."\n" + .'- Deleting：删除中', + 'type' => 'string', + 'example' => 'Active', + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-8vbvb34rtyh6xb3zrehs1****', + ], + 'MountTargetDomain' => [ + 'description' => '挂载目标域。', + 'type' => 'string', + 'example' => '088b****-lj2.cn-hangzhou.nas.aliyuncs.com', + ], + 'AccessGroup' => [ + 'description' => '权限组是否为用户的默认权限组。'."\n" + ."\n" + .'包括：'."\n" + ."\n" + .'- true：该权限组为默认权限组。当该权限组为默认权限组时，允许所有IP地址访问，且用户无法删除默认权限组及权限组内的权限规则。'."\n" + .'- false：该权限组不是默认权限组。', + 'type' => 'string', + 'example' => 'DEFAULT_VPC_GROUP_NAME', + ], + 'VswId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-8vb34rtyh6xb3zrehs1****', + ], + 'NetworkType' => [ + 'description' => '网络类型。可能值：'."\n" + .'- vpc：专有网络'."\n" + .'- classic：经典网络', + 'type' => 'string', + 'example' => 'vpc', + ], + ], + ], + ], + ], + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp132kgui8n0targbn1cm', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询文件系统和挂载点', + 'summary' => '调用ListFileSystemWithMountTargets查询文件系统和挂载点。', + ], + 'ListCpfsFileSystems' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件系统ID。'."\n" + ."\n" + .'默认查询您账号下所有的CPFS文件系统及其挂载点信息。', + 'type' => 'string', + 'required' => false, + 'example' => '096751****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'起始值：1'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的行数。取值范围：1~50'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2B900AFE-C938-4551-86E9-97E231BBC876', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'FileSystemList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FileSystems' => [ + 'description' => '文件系统列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '096751****', + ], + 'Capacity' => [ + 'description' => '文件系统容量。单位：GiB', + 'type' => 'string', + 'example' => '5120', + ], + 'CreateTime' => [ + 'description' => '文件系统创建时间。', + 'type' => 'string', + 'example' => '2018-07-26 16:36:27', + ], + 'ZoneId' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'ProtocolType' => [ + 'description' => '挂载的文件存储的协议类型。可能值：'."\n" + .'- NFS'."\n" + .'- SMB', + 'type' => 'string', + 'example' => 'NFS', + ], + 'Destription' => [ + 'description' => '文件系统描述。', + 'type' => 'string', + 'example' => 'FilsDestription', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'MountTargetList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MountTargets' => [ + 'description' => '挂载点列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-8vbvb34rtyh6xb3zrehs1****', + ], + 'Status' => [ + 'description' => '挂载点状态。可能值：'."\n" + .'- Active：可用'."\n" + .'- Inactive：不可用'."\n" + .'- Pending：挂载中'."\n" + .'- Deleting：删除中', + 'type' => 'string', + 'example' => 'Active', + ], + 'VswId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-8vb34rtyh6xb3zrehs1****', + ], + 'NetworkType' => [ + 'description' => '网络类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'MountTargetDomain' => [ + 'description' => '挂载目标域。', + 'type' => 'string', + 'example' => 'c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询CPFS文件系统及其挂载点信息', + 'summary' => '调用 ListCpfsFileSystems查询CPFS文件系统及其挂载点信息。', + ], + 'GetClusterVolumes' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-gh5WKb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8BCFD52E-0336-4490-AE7D-F560F106****', + ], + 'Volumes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VolumeInfo' => [ + 'description' => '挂载到E-HPC的文件系统信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '挂载到E-HPC的文件系统信息列表。', + 'type' => 'object', + 'properties' => [ + 'JobQueue' => [ + 'description' => '作业队列。', + 'type' => 'string', + 'example' => 'workq', + ], + 'VolumeId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '0e754****', + ], + 'RemoteDirectory' => [ + 'description' => '远程挂载目录。', + 'type' => 'string', + 'example' => '/test', + ], + 'VolumeMountpoint' => [ + 'description' => '挂载点地址。', + 'type' => 'string', + 'example' => '0e754****-kal90.cn-hangzhou.nas.aliyuncs.com', + ], + 'LocalDirectory' => [ + 'description' => '本地挂载目录。', + 'type' => 'string', + 'example' => '/ehpcdata', + ], + 'VolumeType' => [ + 'description' => '文件系统类型。', + 'type' => 'string', + 'example' => 'NAS', + ], + 'MustKeep' => [ + 'description' => '是否为可卸载资源。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Location' => [ + 'description' => '集群类型。可能值：'."\n" + .'- OnPremise：混合云集群。'."\n" + .'- PublicCloud：公有云集群。', + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'VolumeProtocol' => [ + 'description' => '文件系统的存储协议类型。', + 'type' => 'string', + 'example' => 'NFS', + ], + 'Roles' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RoleInfo' => [ + 'description' => '挂载文件系统的节点信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '挂载文件系统的节点信息列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '挂载文件系统的节点类型。可能值：'."\n" + .'- Compute：计算节点'."\n" + .'- Manager：管控节点'."\n" + .'- Login：登录节点', + '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' => '查询挂载到集群的存储资源', + 'summary' => '调用GetClusterVolumes查询挂载到E-HPC指定集群中的存储资源。', + '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' => '当前页码。'."\n" + ."\n" + .'起始值：1'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的行数。取值范围：1~50'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Volumes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VolumeInfo' => [ + 'description' => '挂载到E-HPC集群的文件系统信息数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VolumeId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => 'bc8a****', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'cluster1', + ], + 'RemoteDirectory' => [ + 'description' => '文件系统挂载的远程目录。', + 'type' => 'string', + 'example' => '/test1', + ], + 'VolumeMountpoint' => [ + 'description' => '挂载点地址。', + 'type' => 'string', + 'example' => 'bc8a****-rgd51.cn-hangzhou.nas.aliyuncs.com', + ], + 'VolumeType' => [ + 'description' => '挂载到集群的文件系统类型，目前仅支持NAS。', + 'type' => 'string', + 'example' => 'NAS', + ], + 'VolumeProtocol' => [ + 'description' => '存储协议类型。可能值：'."\n" + .'- NFS'."\n" + .'- SMB', + 'type' => 'string', + 'example' => 'NFS', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'AdditionalVolumes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VolumeInfo' => [ + 'description' => '新增文件系统挂载的信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobQueue' => [ + 'description' => '作业所属队列。', + 'type' => 'string', + 'example' => 'all.q', + ], + 'VolumeId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '86y3****', + ], + 'RemoteDirectory' => [ + 'description' => '文件系统挂载的远程目录。', + 'type' => 'string', + 'example' => '/test', + ], + 'VolumeMountpoint' => [ + 'description' => '挂载点地址。', + 'type' => 'string', + 'example' => '86y3****-rgd51.cn-hangzhou.nas.aliyuncs.com', + ], + 'Role' => [ + 'description' => '挂载的节点类型。可能值：'."\n" + .'- Manager：管控节点'."\n" + .'- Login：登录节点'."\n" + .'- Compute：计算节点', + 'type' => 'string', + 'example' => 'Compute', + ], + 'LocalDirectory' => [ + 'description' => '本地挂载目录。', + 'type' => 'string', + 'example' => '/testopt', + ], + 'VolumeType' => [ + 'description' => '新增的文件系统类型，目前仅支持NAS。', + 'type' => 'string', + 'example' => 'NAS', + ], + 'Location' => [ + 'description' => '集群所在位置。可能值：'."\n" + .'- OnPremise：混合云集群。'."\n" + .'- PublicCloud：公有云集群。', + 'type' => 'string', + 'example' => 'PublicCloud', + ], + 'VolumeProtocol' => [ + 'description' => '存储协议类型。可能值：'."\n" + .'- NFS'."\n" + .'- SMB', + 'type' => 'string', + 'example' => 'NFS', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '列出用户的存储卷', + 'summary' => '调用ListVolumes查询文件系统列表。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AdditionalVolumes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '文件系统信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobQueue' => [ + 'description' => '附加挂载文件系统的队列名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'work', + ], + 'VolumeId' => [ + 'description' => '附加挂载的文件系统ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'extreme-00b88****', + ], + 'Roles' => [ + 'description' => '挂载文件系统的节点信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '附加挂载的文件系统挂载的节点类型。取值范围：'."\n" + .'- Manager：管控节点'."\n" + .'- Login：登录节点'."\n" + .'- Compute：计算节点', + 'type' => 'string', + 'required' => false, + 'example' => '["Compute"]', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 8, + ], + 'VolumeMountpoint' => [ + 'description' => '附加挂载的文件系统挂载点地址。', + 'type' => 'string', + 'required' => false, + 'example' => '0088****-sihc.cn-hangzhou.extreme.nas.aliyuncs.com', + ], + 'RemoteDirectory' => [ + 'description' => '附加挂载的文件系统需要挂载的远程目录。', + 'type' => 'string', + 'required' => false, + 'example' => '/test', + ], + 'VolumeType' => [ + 'description' => '附加挂载的文件系统类型，目前仅支持NAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'NAS', + ], + 'LocalDirectory' => [ + 'description' => '附加挂载文件系统的本地挂载目录。', + 'type' => 'string', + 'required' => false, + 'example' => '/ff', + ], + 'VolumeProtocol' => [ + 'description' => '附加挂载的文件系统协议类型。取值范围：'."\n" + .'- NFS'."\n" + .'- SMB', + 'type' => 'string', + 'required' => false, + 'example' => 'NFS', + ], + 'Location' => [ + 'description' => '附加挂载的文件系统的存储位置。可能值：'."\n" + .'- OnPremise：混合云集群。'."\n" + .'- PublicCloud：公有云集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'PublicCloud', + ], + 'VolumeMountOption' => [ + 'description' => '附加挂载的文件系统的存储挂载选项。', + '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' => '请求ID。', + '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' => '为指定集群挂载新的存储资源', + 'summary' => '调用UpdateClusterVolumes为指定集群挂载新的存储资源。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'CommandLine', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业命令。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => './LammpsTest/lammps.pbs', + ], + ], + [ + 'name' => 'RunasUser', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业的用户名。'."\n" + ."\n" + .'您可以通过调用[ListUsers](~~188572~~)获取该集群中的用户名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testuser', + ], + ], + [ + 'name' => 'RunasUserPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '用户密码。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '12****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '作业名称。长度为6~30个字符，必须以英文字母开头，可以包含数字、半角句号（.）。', + 'type' => 'string', + 'required' => false, + 'example' => 'jobtest', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '作业优先级，取值范围：0~9，取值越大，优先级越高。'."\n" + ."\n" + .'默认值：0', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PackagePath', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业路径。', + 'type' => 'string', + 'required' => false, + 'example' => './Tem', + ], + ], + [ + 'name' => 'StdoutRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => '标准输出路径。', + 'type' => 'string', + 'required' => false, + 'example' => './LammpsTest', + ], + ], + [ + 'name' => 'StderrRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => '错误输出路径。', + 'type' => 'string', + 'required' => false, + 'example' => './LammpsTest', + ], + ], + [ + 'name' => 'ReRunable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否支持重新执行作业。取值范围：'."\n" + .'- true：支持'."\n" + .'- false：不支持', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ArrayRequest', + 'in' => 'query', + 'schema' => [ + 'description' => '队列作业。 '."\n" + ."\n" + .'格式X-Y:Z， 最小值X是第一个索引，最大值Y是最后一个索引，Z表示步长，例如2-7:2，表示作业队列包含编号为2、4、6的3个子作业。', + 'type' => 'string', + 'required' => false, + 'example' => '1-10:2', + ], + ], + [ + 'name' => 'Variables', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业的环境变量，可以在作业执行文件中访问环境变量。', + 'type' => 'string', + 'required' => false, + 'example' => '[{Name:test1,Value:value1},{Name:test2,Value:value2}]', + ], + ], + [ + 'name' => 'InputFileUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '上传到OSS的作业文件的URL地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://ehpc-hangzhou.oss-cn-hangzhou.aliyuncs.com/test-u4****/testlist_ehpc.sh', + ], + ], + [ + 'name' => 'UnzipCmd', + 'in' => 'query', + 'schema' => [ + 'description' => '解压命令。解压OSS下载的文件。取值范围：'."\n" + ."\n" + .'- tar xzf：解开gzip格式压缩包'."\n" + ."\n" + .'- tar xf：解开tar格式压缩包'."\n" + ."\n" + .'- unzip：解开zip格式压缩包', + 'type' => 'string', + 'required' => false, + 'example' => 'tar xzf', + ], + ], + [ + 'name' => 'PostCmdLine', + 'in' => 'query', + 'schema' => [ + 'description' => '提交作业后执行的命令。', + 'type' => 'string', + 'required' => false, + 'example' => 'example.sh', + ], + ], + [ + 'name' => 'JobQueue', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业的队列名称。'."\n" + ."\n" + .'您可以通过调用[ListQueues](~~92176~~)获取队列名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'Node', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业所需的计算节点数。'."\n" + ."\n" + .'> 若该参数为空，则参数Cpu、Task、Thread、Mem、Gpu不生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Cpu', + 'in' => 'query', + 'schema' => [ + 'description' => '单个计算节点所需的CPU核数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Task', + 'in' => 'query', + 'schema' => [ + 'description' => '单个计算节点创建的进程数。'."\n" + ."\n" + .'适用于MPI作业。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Thread', + 'in' => 'query', + 'schema' => [ + 'description' => '单个计算节点创建的线程数。'."\n" + ."\n" + .'适用于OpenMP作业。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Mem', + 'in' => 'query', + 'schema' => [ + 'description' => '单个计算节点最大使用内存数，支持GB、MB、KB，单位不区分大小写。', + 'type' => 'string', + 'required' => false, + 'example' => '1GB', + ], + ], + [ + 'name' => 'Gpu', + 'in' => 'query', + 'schema' => [ + 'description' => '单个计算节点使用GPU的数量。'."\n" + ."\n" + .'仅支持使用PBS调度器的集群，且集群内计算节点含GPU时该参数生效。 ', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ClockTime', + 'in' => 'query', + 'schema' => [ + 'description' => '作业最大运行时间，支持三种格式：'."\n" + ."\n" + .'- hh:mm:ss'."\n" + .'- mm:ss'."\n" + .'- ss'."\n" + ."\n" + .'推荐使用第一种格式。若最大运行时间为12小时，示例：12:00:00。', + 'type' => 'string', + 'required' => false, + 'example' => '12:00:00', + ], + ], + [ + 'name' => 'JobRetry.Count', + 'in' => 'query', + 'schema' => [ + 'description' => '任务重试次数，取值范围1~10。当前任务重试功能仅适用于PBS集群。'."\n" + ."\n" + .'> 若该参数为空，则参数JobRetry.Priority、JobRetry.OnExitCode不生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'JobRetry.Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '重试作业优先级，取值范围：0~9，取值越大，优先级越高。'."\n" + ."\n" + .'> 若该参数为空，则重试作业优先级=min{原作业优先级+1, 9}', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'JobRetry.OnExitCode', + 'in' => 'query', + 'schema' => [ + 'description' => '作业重试条件。退出码为参数值时，触发作业重试。'."\n" + ."\n" + .'> 若该参数为空，退出码非0时触发作业重试。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '采用异步消息链路提交作业。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => '1.manager', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '提交作业', + 'summary' => '调用SubmitJob在指定集群提交作业。', + 'description' => '## 接口说明'."\n" + .'在集群提交作业前，请确认上传作业文件（如job.sh）到集群。具体操作，请参见[CreateJobFile](~~159049~~)。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'RunasUser', + 'in' => 'query', + 'schema' => [ + 'description' => '创建作业文件的用户名。'."\n" + ."\n" + .'您可以通过调用[ListUsers](~~188572~~)获取该集群中的用户名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testuser1', + ], + ], + [ + 'name' => 'RunasUserPassword', + 'in' => 'query', + 'schema' => [ + 'description' => '用户密码。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '!QAZ****', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '作业文件内容，是以Base64编码的文本内容。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c2xlZXAgMzA=', + ], + ], + [ + 'name' => 'TargetFile', + 'in' => 'query', + 'schema' => [ + 'description' => '作业文件名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'lammps.pbs', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '采用异步消息链路提交作业文件。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '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' => '创建一个作业文件', + 'summary' => '调用CreateJobFile创建一个作业文件。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => '运行作业的用户。'."\n" + ."\n" + .'您可以通过调用[ListUsers](~~188572~~)获取该集群中的用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => '作业状态。取值范围：'."\n" + ."\n" + .'- all：所有状态。'."\n" + .'- finished：已完成。'."\n" + .'- notfinish：未完成。', + 'type' => 'string', + 'required' => false, + 'example' => 'finished', + ], + ], + [ + 'name' => 'Rerunable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否支持重新运行作业。取值范围：'."\n" + .'- true：支持。'."\n" + .'- false：不支持。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'起始值：1。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。最大值：50。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '分页查询时设置的本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Jobs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'JobInfo' => [ + 'description' => '作业信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '执行作业的用户名。', + 'type' => 'string', + 'example' => 'user1', + ], + 'Comment' => [ + 'description' => '作业描述信息。', + 'type' => 'string', + 'example' => 'jobDescription', + ], + 'State' => [ + 'description' => '作业状态。可能值：'."\n" + .'- FINISHED：已完成。'."\n" + .'- RUNNING：运行中。'."\n" + .'- QUEUED：列队等待。', + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'Stderr' => [ + 'description' => '错误输出位置。', + 'type' => 'string', + 'example' => './Temp', + ], + 'Priority' => [ + 'description' => '处理作业的优先级。取值范围：0~9，取值越大，优先级越高。', + 'type' => 'string', + 'example' => '0', + ], + 'ShellPath' => [ + 'description' => '运行作业路径。', + 'type' => 'string', + 'example' => './Temp', + ], + 'Stdout' => [ + 'description' => '标准输出位置。', + 'type' => 'string', + 'example' => './Temp', + ], + 'ArrayRequest' => [ + 'description' => '作业队列格式。如果不是队列作业，输出为空。'."\n" + ."\n" + .'格式为X-Y:Z， 最小值X是第一个索引，最大值Y是最后一个索引，Z表示步长，例如2-7:2，表示作业队列包含编号为2、4、6的3个子作业。', + 'type' => 'string', + 'example' => '1-10:2', + ], + 'StartTime' => [ + 'description' => '作业开始时间。', + 'type' => 'string', + 'example' => '2018-07-18T17:46:48', + ], + 'LastModifyTime' => [ + 'description' => '作业最后修改时间。', + 'type' => 'string', + 'example' => '2018-07-18T17:46:48', + ], + 'NodeList' => [ + 'description' => '运行作业的计算节点列表。', + 'type' => 'string', + 'example' => '[\'compute2\', \'compute3\']', + ], + 'Name' => [ + 'description' => '作业名称。', + 'type' => 'string', + 'example' => 'job1', + ], + 'Id' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => '0.manager', + ], + 'SubmitTime' => [ + 'description' => '作业提交时间。', + 'type' => 'string', + 'example' => '2018-07-18T17:46:47', + ], + 'Resources' => [ + 'description' => '作业运行所需资源。', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '作业运行的节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cores' => [ + 'description' => '运行作业的CPU个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询作业列表', + 'summary' => '调用ListJobs查询指定集群中的作业列表。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '作业ID。'."\n" + ."\n" + .'您可以调用[ListJobs](~~87251~~)查询作业ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1.scheduler****', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '采用异步消息链路停止作业。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9697AD8D-56FA-4C8E-B46C-00AC9***', + ], + 'Message' => [ + 'description' => '信息列表。', + 'type' => 'object', + 'properties' => [ + 'JobInfo' => [ + 'description' => '作业详细信息。', + 'type' => 'string', + 'example' => '{"2.scheduler": {"egroup": "users","Stageout_status": 1,"Keep_Files": "n","server": "scheduler","queue": "workq"}}', + ], + ], + ], + ], + ], + ], + ], + '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' => '查询作业信息', + 'summary' => '调用DescribeJob查询一个集群内指定作业的详细信息。', + ], + 'ListJobsWithFilters' => [ + 'summary' => '按照相关参数查询指定作业详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'起始值：1。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。最大值：50。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Users', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '执行作业的用户列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '执行作业的用户名，支持模糊查询。'."\n" + .'您可以通过调用[ListUsers](~~188572~~)获取该集群中的用户ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'Queues', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '执行作业的队列列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '执行作业的队列名称。支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '执行作业的计算节点列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点名称，支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'node1', + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'JobName', + 'in' => 'query', + 'schema' => [ + 'description' => '作业名称。支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'job1', + ], + ], + [ + 'name' => 'JobStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '作业状态。取值范围：'."\n" + ."\n" + .'- all：所有状态。'."\n" + ."\n" + .'- finished：已完成。'."\n" + ."\n" + .'- notfinish：未完成。'."\n" + ."\n" + .'默认值：all。', + 'type' => 'string', + 'required' => false, + 'example' => 'finished', + ], + ], + [ + 'name' => 'ExecuteOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '按照作业执行时间进行排序。取值范围：'."\n" + ."\n" + .'- asc：升序。'."\n" + ."\n" + .'- desc：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + [ + 'name' => 'SubmitOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '按照作业提交时间进行排序。取值范围：'."\n" + ."\n" + .'- asc：升序。'."\n" + ."\n" + .'- desc：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + [ + 'name' => 'PendOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '按照作业排队时间进行排序。取值范围：'."\n" + ."\n" + .'- asc：升序。'."\n" + ."\n" + .'- desc：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'您可以调用[ListRegions](~~188593~~)查询可以使用E-HPC的地域列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '作业最早提交时间。格式为Unix时间戳，表示从1970-01-01T00:00:00Z起所经过的秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1647427667', + ], + ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '作业最晚提交时间。格式为Unix时间戳，表示从1970-01-01T00:00:00Z起所经过的秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1647428667', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '是否异步查询。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '分页查询时设置的本页条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Jobs' => [ + 'title' => 'Jobs', + 'description' => '作业信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => [ + 'description' => '执行作业的用户名。', + 'type' => 'string', + 'example' => 'test2@scheduler', + ], + 'Comment' => [ + 'description' => '作业描述信息。', + 'type' => 'string', + 'example' => 'jobDescription', + ], + 'State' => [ + 'description' => '作业状态。取值范围：'."\n" + ."\n" + .'- FINISHED：已完成。'."\n" + ."\n" + .'- RUNNING：运行中。'."\n" + ."\n" + .'- QUEUED：列队等待。', + 'type' => 'string', + 'example' => 'FINISHED', + ], + 'Stderr' => [ + 'description' => '错误输出位置。', + 'type' => 'string', + 'example' => './Temp', + ], + 'Priority' => [ + 'description' => '处理作业的优先级。取值范围：0~9，取值越大，优先级越高。', + 'type' => 'string', + 'example' => '0', + ], + 'ShellPath' => [ + 'description' => '运行作业路径。', + 'type' => 'string', + 'example' => './Temp', + ], + 'Stdout' => [ + 'description' => '标准输出位置。', + 'type' => 'string', + 'example' => './Temp', + ], + 'ArrayRequest' => [ + 'description' => '作业队列格式。如果不是队列作业，输出为空。'."\n" + ."\n" + .'格式为X-Y:Z， 最小值X是第一个索引，最大值Y是最后一个索引，Z表示步长，例如2-7:2，表示作业队列包含编号为2、4、6的3个子作业。', + 'type' => 'string', + 'example' => '1-10:2', + ], + 'StartTime' => [ + 'description' => '作业开始时间。', + 'type' => 'string', + 'example' => '1647427667', + ], + 'LastModifyTime' => [ + 'description' => '作业最后修改时间。', + 'type' => 'string', + 'example' => '1647428667', + ], + 'NodeList' => [ + 'description' => '运行作业的计算节点列表。', + 'type' => 'string', + 'example' => '[\'compute2\', \'compute3\']', + ], + 'Name' => [ + 'description' => '作业名称。', + 'type' => 'string', + 'example' => 'job1', + ], + 'Id' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => '8.scheduler', + ], + 'SubmitTime' => [ + 'description' => '作业提交时间戳。', + 'type' => 'string', + 'example' => '1647423718', + ], + 'Resources' => [ + 'description' => '作业运行所需资源。', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '作业运行的节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Cores' => [ + 'description' => '运行作业的CPU个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + 'Queue' => [ + 'description' => '运行作业的队列数量。', + 'type' => 'string', + 'example' => '2', + ], + 'Rerunable' => [ + 'description' => '作业是否支持重新运行。可能值：'."\n" + ."\n" + .'- true：支持。'."\n" + ."\n" + .'- false：不支持。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'VariableList' => [ + 'description' => '作业的变量列表。', + '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' => '执行命令并获取结果的过程是否成功。取值范围：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + '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' => '查询作业详情', + ], + 'RerunJobs' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-sh-3VeFyR****', + ], + ], + [ + 'name' => 'Jobs', + 'in' => 'query', + 'schema' => [ + 'description' => '需要重新运行的作业ID列表，作业数量取值范围：1~100。'."\n" + ."\n" + .'格式为`[{"Id": "0.sched****"},{"Id": "1.sched****"}]`，多个作业间用半角逗号（,）隔开。'."\n" + ."\n" + .'您可以调用[ListJobs](~~87251~~)查询作业ID。'."\n" + ."\n" + .'>需要重新运行的作业状态必须为RUNNING或QUEUED。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Id":"1.scheduler"}]', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '采用异步消息链路重新运行作业。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '重新运行脚本作业', + 'summary' => '调用RerunJobs重新运行一个或多个作业。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Jobs', + 'in' => 'query', + 'schema' => [ + 'description' => '待停止的作业ID列表，作业数量取值范围：1~100。'."\n" + ."\n" + .'格式为`[{"Id": "0.sched****"},{"Id": "1.sched****"}]`，多个作业间用半角逗号（,）隔开。'."\n" + ."\n" + .'您可以调用[ListJobs](~~87251~~)查询作业ID。'."\n" + ."\n" + .'>待停止的作业状态必须为RUNNING或QUEUED。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Id":"1.sched****"},{"Id":"0.sched****"}]', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '采用异步消息链路停止作业。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '批量停止作业', + 'summary' => '调用StopJobs停止指定集群中一个或多个作业。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetJobLog' => [ + 'summary' => '获取指定作业的输出日志。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的作业ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1.scheduler****', + ], + ], + [ + 'name' => 'ExecHost', + 'in' => 'query', + 'schema' => [ + 'description' => '作业所在的节点名称。'."\n" + .'- 对于已经完成的作业，无需指定该参数。'."\n" + .'- 对于正在运行的作业，必须指定该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'compute000', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '单次请求读取的日志大小。'."\n" + ."\n" + .'单位：byte'."\n" + ."\n" + .'默认值：1024'."\n" + ."\n" + .'最大值：400 * 1024', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1024', + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'description' => '日志读取的起始位置。'."\n" + ."\n" + .'单位：byte'."\n" + ."\n" + .'默认值：0', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'JobId' => [ + 'description' => '本次请求查询的作业ID。', + 'type' => 'string', + 'example' => '1.scheduler****', + ], + 'OutputLog' => [ + 'description' => '作业结果日志，是以Base64编码的文本内容。', + 'type' => 'string', + 'example' => 'c2xlZXAgMzA=', + ], + 'ErrorLog' => [ + 'description' => '作业错误日志，是以Base64编码的文本内容。', + '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' => '获取作业日志', + ], + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Jobs', + 'in' => 'query', + 'schema' => [ + 'description' => '待删除的作业ID列表，作业数量取值范围：1~100。'."\n" + ."\n" + .'格式为`[{"Id": "0.sched****"},{"Id": "1.sched****"}]`，多个作业间用半角逗号（,）隔开。'."\n" + ."\n" + .'您可以调用[ListJobs](~~87251~~)查询作业ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[{"Id": "0.sched****"},{"Id": "1.sched****"}]', + ], + ], + [ + 'name' => 'Async', + 'in' => 'query', + 'schema' => [ + 'description' => '采用异步消息链路删除作业。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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.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' => '批量删除作业', + 'summary' => '调用DeleteJobs删除指定集群中一个或多个作业。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SubmitServerlessJob' => [ + 'summary' => '调用SubmitServerlessJob提交Serverless作业到E-HPC集群。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless作业名。'."\n" + .'> 支持英文小写字母、数字或者短划线（-），不能以短划线开头或者结尾。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'testjob', + ], + ], + [ + 'name' => 'ArrayProperties', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数组作业配置。'."\n" + .'> 数组作业索引值会通过环境变量`EHPC_ARRAY_TASK_ID`传入Serverless作业容器中，支持用户业务程序访问。', + 'type' => 'object', + 'properties' => [ + 'IndexStart' => [ + 'description' => '数组作业索引的起始值。取值范围：0~4999。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'IndexEnd' => [ + 'description' => '数组作业索引的结束值。取值范围：0~4999，且大于等于IndexStart。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'IndexStep' => [ + 'description' => '数组作业索引的间隔。'."\n" + .'> 若数组作业属性为IndexStart=1,IndexEnd=5,IndexStep=2，则该数组作业包含三个子任务，子任务索引分别为1,3,5。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'JobPriority', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless作业的调度优先级。取值范围：0~999，取值越大，优先级越高。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'EphemeralStorage', + 'in' => 'query', + 'schema' => [ + 'description' => '为Serverless作业容器增加的临时存储空间大小。单位：GiB。'."\n" + .'> Serverless作业容器默认提供30 GiB的免费存储空间，如果您的存储需求大于30 GiB，可以通过该参数自定义增加临时存储空间大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '200', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless作业的有效期限，超出该时间后，作业会强制终止。单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Serverless作业容器所属的交换机ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机ID。'."\n" + .'> E-HPC当前仅支持VPC网络。您可以调用[DescribeVSwitches](~~35748~~)查询已创建的交换机的相关信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1gb5gf5546rn****', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Serverless作业容器所采用的ECS实例规格列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS实例规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g7.8xlarge', + ], + 'required' => false, + 'docRequired' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'Cpu', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless作业容器的vCPU大小。单位：核。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'docRequired' => false, + 'example' => '2', + 'default' => '1.0', + ], + ], + [ + 'name' => 'Memory', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless作业容器的内存大小。单位：GiB。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'docRequired' => false, + 'example' => '4', + 'default' => '2.0', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的抢占策略。取值范围：'."\n" + ."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式实例。'."\n" + ."\n" + .'默认值：NoSpot。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'SpotWithPriceLimit', + ], + ], + [ + 'name' => 'SpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '设置抢占式实例的每小时最高价格，最多精确到小数点后3位。'."\n" + ."\n" + .'当SpotStrategy取值为SpotWithPriceLimit时，必须设置SpotPriceLimit。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.062', + ], + ], + [ + 'name' => 'RamRoleName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless作业容器绑定的RAM角色名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testRamRoleName', + ], + ], + [ + 'name' => 'Container', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Serverless作业容器的属性。', + 'type' => 'object', + 'properties' => [ + 'EnvironmentVar' => [ + 'description' => '容器的环境变量值。', + 'type' => 'array', + 'items' => [ + 'description' => '容器的环境变量值。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '环境变量名。长度为1~128位。格式要求：[0-9a-zA-Z]，以及下划线，不能以数字开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'PATH', + ], + 'Value' => [ + 'description' => '环境变量值。长度为0~256位。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/bin', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + 'WorkingDir' => [ + 'description' => '容器工作目录。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/'."\n", + ], + 'Image' => [ + 'description' => '容器镜像。', + 'type' => 'string', + 'required' => true, + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/ehpc/hpl:latest'."\n", + ], + 'Command' => [ + 'description' => '容器启动指令列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器启动指令。', + 'type' => 'string', + 'required' => false, + 'example' => 'python3', + ], + 'required' => false, + 'maxItems' => 20, + ], + 'Arg' => [ + 'description' => '容器启动命令对应的参数列表。最多10个。', + 'type' => 'array', + 'items' => [ + 'description' => '容器启动参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello.py', + ], + 'required' => false, + 'maxItems' => 100, + ], + 'Gpu' => [ + 'description' => '容器使用的GPU个数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'VolumeMount' => [ + 'description' => '容器挂载的数据卷列表。', + 'type' => 'array', + 'items' => [ + 'description' => '容器挂载的数据卷信息。', + 'type' => 'object', + 'properties' => [ + 'MountPath' => [ + 'description' => '容器挂载数据卷的目录。 '."\n" + ."\n" + .'> 容器挂载目录下的内容会被Volume的内容直接覆盖，请谨慎使用。', + 'type' => 'string', + 'required' => false, + 'example' => '/data', + ], + 'FlexVolumeDriver' => [ + 'description' => '使用FlexVolume插件挂载数据卷时的驱动类型。取值范围如下：'."\n" + ."\n" + .'- alicloud/nas：挂载NAS。'."\n" + ."\n" + .'- alicloud/oss：挂载OSS。', + 'type' => 'string', + 'required' => false, + 'example' => 'alicloud/oss', + ], + 'FlexVolumeOptions' => [ + 'description' => 'FlexVolume对象选项列表。为KV形式，采用JSON传递。', + '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' => 'Serverless作业依赖列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Serverless作业依赖。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '所依赖的作业ID。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'Type' => [ + 'description' => '依赖类型。取值范围：'."\n" + ."\n" + .'- AfterSucceeded：所依赖作业或数组作业**所有子任务**运行成功（退出码为0）。'."\n" + .'- AfterFailed：所依赖作业或数组作业**任一子任务**运行失败（退出码非0）。'."\n" + .'- AfterAny：所依赖作业运行结束（成功或失败）。'."\n" + .'- AfterCorresponding：所依赖数组作业对应的子任务运行成功（退出码为0）。'."\n" + ."\n" + .'默认值：AfterSucceeded。', + 'type' => 'string', + 'required' => false, + 'example' => 'AfterAny', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + [ + 'name' => 'RetryStrategy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Serverless作业重试策略。', + 'type' => 'object', + 'properties' => [ + 'Attempts' => [ + 'description' => 'Serverless作业重试次数。取值范围：1～10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '1', + 'example' => '5', + ], + 'EvaluateOnExit' => [ + 'description' => 'Serverless作业重试规则列表。最多10个。', + 'type' => 'array', + 'items' => [ + 'description' => 'Serverless作业重试规则。', + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'description' => '作业行为。取值范围如下：'."\n" + ."\n" + .'- Retry：当命中特定退出码时，作业开始新一轮重试。'."\n" + ."\n" + .'- Exit：当命中特定退出码时，作业退出。', + 'type' => 'string', + 'required' => false, + 'example' => 'Retry', + ], + 'OnExitCode' => [ + 'description' => '作业退出码，配合Action构成作业重试规则。取值范围：0～255。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => 'Serverless作业ID。', + 'type' => 'string', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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', + ], + [ + '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' => '提交Serverless作业', + ], + 'ListServerlessJobs' => [ + 'summary' => '按照过滤条件查询Serverless作业列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + .'您可以调用[ListRegions](~~188593~~)查询可以使用E-HPC的地域列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。起始值：1，默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示条数。最大值：100，默认值：20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'JobIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'Serverless作业ID或子任务ID（数组作业）列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Serverless作业ID或子任务ID（数组作业）。', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'JobNames', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'Serverless作业名列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Serverless作业名。', + 'type' => 'string', + 'required' => false, + 'example' => 'testjob', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'description' => 'Serverless作业状态。取值范围：'."\n" + ."\n" + .'- All：所有状态。'."\n" + .'- Pending: 排队中。'."\n" + .'- Running：运行中。'."\n" + .'- Succeeded：已完成。'."\n" + .'- Canceled：已取消。'."\n" + .'- Failed：运行失败。'."\n" + ."\n" + .'默认值：All。', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + 'enum' => [ + 'Pending', + 'Running', + 'Canceled', + 'Failed', + 'All', + 'Succeeded', + ], + ], + ], + [ + 'name' => 'StartOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '按照Serverless作业启动时间进行排序。取值范围：'."\n" + ."\n" + .'- Asc：升序。'."\n" + .'- Desc：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + 'enum' => [ + 'Desc', + 'Asc', + ], + ], + ], + [ + 'name' => 'SubmitOrder', + 'in' => 'query', + 'schema' => [ + 'description' => '按照Serverless作业提交时间进行排序。取值范围：'."\n" + ."\n" + .'- Asc：升序。'."\n" + .'- Desc：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + 'enum' => [ + 'Desc', + 'Asc', + ], + ], + ], + [ + 'name' => 'SubmitTimeStart', + 'in' => 'query', + 'schema' => [ + 'description' => '最早的作业提交时间戳。'."\n" + .'> 用于按照Serverless作业的提交时间范围查询作业列表。', + 'type' => 'string', + 'required' => false, + 'example' => '1647427667', + ], + ], + [ + 'name' => 'SubmitTimeEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '最晚的作业提交时间戳。'."\n" + .'> 用于按照Serverless作业的提交时间范围查询作业列表。', + 'type' => 'string', + 'required' => false, + 'example' => '1659521430', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '分页查询时设置的本页条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Jobs' => [ + 'title' => 'Jobs', + 'description' => 'Serverless作业信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => 'Serverless作业ID或子任务ID（数组作业）。', + 'type' => 'string', + 'example' => '5', + ], + 'JobName' => [ + 'description' => 'Serverless作业名。', + 'type' => 'string', + 'example' => 'testjob', + ], + 'State' => [ + 'description' => 'Serverless作业状态。可能的值：'."\n" + ."\n" + .'- Pending: 排队中。'."\n" + .'- Initing：初始化中。'."\n" + .'- Running：运行中。'."\n" + .'- Succeeded：已完成。'."\n" + .'- Canceled：已取消。'."\n" + .'- Failed：运行失败。', + 'type' => 'string', + 'example' => 'Running', + ], + 'Priority' => [ + 'description' => 'Serverless作业的调度优先级。取值范围：0~999，取值越大，优先级越高。', + 'type' => 'string', + 'example' => '9', + ], + 'Queue' => [ + 'description' => '执行Serverless作业的队列名。', + 'type' => 'string', + 'example' => 'comp', + ], + 'User' => [ + 'description' => '执行Serverless作业的用户名。', + 'type' => 'string', + 'example' => 'testuser', + ], + 'SubmitTime' => [ + 'description' => 'Serverless作业提交时间戳。', + 'type' => 'string', + 'example' => '1647423718', + ], + 'StartTime' => [ + 'description' => 'Serverless作业开始时间戳。', + 'type' => 'string', + 'example' => '1647427667', + ], + 'EndTime' => [ + 'description' => 'Serverless作业结束时间戳。', + 'type' => 'string', + 'example' => '1682128871', + ], + 'IsArrayJob' => [ + 'description' => '是否是数组作业。可能的值：'."\n" + ."\n" + .'- True：是数组作业。'."\n" + .'- False：不是数组作业。', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询Serverless作业列表', + ], + 'DescribeServerlessJobs' => [ + 'summary' => '按照作业ID或子任务ID（数组作业）查询Serverless作业详细信息。当前仅支持传入单个作业ID或单个子任务ID。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'Serverless作业ID或子任务ID（数组作业）列表。'."\n" + .'> - 当Serverless作业为数组作业时，仅支持传入子任务ID。子任务ID格式为：<数组作业ID>\\_<子任务索引>。例如：10\\_3表示ID为10的数组作业中索引为3的子任务。'."\n" + .'> - 该列表当前仅支持传入一个元素。', + 'type' => 'array', + 'items' => [ + 'description' => 'Serverless作业ID或子任务ID（数组作业）。', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + 'required' => true, + 'maxItems' => 1, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '本次请求条件下的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'JobInfos' => [ + 'description' => 'Serverless作业详细信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => 'Serverless作业ID或子任务ID（数组作业）。', + 'type' => 'string', + 'example' => '5', + ], + 'JobName' => [ + 'description' => 'Serverless作业名。', + 'type' => 'string', + 'example' => 'testjob', + ], + 'State' => [ + 'description' => 'Serverless作业状态。可能的值：'."\n" + ."\n" + .'- Pending: 排队中。'."\n" + .'- Initing：初始化中。'."\n" + .'- Running：运行中。'."\n" + .'- Succeeded：已完成。'."\n" + .'- Canceled：已取消。'."\n" + .'- Failed：运行失败。', + 'type' => 'string', + 'example' => 'Running', + ], + 'Priority' => [ + 'description' => 'Serverless作业的调度优先级。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'Queue' => [ + 'description' => '执行Serverless作业的队列名。', + 'type' => 'string', + 'example' => 'comp', + ], + 'User' => [ + 'description' => '执行Serverless作业的用户名。', + 'type' => 'string', + 'example' => 'testuser', + ], + 'SubmitTime' => [ + 'description' => 'Serverless作业提交时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1647423718', + ], + 'StartTime' => [ + 'description' => 'Serverless作业开始时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1647427667', + ], + 'EndTime' => [ + 'description' => 'Serverless作业结束时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1662016121', + ], + 'LastModifyTime' => [ + 'description' => 'Serverless作业最近修改时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1663831441000', + ], + 'IsArrayJob' => [ + 'description' => '是否是数组作业。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ArrayProperties' => [ + 'description' => '数组作业属性。', + 'type' => 'object', + 'properties' => [ + 'IndexStart' => [ + 'description' => '数组作业索引的起始值', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'IndexEnd' => [ + 'description' => '数组作业索引的结束值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'IndexStep' => [ + 'description' => '数组作业索引的间隔。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + 'ContainerGroups' => [ + 'description' => 'Serverless作业容器组实例信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContainerGroupId' => [ + 'description' => '容器组实例ID。', + 'type' => 'string', + 'example' => 'eci-bp1jrgfqqy54kg5hc****', + ], + 'ContainerGroupName' => [ + 'description' => '容器组实例名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'Status' => [ + 'description' => '实例状态。取值范围：'."\n" + ."\n" + .'- Pending：启动中'."\n" + ."\n" + .'- Running：运行中'."\n" + ."\n" + .'- Succeeded：运行成功'."\n" + ."\n" + .'- Failed：运行失败'."\n" + ."\n" + .'- Scheduling：创建中'."\n" + ."\n" + .'- ScheduleFailed：创建失败'."\n" + ."\n" + .'- Restarting：重启中'."\n" + ."\n" + .'- Updating：更新中'."\n" + ."\n" + .'- Terminating：终止中'."\n" + ."\n" + .'- Expired：过期', + 'type' => 'string', + 'example' => 'Running', + ], + 'InstanceType' => [ + 'description' => '指定的ECS实例规格。', + 'type' => 'string', + 'example' => 'ecs.g5.large', + ], + 'SpotStrategy' => [ + 'description' => '实例的抢占策略。取值范围：'."\n" + .'- NoSpot（默认）：正常按量付费节点。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式节点。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'SpotPriceLimit' => [ + 'description' => '抢占式实例的每小时最高价格。'."\n" + ."\n" + .'仅当SpotStrategy为SpotWithPriceLimit时返回。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.025', + ], + 'Cpu' => [ + 'description' => '容器的vCPU大小。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2', + ], + 'Memory' => [ + 'description' => '实例级别内存大小。单位为GiB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.0', + ], + 'Containers' => [ + 'description' => '容器组包含的容器列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => '容器启动参数。', + 'type' => 'array', + 'items' => [ + 'description' => '容器启动参数。', + 'type' => 'string', + 'example' => 'hello.py', + ], + ], + 'Commands' => [ + 'description' => '容器启动命令。', + 'type' => 'array', + 'items' => [ + 'description' => '容器启动命令。', + 'type' => 'string', + 'example' => '/usr/bin/python', + ], + ], + 'Cpu' => [ + 'description' => '容器的vCPU大小。', + 'type' => 'number', + 'format' => 'float', + 'example' => '2.0', + ], + 'CurrentState' => [ + 'description' => '容器当前状态。', + 'type' => 'object', + 'properties' => [ + 'DetailStatus' => [ + 'description' => '容器状态详情。', + 'type' => 'string', + 'example' => 'working', + ], + 'ExitCode' => [ + 'description' => '容器运行退出码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FinishTime' => [ + 'description' => '容器运行结束时间。', + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'Message' => [ + 'description' => '容器状态信息。', + 'type' => 'string', + 'example' => 'Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)', + ], + 'Reason' => [ + 'description' => '容器状态Reason。', + 'type' => 'string', + 'example' => 'Started', + ], + 'Signal' => [ + 'description' => '容器状态信号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '容器运行开始时间。', + 'type' => 'string', + 'example' => '2019-12-19T12:05:02Z'."\n", + ], + 'State' => [ + 'description' => '作业状态。可能值：'."\n" + .'- Waiting'."\n" + .'- Running'."\n" + .'- Terminated', + 'type' => 'string', + 'example' => 'Terminated'."\n", + ], + ], + ], + 'EnvironmentVars' => [ + 'description' => '环境变量。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '环境变量名。', + 'type' => 'string', + 'example' => 'PATH'."\n", + ], + 'Value' => [ + 'description' => '环境变量值。', + 'type' => 'string', + 'example' => '/usr/bin/'."\n", + ], + 'ValueFrom' => [ + 'description' => '环境变量值的来源。 如果值不为空，则无法使用。', + 'type' => 'object', + 'properties' => [ + 'FieldRef' => [ + 'description' => '指定字段。', + 'type' => 'object', + 'properties' => [ + 'FieldPath' => [ + 'description' => '字段的路径。', + 'type' => 'string', + 'example' => 'status.podIP', + ], + ], + ], + ], + ], + ], + ], + ], + 'Gpu' => [ + 'description' => 'GPU个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Image' => [ + 'description' => '容器镜像。', + 'type' => 'string', + 'example' => 'HPL', + ], + 'ImagePullPolicy' => [ + 'description' => '镜像拉取策略。可能值：'."\n" + ."\n" + .'- Always：总是拉取。每次都拉取镜像。'."\n" + .'- IfNotPresent：按需拉取。优先使用本地镜像，本地没有镜像时则拉取镜像。'."\n" + .'- Never：从不拉取。使用本地镜像，不拉取镜像。', + 'type' => 'string', + 'example' => 'Always', + ], + 'LivenessProbe' => [ + 'description' => '存活探针。', + 'type' => 'object', + 'properties' => [ + 'Execs' => [ + 'description' => '执行命令。', + 'type' => 'array', + 'items' => [ + 'description' => '执行命令。', + 'type' => 'string', + 'example' => '["/bin/sh", "-c", "echo Hello world > /usr/share/message"]'."\n", + ], + ], + 'FailureThreshold' => [ + 'description' => '从上次检查成功后认定检查失败的检查次数阈值（必须是连续失败）。默认为3次。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'HttpGet' => [ + 'description' => 'HttpGet。', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'HttpGet检测的路径。', + 'type' => 'string', + 'example' => '/usr/nginx/'."\n", + ], + 'Port' => [ + 'description' => 'HttpGet检测的端口。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80', + ], + 'Scheme' => [ + 'description' => 'HTTP或HTTPS。', + 'type' => 'string', + 'example' => 'HTTP', + ], + ], + ], + 'InitialDelaySeconds' => [ + 'description' => '检查开始执行的时间，以容器启动完成为起点计算。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PeriodSeconds' => [ + 'description' => '检查执行的周期。默认为10秒，最小为1秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'SuccessThreshold' => [ + 'description' => '从上次检查失败后重新认定检查成功的检查次数阈值（必须是连续成功），默认为1。当前必须为1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TcpSocket' => [ + 'description' => 'TcpSocket。', + 'type' => 'object', + 'properties' => [ + 'Host' => [ + 'description' => '主机名。', + 'type' => 'string', + 'example' => '1.2.3.4'."\n", + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '80', + ], + ], + ], + 'TimeoutSeconds' => [ + 'description' => '检查超时的时间，默认为1秒，最小为1秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + 'Memory' => [ + 'description' => '实例级别内存大小。单位为GiB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4.0', + ], + 'Name' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => 'HPL', + ], + 'Ports' => [ + 'description' => '暴露端口和协议。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'description' => '端口号。可能值：1~65535。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8080', + ], + 'Protocol' => [ + 'description' => '协议类型。', + 'type' => 'string', + 'example' => 'TCP', + ], + ], + ], + ], + 'PreviousState' => [ + 'description' => '上一次状态。', + 'type' => 'object', + 'properties' => [ + 'DetailStatus' => [ + 'description' => '状态详情。', + 'type' => 'string', + 'example' => 'working', + ], + 'ExitCode' => [ + 'description' => '容器运行退出码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FinishTime' => [ + 'description' => '容器运行结束时间。', + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'Message' => [ + 'description' => '容器状态信息。', + 'type' => 'string', + 'example' => 'Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)', + ], + 'Reason' => [ + 'description' => '容器状态Reason。', + 'type' => 'string', + 'example' => 'Completed', + ], + 'Signal' => [ + 'description' => '容器状态信号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '容器运行开始时间。', + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'State' => [ + 'description' => '容器状态。可能值：'."\n" + ."\n" + .'- Waiting：启动中'."\n" + .'- Running：运行中'."\n" + .'- Terminated：运行终止', + 'type' => 'string', + 'example' => 'Terminated', + ], + ], + ], + 'ReadinessProbe' => [ + 'description' => '应用业务探针（即就绪探针），用于检查容器是否已经就绪，可以为请求提供服务。', + 'type' => 'object', + 'properties' => [ + 'Execs' => [ + 'description' => '使用命令行方式进行健康检查时，在容器内执行的命令。', + 'type' => 'array', + 'items' => [ + 'description' => '使用命令行方式进行健康检查时，在容器内执行的命令。', + 'type' => 'string', + 'example' => '['."\n" + .' "/bin/sh",'."\n" + .' "-c",'."\n" + .' "echo Hello world > /usr/share/message"'."\n" + .']', + ], + ], + 'FailureThreshold' => [ + 'description' => '从上次检查成功后认定检查失败的检查次数阈值（必须是连续失败），默认为3。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'HttpGet' => [ + 'description' => '使用HTTP请求方式进行健康检查。', + 'type' => 'object', + 'properties' => [ + 'Path' => [ + 'description' => 'HttpGet检测的路径。', + 'type' => 'string', + 'example' => '/usr/local', + ], + 'Port' => [ + 'description' => 'HttpGet检测的端口号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8080', + ], + 'Scheme' => [ + 'description' => 'HTTP／HTTPS。', + 'type' => 'string', + 'example' => 'HTTP', + ], + ], + ], + 'InitialDelaySeconds' => [ + 'description' => '检查开始执行的时间，以容器启动完成为起点计算。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PeriodSeconds' => [ + 'description' => '检查执行的周期，默认为10秒，最小为1秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'SuccessThreshold' => [ + 'description' => '从上次检查失败后重新认定检查成功的检查次数阈值（必须是连续成功），默认为1。当前必须为1', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'TcpSocket' => [ + 'description' => '使用TCP Socket方式进行健康检查。', + 'type' => 'object', + 'properties' => [ + 'Host' => [ + 'description' => 'Host。', + 'type' => 'string', + 'example' => '1.2.3.4', + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8888', + ], + ], + ], + 'TimeoutSeconds' => [ + 'description' => '检查超时的时间，默认为1秒，最小为1秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + 'Ready' => [ + 'description' => '指定容器是否已通过其就绪探针。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RestartCount' => [ + 'description' => '重启次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'SecurityContext' => [ + 'description' => '容器运行的安全上下文。', + 'type' => 'object', + 'properties' => [ + 'Capability' => [ + 'description' => '容器内的进程所具备的特定权限。', + 'type' => 'object', + 'properties' => [ + 'Adds' => [ + 'description' => '容器内的进程所具备的特定权限。', + 'type' => 'array', + 'items' => [ + 'description' => '容器内的进程所具备的特定权限。', + 'type' => 'string', + 'example' => 'NET_ADMIN', + ], + ], + ], + ], + 'ReadOnlyRootFilesystem' => [ + 'description' => '是否只读根文件系统，目前仅支持True。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RunAsUser' => [ + 'description' => '用于运行容器进程入口点的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1558', + ], + ], + ], + 'Stdin' => [ + 'description' => '此容器是否应在容器运行时为标准输入分配缓冲区。如果未设置，则容器中标准输入的读取值将导致EOF。默认为false。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'StdinOnce' => [ + 'description' => '当标准输入为true时，标准输入流将在多个附加会话中保持开启状态。如果StdinOnce设为true，标准输入在容器开启时被打开，在首个客户端附加到标准输入之前都为空，然后会一直保持开启状态，接收数据，直到客户端连接断开，此时标准输入被关闭，在容器重启前一直保持关闭状态。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tty' => [ + 'description' => '是否开启交互。默认为false。例如：当Command配置为/bin/bash时，需要配置为true。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'VolumeMounts' => [ + 'description' => '挂载的数据卷信息。', + 'type' => 'array', + 'items' => [ + 'description' => '挂载的数据卷信息。', + 'type' => 'object', + 'properties' => [ + 'MountPath' => [ + 'description' => '挂载目录，容器的挂载目录下的内容被Volume的内容直接覆盖。', + 'type' => 'string', + 'example' => '/usr/share/', + ], + 'MountPropagation' => [ + 'description' => '数据卷的挂载传播设置。挂载传播允许将Container挂载的卷共享到同一Pod中的其他Container，甚至可以共享到同一节点上的其他Pod。可能值：'."\n" + ."\n" + .'- None：该卷不感知任何后续在此卷或其子目录上执行的挂载操作。'."\n" + .'- HostToContainer：该卷将会感知到后续在此卷或其子目录上的挂载操作。'."\n" + .'- Bidirectional：和HostToContainer类似，能感知挂载操作。另外，该卷将被传播回主机和使用同一卷的所有Pod的所有容器。', + 'type' => 'string', + 'example' => 'None', + ], + 'Name' => [ + 'description' => '数据卷名称。', + 'type' => 'string', + 'example' => 'test-empty', + ], + 'ReadOnly' => [ + 'description' => '是否只读。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SubPath' => [ + 'description' => '数据卷下的子目录。方便实例将同一个数据卷下的不同目录挂载到容器的不同目录。', + 'type' => 'string', + 'example' => '/usr/sub', + ], + ], + ], + ], + 'WorkingDir' => [ + 'description' => '工作目录。', + 'type' => 'string', + 'example' => '/usr/local/nginx', + ], + ], + ], + ], + 'Volumes' => [ + 'description' => '数据卷信息。', + 'type' => 'array', + 'items' => [ + 'description' => '数据卷信息。', + 'type' => 'object', + 'properties' => [ + 'ConfigFileVolumeConfigFileToPaths' => [ + 'description' => '配置文件路径列表。', + 'type' => 'array', + 'items' => [ + 'description' => '配置文件路径列表。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '配置文件内容 (32KB)。', + 'type' => 'string', + 'example' => 'hello world', + ], + 'Path' => [ + 'description' => '相对文件路径。', + 'type' => 'string', + 'example' => '/usr/bin/', + ], + ], + ], + ], + 'DiskVolumeDiskId' => [ + 'description' => 'DiskVolume的ID。', + 'type' => 'string', + 'example' => 'd-xxxx', + ], + 'DiskVolumeFsType' => [ + 'description' => '数据卷类型。', + 'type' => 'string', + 'example' => 'xfs', + ], + 'EmptyDirVolumeMedium' => [ + 'description' => 'EmptyDir数据卷的存储媒介。默认为空，表示使用node文件系统。支持配置为以下值：'."\n" + ."\n" + .'- Memory：表示使用内存。'."\n" + .'- LocalRaid0：表示将本地盘组成RAID 0。该取值仅适用于创建本地盘实例并挂载本地盘的场景。更多信息，请参见[创建本地盘实例](~~114664~~)。', + 'type' => 'string', + 'example' => 'Memory', + ], + 'EmptyDirVolumeSizeLimit' => [ + 'description' => 'EmptyDir数据卷的大小。取值请带上单位，建议使用Gi或Mi', + 'type' => 'string', + 'example' => '256Mi', + ], + 'FlexVolumeDriver' => [ + 'description' => '用于FlexVolume的驱动程序名称。', + 'type' => 'string', + 'example' => 'flexvolume', + ], + 'FlexVolumeFsType' => [ + 'description' => '挂载的文件系统类型，默认取决于FlexVolume的script。', + 'type' => 'string', + 'example' => 'ntfs', + ], + 'FlexVolumeOptions' => [ + 'description' => 'FlexVolume对象选项列表。', + 'type' => 'string', + 'example' => '[nolock,tcp,noresvport]', + ], + 'NFSVolumePath' => [ + 'description' => 'NFS数据卷路径。', + 'type' => 'string', + 'example' => '/eci', + ], + 'NFSVolumeReadOnly' => [ + 'description' => '是否只读。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'NFSVolumeServer' => [ + 'description' => 'NFS服务器地址。', + 'type' => 'string', + 'example' => '0eafxxxxx-xxxxx.cn-hangzhou.nas.aliyuncs.com', + ], + 'Name' => [ + 'description' => '数据卷名称。', + 'type' => 'string', + 'example' => 'test-empty', + ], + 'Type' => [ + 'description' => '数据卷类型，可能值：'."\n" + .'- EmptyDirVolume'."\n" + .'- NFSVolume'."\n" + .'- ConfigFileVolume'."\n" + .'- FlexVolume', + 'type' => 'string', + 'example' => 'EmptyDirVolume', + ], + ], + ], + ], + 'Events' => [ + 'description' => '事件信息，上限50。', + 'type' => 'array', + 'items' => [ + 'description' => '事件信息，上限50。', + 'type' => 'object', + 'properties' => [ + 'Count' => [ + 'description' => '事件数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'FirstTimestamp' => [ + 'description' => '事件起始时间。', + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'LastTimestamp' => [ + 'description' => '事件结束时间。', + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z'."\n", + ], + 'Message' => [ + 'description' => '事件消息。', + 'type' => 'string', + 'example' => 'Started container', + ], + 'Name' => [ + 'description' => '事件的归属对象名。', + 'type' => 'string', + 'example' => 'test-xxx', + ], + 'Reason' => [ + 'description' => '事件名。', + 'type' => 'string', + 'example' => 'Created', + ], + 'Type' => [ + 'description' => '事件类型。可能值：'."\n" + .'- Normal'."\n" + .'- Warning', + 'type' => 'string', + 'example' => 'Normal', + ], + ], + ], + ], + 'CreationTime' => [ + 'description' => '接到请求后的系统创建时间。UTC时间，RFC3339标准。', + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'SucceededTime' => [ + 'description' => '容器全部成功退出后的时间。UTC时间，RFC3339标准。', + 'type' => 'string', + 'example' => '2019-12-11T04:33:42Z', + ], + 'ExpiredTime' => [ + 'description' => '由于账户欠费导致实例运行失败的时间。UTC时间，RFC3339标准。', + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'FailedTime' => [ + 'description' => '实例运行失败的时间。UTC时间，RFC 3339标准。', + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'Discount' => [ + 'description' => '折扣。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'DnsConfig' => [ + 'description' => 'DNS配置信息。', + 'type' => 'object', + 'properties' => [ + 'NameServers' => [ + 'description' => 'DNS服务器IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '[10.2.*.*]', + ], + ], + 'Options' => [ + 'description' => '对象选项列表，每个对象由Name和Value（可选）构成。', + 'type' => 'array', + 'items' => [ + 'description' => '对象选项列表，每个对象由Name和Value（可选）构成。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '对象变量名。', + 'type' => 'string', + 'example' => 'name', + ], + 'Value' => [ + 'description' => '对象变量值。', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'Searches' => [ + 'description' => 'DNS搜索域列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'DNS搜索域。', + 'type' => 'string', + 'example' => 'svc.local.kubenetes', + ], + ], + ], + ], + 'EciSecurityContext' => [ + 'description' => '容器组运行的安全上下文。', + 'type' => 'object', + 'properties' => [ + 'Sysctls' => [ + 'description' => 'sysctl参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'sysctl参数。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'sysctl参数名。', + 'type' => 'string', + 'example' => 'kernel.msgmax', + ], + 'Value' => [ + 'description' => 'sysctl参数值。', + 'type' => 'string', + 'example' => '65536', + ], + ], + ], + ], + ], + ], + 'EniInstanceId' => [ + 'description' => '弹性网卡ID。', + 'type' => 'string', + 'example' => 'eni-bp14rzqi6fd8satm****', + ], + 'EphemeralStorage' => [ + 'description' => '临时存储空间大小。单位为：GiB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'HostAliases' => [ + 'description' => '自定义实例内一个容器的Hostname映射。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义实例内一个容器的Hostname映射。', + 'type' => 'object', + 'properties' => [ + 'Hostnames' => [ + 'description' => '主机信息。', + 'type' => 'array', + 'items' => [ + 'description' => '主机名。', + 'type' => 'string', + 'example' => '[\'hehe.com\', \'haha.com\']', + ], + ], + 'Ip' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + ], + ], + ], + 'InitContainers' => [ + 'description' => 'Init容器列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Init容器列表。', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => '启动参数。', + 'type' => 'array', + 'items' => [ + 'description' => '启动参数。', + 'type' => 'string', + 'example' => '[\'hello world\']', + ], + ], + 'Command' => [ + 'description' => '启动命令。', + 'type' => 'array', + 'items' => [ + 'description' => '启动命令。', + 'type' => 'string', + 'example' => '[/bin/sh echo]', + ], + ], + 'Cpu' => [ + 'description' => 'vCPU大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1.0', + ], + 'CurrentState' => [ + 'description' => '当前状态。', + 'type' => 'object', + 'properties' => [ + 'DetailStatus' => [ + 'description' => '状态详情。', + 'type' => 'string', + 'example' => 'working', + ], + 'ExitCode' => [ + 'description' => '容器退出码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FinishTime' => [ + 'description' => '容器运行结束时间。', + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'Message' => [ + 'description' => '事件消息。', + 'type' => 'string', + 'example' => 'Created container', + ], + 'Reason' => [ + 'description' => '容器状态Reason。', + 'type' => 'string', + 'example' => 'Started', + ], + 'Signal' => [ + 'description' => '容器状态信号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '容器运行开始时间。', + 'type' => 'string', + 'example' => '2018-08-02T15:00:00Z', + ], + 'State' => [ + 'description' => '容器状态。可能值：'."\n" + .'- Waiting'."\n" + .'- Running'."\n" + .'- Terminated', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + 'EnvironmentVars' => [ + 'description' => '环境变量。', + 'type' => 'array', + 'items' => [ + 'description' => '环境变量。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '环境变量名。', + 'type' => 'string', + 'example' => 'PATH', + ], + 'Value' => [ + 'description' => '环境变量值。', + 'type' => 'string', + 'example' => '/usr/local/bin', + ], + 'ValueFrom' => [ + 'description' => '环境变量值的来源。 如果值不为空，则无法使用。', + 'type' => 'object', + 'properties' => [ + 'FieldRef' => [ + 'description' => '指定的字段。', + 'type' => 'object', + 'properties' => [ + 'FieldPath' => [ + 'description' => '指定的版本中选择字段的路径，目前只支持 `status.podIP`。', + 'type' => 'string', + 'example' => 'status.podIP', + ], + ], + ], + ], + ], + ], + ], + ], + 'Gpu' => [ + 'description' => 'GPU个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Image' => [ + 'description' => '镜像。', + 'type' => 'string', + 'example' => 'nginx', + ], + 'ImagePullPolicy' => [ + 'description' => '镜像拉取策略。', + 'type' => 'string', + 'example' => 'Always', + ], + 'Memory' => [ + 'description' => 'Init容器内存大小。单位为GiB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2.0', + ], + 'Name' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => 'Init-xxx', + ], + 'Ports' => [ + 'description' => '暴露端口和协议。', + 'type' => 'array', + 'items' => [ + 'description' => '暴露端口和协议。', + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'description' => '端口号。可能值：1~65535。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8888', + ], + 'Protocol' => [ + 'description' => '协议类型。', + 'type' => 'string', + 'example' => 'TCP', + ], + ], + ], + ], + 'PreviousState' => [ + 'description' => '上一次状态。', + 'type' => 'object', + 'properties' => [ + 'DetailStatus' => [ + 'description' => '状态详情。', + 'type' => 'string', + 'example' => 'working', + ], + 'ExitCode' => [ + 'description' => '容器运行退出码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'FinishTime' => [ + 'description' => '容器运行结束时间。', + 'type' => 'string', + 'example' => '2019-12-24T05:35:44Z', + ], + 'Message' => [ + 'description' => '容器状态信息。', + 'type' => 'string', + 'example' => 'Started container', + ], + 'Reason' => [ + 'description' => '容器状态Reason。', + 'type' => 'string', + 'example' => 'completed', + ], + 'Signal' => [ + 'description' => '容器状态信号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '容器运行开始时间。', + 'type' => 'string', + 'example' => '2019-12-24T05:35:44Z', + ], + 'State' => [ + 'description' => '容器状态，枚举值：Waiting，Running，Terminated。', + 'type' => 'string', + 'example' => 'Terminated', + ], + ], + ], + 'Ready' => [ + 'description' => '指定容器是否已通过其就绪探针。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RestartCount' => [ + 'description' => '重启次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'SecurityContext' => [ + 'description' => '容器运行的安全上下文。', + 'type' => 'object', + 'properties' => [ + 'Capability' => [ + 'description' => '容器内的进程所具备的特定权限。', + 'type' => 'object', + 'properties' => [ + 'Adds' => [ + 'description' => '容器内的进程所具备的特定权限。', + 'type' => 'array', + 'items' => [ + 'description' => '容器内的进程所具备的特定权限。', + 'type' => 'string', + 'example' => 'NET_ADMIN', + ], + ], + ], + ], + 'ReadOnlyRootFilesystem' => [ + 'description' => '是否只读根文件系统，目前仅支持True。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RunAsUser' => [ + 'description' => '用于运行容器进程入口点的UID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1557', + ], + ], + ], + 'VolumeMounts' => [ + 'description' => 'Init容器挂载的数据卷信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'Init容器挂载的数据卷信息。', + 'type' => 'object', + 'properties' => [ + 'MountPath' => [ + 'description' => '挂载目录，容器的挂载目录下的内容被Volume的内容直接覆盖。', + 'type' => 'string', + 'example' => '/usr/share/', + ], + 'MountPropagation' => [ + 'description' => '数据卷的挂载传播设置。挂载传播允许将Container挂载的卷共享到同一Pod中的其他Container，甚至可以共享到同一节点上的其他Pod。可能值：'."\n" + ."\n" + .'- None：该卷不感知任何后续在此卷或其子目录上执行的挂载操作。'."\n" + .'- HostToCotainer：该卷将会感知到后续在此卷或其子目录上的挂载操作。'."\n" + .'- Bidirectional：和HostToCotainer类似，能感知挂载操作。另外，该卷将被传播回主机和使用同一卷的所有Pod的所有容器。'."\n" + ."\n" + .'默认值：None。', + 'type' => 'string', + 'example' => 'None', + ], + 'Name' => [ + 'description' => '数据卷名称，同 Volume 中的 Name。', + 'type' => 'string', + 'example' => 'test-empty', + ], + 'ReadOnly' => [ + 'description' => '默认值为False。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'WorkingDir' => [ + 'description' => '工作目录。', + 'type' => 'string', + 'example' => '/usr/test', + ], + ], + ], + ], + 'InternetIp' => [ + 'description' => '公网IP。', + 'type' => 'string', + 'example' => '192.0.XX.XX', + ], + 'IntranetIp' => [ + 'description' => '内网IP。', + 'type' => 'string', + 'example' => '172.16.XX.XX', + ], + 'Ipv6Address' => [ + 'description' => 'IPv6地址。', + 'type' => 'string', + 'example' => '2001:XXXX:4:4:4:4:4:4', + ], + 'RamRoleName' => [ + 'description' => '实例RAM角色名称，ECI与ECS共用实例RAM角色，具体操作，请参见[通过API使用实例RAM角色](~~61178~~)。', + 'type' => 'string', + 'example' => 'ram:PassRole', + ], + 'RegionId' => [ + 'description' => '实例所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResourceGroupId' => [ + 'description' => '实例所属的资源组ID。如果创建实例时没有指定资源组，实例将自动加入账号下的默认资源组。', + 'type' => 'string', + 'example' => 'rg-aekzh43v*****', + ], + 'RestartPolicy' => [ + 'description' => '实例重启策略。取值范围：'."\n" + ."\n" + .'- Always：总是重启'."\n" + .'- Never：从不重启'."\n" + .'- OnFailure：失败时重启', + 'type' => 'string', + 'example' => 'Never', + ], + 'SecurityGroupId' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-bp12ujq5zpxuyjfo3o8r', + ], + 'Tags' => [ + 'description' => '实例标签信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'name', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'test-xh', + ], + ], + ], + ], + 'TenantEniInstanceId' => [ + 'description' => '该参数未开放使用。', + 'type' => 'string', + 'example' => 'i-xxx', + ], + 'TenantEniIp' => [ + 'description' => '该参数未开放使用。', + 'type' => 'string', + 'example' => '10.10.XX.XX', + ], + 'TenantSecurityGroupId' => [ + 'description' => '该参数未开放使用。', + 'type' => 'string', + 'example' => 'sg-xxx', + ], + 'TenantVSwitchId' => [ + 'description' => '该参数未开放使用。', + 'type' => 'string', + 'example' => 'vsw-xxx', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1vzjjflab6wvjox****', + ], + 'VpcId' => [ + 'description' => '实例所属的VPC ID。', + 'type' => 'string', + 'example' => 'vpc-1vzjjflab6wvjox****', + ], + 'ZoneId' => [ + 'description' => '实例所属的可用区。', + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询Serverless作业详细信息', + ], + 'StopServerlessJobs' => [ + 'summary' => '按照作业ID或子任务ID（数组作业）停止集群中一个或多个Serverless作业。当传入数组作业的作业ID时，会停止该作业下的所有子任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobIds', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'Serverless作业ID或子任务ID（数组作业）列表。'."\n" + .'> - 当传入数组作业的作业ID时，会停止该数组作业下的所有子任务。'."\n" + .'> - 当传入数组作业下的子任务ID时，仅停止该子任务。', + 'type' => 'array', + 'items' => [ + 'description' => 'Serverless作业ID或子任务ID（数组作业）。', + 'type' => 'string', + 'required' => false, + 'example' => '5', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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.', + ], + [ + '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' => '批量停止Serverless作业', + ], + 'CreateJobTemplate' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CommandLine', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业命令。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => './LammpsTest/lammps.pbs', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '作业模板名称。长度为2~64字符，必须以英文字母开头，可以包含数字、短划线（-）、下划线（_）。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'jobtemplate1', + ], + ], + [ + 'name' => 'RunasUser', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业的用户名。'."\n" + ."\n" + .'您可以通过调用[ListUsers](~~188572~~)获取用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'user1', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业优先级，取值范围：0~9，取值越大，优先级越高。'."\n" + ."\n" + .'默认值：0', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PackagePath', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业路径。', + 'type' => 'string', + 'required' => false, + 'example' => './jobfolder', + ], + ], + [ + 'name' => 'StdoutRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => '标准输出路径。', + 'type' => 'string', + 'required' => false, + 'example' => './LammpsTest', + ], + ], + [ + 'name' => 'StderrRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => '错误输出路径。', + 'type' => 'string', + 'required' => false, + 'example' => './LammpsTest', + ], + ], + [ + 'name' => 'ReRunable', + 'in' => 'query', + 'schema' => [ + 'description' => '作业执行失败后，是否支持自动重试。取值范围：'."\n" + .'- true：支持'."\n" + .'- false：不支持', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ArrayRequest', + 'in' => 'query', + 'schema' => [ + 'description' => '作业队列。'."\n" + ."\n" + .'格式X-Y:Z， 最小值X是第一个索引，最大值Y是最后一个索引，Z表示步长，例如2-7:2，表示作业队列包含编号为2、4、6的3个子作业。', + 'type' => 'string', + 'required' => false, + 'example' => '1-10:2', + ], + ], + [ + 'name' => 'Variables', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业的环境变量，可以在作业执行文件中访问环境变量。', + 'type' => 'string', + 'required' => false, + 'example' => '[{Name:,Value:},{Name:,Value:}]', + ], + ], + [ + 'name' => 'Queue', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业的队列名称。'."\n" + ."\n" + .'您可以通过调用[ListQueues](~~92176~~)获取队列名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'ClockTime', + 'in' => 'query', + 'schema' => [ + 'description' => '作业最大运行时间，支持三种格式：'."\n" + .'- hh:mm:ss'."\n" + .'- mm:ss'."\n" + .'- ss'."\n" + ."\n" + .'推荐使用第一种格式。若最大运行时间为12小时，示例：12:00:00。', + 'type' => 'string', + 'required' => false, + 'example' => '12:00:00', + ], + ], + [ + 'name' => 'Node', + 'in' => 'query', + 'schema' => [ + 'description' => '提交作业所需计算节点数。取值范围：1~500'."\n" + ."\n" + .'>若该参数为空，则参数Task、Thread、Mem、Gpu不生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5000', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'Task', + 'in' => 'query', + 'schema' => [ + 'description' => '单个计算节点所需任务数。取值范围：1~1000', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'Thread', + 'in' => 'query', + 'schema' => [ + 'description' => '单个任务所需线程数。取值范围：1~1000', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Mem', + 'in' => 'query', + 'schema' => [ + 'description' => '单个计算节点最大使用内存数，支持GB、MB、KB，单位不区分大小写。', + 'type' => 'string', + 'required' => false, + 'example' => '1GB', + ], + ], + [ + 'name' => 'Gpu', + 'in' => 'query', + 'schema' => [ + 'description' => '单个计算节点使用GPU的数量，取值范围：1~8。'."\n" + ."\n" + .'仅支持使用PBS调度器的集群，且集群内计算节点含GPU时该参数生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'InputFileUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '已上传到OSS上的作业文件链接。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://test.oss-cn-beijing.aliyuncs.com/test.py', + ], + ], + [ + 'name' => 'WithUnzipCmd', + 'in' => 'query', + 'schema' => [ + 'description' => '是否解压下载后的作业文件。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'UnzipCmd', + 'in' => 'query', + 'schema' => [ + 'description' => '解压命令，当WithUnzipCmd取值为true时，该参数生效。取值范围：'."\n" + ."\n" + .'- tar xzf：解开gzip格式压缩包'."\n" + ."\n" + .'- tar xf：解开tar格式压缩包'."\n" + ."\n" + .'- unzip：解开zip格式压缩包', + 'type' => 'string', + 'required' => false, + 'example' => 'tar xzf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '作业模板ID。', + 'type' => 'string', + 'example' => 'ehpc-job-tmpl-6RxO5y****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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.', + ], + ], + 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' => '创建作业模板', + 'summary' => '调用CreateJobTemplate创建作业模板。', + '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' => '作业模板名称。'."\n" + ."\n" + .'您可以通过调用[ListJobTemplates](~~87248~~)获取模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'jobtemplateName', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。起始值：1'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。最大值：50'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Templates' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'JobTemplates' => [ + 'description' => '作业模板信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Task' => [ + 'description' => '单个计算节点所需任务数。可能值：1~1000', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Variables' => [ + 'description' => '作业的环境变量。', + 'type' => 'string', + 'example' => '[{Name:,Value:},{Name:,Value:}]', + ], + 'CommandLine' => [ + 'description' => '执行作业命令。', + 'type' => 'string', + 'example' => './LammpsTest/lammps.pbs', + ], + 'Queue' => [ + 'description' => '作业队列。', + 'type' => 'string', + 'example' => 'workq', + ], + 'Priority' => [ + 'description' => '作业优先级。可能值：0~9，取值越大，优先级越高。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Mem' => [ + 'description' => '单个计算节点最大使用内存数。支持GB、MB、KB，单位不区分大小写。', + 'type' => 'string', + 'example' => '1GB', + ], + 'Thread' => [ + 'description' => '单个任务所需线程数。可能值：1~1000', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ArrayRequest' => [ + 'description' => '作业队列。'."\n" + ."\n" + .'格式为X-Y:Z， 最小值X是第一个索引，最大值Y是最后一个索引，Z表示步长，例如2-7:2，表示作业队列包含编号为2、4、6的3个子作业。', + 'type' => 'string', + 'example' => '2-7:2', + ], + 'StderrRedirectPath' => [ + 'description' => '错误输出路径。', + 'type' => 'string', + 'example' => './LammpsTest', + ], + 'Node' => [ + 'description' => '提交作业所需计算节点数。可能值：1~500', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'StdoutRedirectPath' => [ + 'description' => '标准输出路径。', + 'type' => 'string', + 'example' => './Lammps', + ], + 'Gpu' => [ + 'description' => '单个计算节点使用GPU的数量。可能值：1~8。'."\n" + ."\n" + .'仅支持使用pbs调度器的集群，且集群内计算节点含GPU时该参数生效。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PackagePath' => [ + 'description' => '执行作业路径。', + 'type' => 'string', + 'example' => './jobfolder', + ], + 'ClockTime' => [ + 'description' => '作业最大运行时间。支持三种格式：'."\n" + .'- hh:mm:ss'."\n" + .'- mm:ss'."\n" + .'- ss', + 'type' => 'string', + 'example' => '12:00:00', + ], + 'ReRunable' => [ + 'description' => '是否支持重新执行作业。可能值：'."\n" + ."\n" + .'- true：支持'."\n" + ."\n" + .'- false：不支持', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Name' => [ + 'description' => '作业模板名称。', + 'type' => 'string', + 'example' => 'job1', + ], + 'Id' => [ + 'description' => '作业模板ID。', + 'type' => 'string', + 'example' => 'ehpc-job-tmpl-6RxO5y****', + ], + 'RunasUser' => [ + 'description' => '执行作业的用户名称。', + 'type' => 'string', + 'example' => 'user1', + ], + 'InputFileUrl' => [ + 'description' => '已上传到OSS上的作业文件链接。', + 'type' => 'string', + 'example' => 'https://test.oss-cn-beijing.aliyuncs.com/test.py', + ], + 'WithUnzipCmd' => [ + 'description' => '是否解压下载后的作业文件。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'UnzipCmd' => [ + 'description' => '解压命令，当WithUnzipCmd取值为true时，该参数生效。取值范围：'."\n" + ."\n" + .'- tar xzf：解开gzip格式压缩包'."\n" + ."\n" + .'- tar xf：解开tar格式压缩包'."\n" + ."\n" + .'- unzip：解开zip格式压缩包', + 'type' => 'string', + 'example' => 'tar xzf', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询作业模板列表', + 'summary' => '调用ListJobTemplates查询作业模板列表。', + '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' => '作业模板ID。'."\n" + ."\n" + .'您可以通过调用[ListJobTemplates](~~87248~~)获取待修改的模板ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-job-tmpl-6RxO5y****', + ], + ], + [ + 'name' => 'CommandLine', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业命令。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => './LammpsTest/lammps.pbs', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '作业模板名称。'."\n" + ."\n" + .'您可以通过调用[ListJobTemplates](~~87248~~)获取待修改的模板名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'jobTemapleteName', + ], + ], + [ + 'name' => 'RunasUser', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业的用户名。'."\n" + ."\n" + .'您可以通过调用[ListUsers](~~188572~~)获取用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业优先级，取值范围：0~9，取值越大，优先级越高。'."\n" + ."\n" + .'默认值：0', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'PackagePath', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业路径。', + 'type' => 'string', + 'required' => false, + 'example' => './packageFolder', + ], + ], + [ + 'name' => 'StdoutRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => '标准输出路径。', + 'type' => 'string', + 'required' => false, + 'example' => './LammpsTest', + ], + ], + [ + 'name' => 'StderrRedirectPath', + 'in' => 'query', + 'schema' => [ + 'description' => '错误输出路径。', + 'type' => 'string', + 'required' => false, + 'example' => './Lammps', + ], + ], + [ + 'name' => 'ReRunable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否支持重新执行作业。取值范围：'."\n" + .'- true：支持'."\n" + .'- false：不支持', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ArrayRequest', + 'in' => 'query', + 'schema' => [ + 'description' => '作业队列。 '."\n" + ."\n" + .'格式X-Y:Z， 最小值X是第一个索引，最大值Y是最后一个索引，Z表示步长，例如2-7:2，表示作业队列包含编号为2、4、6的3个子作业。', + 'type' => 'string', + 'required' => false, + 'example' => '1-10:2', + ], + ], + [ + 'name' => 'Variables', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业的环境变量，可以在作业执行文件中访问环境变量。', + 'type' => 'string', + 'required' => false, + 'example' => '[{Name:,Value:},{Name:,Value:}]', + ], + ], + [ + 'name' => 'Queue', + 'in' => 'query', + 'schema' => [ + 'description' => '执行作业的队列名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'workq', + ], + ], + [ + 'name' => 'ClockTime', + 'in' => 'query', + 'schema' => [ + 'description' => '作业最大运行时间，支持三种格式：'."\n" + .'- hh:mm:ss'."\n" + .'- mm:ss'."\n" + .'- ss'."\n" + ."\n" + .'推荐使用第一种格式。若最大运行时间为12小时，示例：12:00:00。', + 'type' => 'string', + 'required' => false, + 'example' => '12:00:00', + ], + ], + [ + 'name' => 'Node', + 'in' => 'query', + 'schema' => [ + 'description' => '提交作业所需计算节点数。取值范围：1~500'."\n" + .'>若该参数为空，则参数Task、Thread、Mem、Gpu不生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5000', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'Task', + 'in' => 'query', + 'schema' => [ + 'description' => '单个计算节点所需任务数。取值范围：1~1000', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'Thread', + 'in' => 'query', + 'schema' => [ + 'description' => '单个任务所需线程数。取值范围：1~1000', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'Mem', + 'in' => 'query', + 'schema' => [ + 'description' => '单个计算节点最大使用内存数，支持GB、MB、KB，单位不区分大小写。', + 'type' => 'string', + 'required' => false, + 'example' => '1GB', + ], + ], + [ + 'name' => 'Gpu', + 'in' => 'query', + 'schema' => [ + 'description' => '单个计算节点使用GPU的数量，取值范围：1~8。'."\n" + ."\n" + .'仅支持使用pbs调度器的集群，且集群内计算节点含GPU时该参数生效。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'InputFileUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '已上传到OSS上的作业文件链接。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://test.oss-cn-beijing.aliyuncs.com/test.py', + ], + ], + [ + 'name' => 'WithUnzipCmd', + 'in' => 'query', + 'schema' => [ + 'description' => '是否解压下载后的作业文件。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'UnzipCmd', + 'in' => 'query', + 'schema' => [ + 'description' => '解压命令，当WithUnzipCmd取值为true时，该参数生效。取值范围：'."\n" + ."\n" + .'- tar xzf：解开gzip格式压缩包'."\n" + ."\n" + .'- tar xf：解开tar格式压缩包'."\n" + ."\n" + .'- unzip：解开zip格式压缩包', + 'type' => 'string', + 'required' => false, + 'example' => 'tar xzf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'description' => '作业模板ID。', + 'type' => 'string', + 'example' => 'ehpc-job-tmpl-6RxO5y****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '编辑作业模板', + 'summary' => '调用EditJobTemplate编辑作业模板。', + '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' => '待删除的作业模板ID列表，取值范围：1~20'."\n" + ."\n" + .'格式为`[{"Id": "0.sched****"},{"Id": "1.sched****"}]`，多个作业模板ID之间用半角逗号（,）隔开。'."\n" + ."\n" + .'您可以通过调用[ListJobTemplates](~~87248~~)获取作业模板ID。', + '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' => '请求ID。', + '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.', + ], + ], + 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' => '批量删除作业模板', + 'summary' => '调用DeleteJobTemplates删除一个或多个作业模板。', + ], + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Command', + 'in' => 'query', + 'schema' => [ + 'description' => '命令内容。长度为2~2048个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'echo "hello world"', + ], + ], + [ + 'name' => 'WorkingDir', + 'in' => 'query', + 'schema' => [ + 'description' => '命令工作目录。默认值为`/root`。', + 'type' => 'string', + 'required' => false, + 'example' => '/home', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => [ + 'description' => '超时时间，超时将终止命令进程。单位：秒'."\n" + ."\n" + .'默认值：60', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '执行命令的节点信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '第N个执行命令的节点实例ID。'."\n" + .'>用于限定执行范围，不指定则默认在集群所有节点上执行。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1in9hmw3ur52x0****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CommandId' => [ + 'description' => '命令ID，可用于后续查询命令执行情况。', + 'type' => 'string', + 'example' => 'c-hz01v8vudql****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'InstanceIds' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceId' => [ + 'description' => '执行命令的实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '执行命令的实例ID列表。', + 'type' => 'string', + 'example' => '[ "i-uf68t1zu3jkhs8w****", "i-uf6abz34m2714bp****", "i-uf65bh2113hlqvyx****", "i-uf68t1zu3jkhs8wx****", "i-uf6b0mtpx166fxxi****", "i-uf6faknz4dy1bit7****" ]', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '执行交互执行命令', + 'summary' => '调用InvokeShellCommand在指定的集群节点内执行交互命令。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'CommandId', + 'in' => 'query', + 'schema' => [ + 'description' => '命令ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c-hz01v8vudql****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'起始值：1。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的行数。 '."\n" + .'取值范围：1~50。 '."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Commands' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Command' => [ + 'description' => '命令列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timeout' => [ + 'description' => '超时时间。单位为秒。', + 'type' => 'string', + 'example' => '60', + ], + 'CommandId' => [ + 'description' => '命令ID。', + 'type' => 'string', + 'example' => 'c-hz01v8vudql****', + ], + 'WorkingDir' => [ + 'description' => '命令工作目录。', + 'type' => 'string', + 'example' => '/home', + ], + 'CommandContent' => [ + 'description' => '命令内容。', + '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' => '查看交互执行命令列表', + 'summary' => '调用ListCommands查看指定集群内的交互命令列表。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'CommandId', + 'in' => 'query', + 'schema' => [ + 'description' => '命令ID。'."\n" + ."\n" + .'您可以通过调用[ListCommands](~~87388~~)获取命令ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c-hz01v8x80o3****', + ], + ], + [ + 'name' => 'InvokeRecordStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的命令的运行状态。取值范围：'."\n" + .'- Finished：已结束'."\n" + .'- Running：运行中'."\n" + .'- Failed：运行失败'."\n" + .'- Stopped：已停止', + 'type' => 'string', + 'required' => false, + 'example' => 'Finished', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'起始值：1'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的行数。取值范围：1~50'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Instance', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '执行命令的目标节点信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '第N个执行命令的目标节点实例ID。'."\n" + .'>用于限定执行范围，不指定则默认在集群所有节点上执行。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf65bh2113hlqvyr****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 10000, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '每页显示的行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => '显示的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'InvocationResults' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InvocationResult' => [ + 'description' => '执行结果信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '输出结果。', + 'type' => 'string', + 'example' => 'hello world', + ], + 'FinishedTime' => [ + 'description' => '完成时间。', + 'type' => 'string', + 'example' => '2021-09-06T09:14:56Z', + ], + 'CommandId' => [ + 'description' => '命令ID。', + 'type' => 'string', + 'example' => 'c-hz01v8x80o3****', + ], + 'InstanceId' => [ + 'description' => '执行命令的节点实例ID。', + 'type' => 'string', + 'example' => 'i-uf65bh2113hlqvyr****', + ], + 'InvokeRecordStatus' => [ + 'description' => '查询的命令的运行状态。可能值：'."\n" + .'- Finished：已结束'."\n" + .'- Running：运行中'."\n" + .'- Failed：运行失败'."\n" + .'- Stopped：已停止', + 'type' => 'string', + 'example' => 'Finished', + ], + 'ExitCode' => [ + 'description' => 'Shell命令退出码。', + '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' => '查看交互执行命令执行结果', + 'summary' => '调用ListInvocationResults查看指定集群内交互命令的运行结果。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'CommandId', + 'in' => 'query', + 'schema' => [ + 'description' => '命令ID。'."\n" + ."\n" + .'您可以通过调用[ListCommands](~~87388~~)获取命令ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c-hz01v8x80o3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'CommandId' => [ + 'description' => '命令ID。', + 'type' => 'string', + 'example' => 'c-hz01v8x80o3****', + ], + 'InvokeStatus' => [ + 'description' => '总体执行状态。可能值：'."\n" + .'- Finished：已结束'."\n" + .'- Running：运行中'."\n" + .'- Failed：运行失败'."\n" + .'- Stopped：已停止', + 'type' => 'string', + 'example' => 'Finished', + ], + 'InvokeInstances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InvokeInstance' => [ + 'description' => '执行状态列表，每个节点一条记录。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceInvokeStatus' => [ + 'description' => '节点运行状态。可能值：'."\n" + .'- Finished：已结束'."\n" + .'- Running：运行中'."\n" + .'- Failed：运行失败'."\n" + .'- Stopped：已停止', + 'type' => 'string', + 'example' => 'Finished', + ], + 'InstanceId' => [ + 'description' => '节点实例ID。', + 'type' => 'string', + 'example' => 'i-uf6abz34m2714bp4****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看交互执行命令状态', + 'summary' => '调用ListInvocationStatus查看执行的交互命令运行的状态。', + ], + 'SetPostScripts' => [ + 'summary' => '调用SetPostScripts设置集群后处理脚本。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所属的地域ID。您可以调用[ListRegions](~~188593~~)查看最新的阿里云地域列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-sh-EnjshUxn', + ], + ], + [ + 'name' => 'PostInstallScripts', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '后处理脚本。', + 'type' => 'array', + 'items' => [ + 'description' => '后处理脚本。最多可以配置16个。', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => '后处理脚本的执行参数。', + 'type' => 'string', + 'required' => false, + 'example' => '-h', + ], + 'Url' => [ + 'description' => '后处理脚本的下载地址。', + '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', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '设置集群后处理脚本', + ], + 'GetPostScripts' => [ + 'summary' => '调用GetPostScripts查询指定集群的后处理脚本。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所属的地域ID。'."\n" + ."\n" + .'您可以调用[ListRegions](~~188593~~)查看最新的阿里云地域列表。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-sh-EnjshUxn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'PostInstallScripts' => [ + 'description' => '后处理脚本。', + 'type' => 'array', + 'items' => [ + 'description' => '后处理脚本。最多可以配置16个。', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => '后处理脚本的执行参数。', + 'type' => 'string', + 'example' => '-h', + ], + 'Url' => [ + 'description' => '后处理脚本的下载地址。', + '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' => '查询指定集群的后处理脚本', + ], + 'GetVisualServiceStatus' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'inactive (dead) , ws service is not running.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + ], + ], + ], + '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' => '获取可视化服务状态', + 'summary' => '调用GetVisualServiceStatus查询指定集群中VNC远程可视化服务状态。', + ], + 'ModifyVisualServicePasswd' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'RunasUser', + 'in' => 'query', + 'schema' => [ + 'description' => '集群的用户名。当前仅支持root用户。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'root', + ], + ], + [ + 'name' => 'RunasUserPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'RunasUser用户当前的密码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2145****', + ], + ], + [ + 'name' => 'Passwd', + 'in' => 'query', + 'schema' => [ + 'description' => '修改后的VNC远程可视化服务的连接密码。长度为6个字符，必须同时包含英文字母和数字。'."\n" + .'>请务必使用HTTPS协议调用API以避免可能发生的密码泄露。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1254****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => '{"Msg": "" }', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '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' => '设置VNC服务远程连接密码', + 'summary' => '调用ModifyVisualServicePasswd设置指定集群的VNC远程可视化服务的连接密码。', + ], + 'StartVisualService' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'CidrIp', + 'in' => 'query', + 'schema' => [ + 'description' => '允许访问VNC服务的源地址范围，用于设置安全组。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '190.100.XX.XX', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '固定端口。固定为：12016', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '65535', + 'example' => '12016', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'Service started.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + ], + ], + ], + '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' => '启动VNC远程服务', + 'summary' => '调用StartVisualService启动指定集群的VNC远程可视化服务。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'CidrIp', + 'in' => 'query', + 'schema' => [ + 'description' => '允许访问VNC服务的源地址范围，用于设置安全组。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100.168.XX.XX', + ], + ], + [ + 'name' => 'Port', + 'in' => 'query', + 'schema' => [ + 'description' => '固定端口。取值：12016', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '65535', + 'example' => '12016', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'Service stopped', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + ], + ], + ], + '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' => '停止可视化服务', + 'summary' => '调用StopVisualService停止指定集群的VNC远程可视化服务。', + ], + 'SetAutoScaleConfig' => [ + 'summary' => '调用SetAutoScaleConfig设置指定集群的自动伸缩配置信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'EnableAutoGrow', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动扩容。取值范围：'."\n" + .'- true：开启自动扩容'."\n" + .'- false：不开启自动扩容'."\n" + ."\n" + .'默认值： false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'EnableAutoShrink', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启自动缩容。取值范围：'."\n" + .'- true：开启自动缩容'."\n" + .'- false：不开启自动缩容'."\n" + ."\n" + .'默认值： false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'GrowIntervalInMinutes', + 'in' => 'query', + 'schema' => [ + 'description' => '每轮计算节点扩容的时间间隔。单位：分钟'."\n" + ."\n" + .'取值范围：2~10'."\n" + ."\n" + .'默认值：2'."\n" + ."\n" + .'>一次扩容任务可能会分几次完成，或者连续触发扩容时的时间间隔。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '2', + ], + ], + [ + 'name' => 'ShrinkIntervalInMinutes', + 'in' => 'query', + 'schema' => [ + 'description' => '每轮计算节点收缩的时间间隔。单位：分钟'."\n" + ."\n" + .'取值范围：2~10'."\n" + ."\n" + .'默认值：2', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '2', + ], + ], + [ + 'name' => 'ShrinkIdleTimes', + 'in' => 'query', + 'schema' => [ + 'description' => '节点连续空闲（未运行作业）次数。节点收缩检查时，一个节点连续处于空闲状态的次数。'."\n" + ."\n" + .'取值范围：2~5'."\n" + ."\n" + .'默认值：3'."\n" + ."\n" + .'如果设置为3，表示一个计算节点连续空闲超过3次，就会被释放。因为ShrinkIntervalInMinutes默认值是2分钟，所以默认配置下，一个计算节点连续空闲时间超过6分钟，就会被释放。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3', + 'default' => '3', + ], + ], + [ + 'name' => 'GrowTimeoutInMinutes', + 'in' => 'query', + 'schema' => [ + 'description' => '扩容超时时间。单位：分钟'."\n" + ."\n" + .'取值范围：10~60'."\n" + ."\n" + .'默认值：20'."\n" + ."\n" + .'如果扩容时间大于扩容超时时间，节点依然未达到运行状态，该节点将被释放。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'ExtraNodesGrowRatio', + 'in' => 'query', + 'schema' => [ + 'description' => '额外节点百分比。取值范围：0~100'."\n" + ."\n" + .'默认值：0'."\n" + ."\n" + .'如果作业负载需要新增100个计算节点，ExtraNodesGrowRatio值为2，那么最终新增数量为102。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + [ + 'name' => 'GrowRatio', + 'in' => 'query', + 'schema' => [ + 'description' => '扩容比例。取值范围：1~100'."\n" + ."\n" + .'默认值：100'."\n" + ."\n" + .'如果作业负载需要新增10个计算节点，GrowRatio配置为50，那么会进行多轮扩容，每轮扩容当前所需的50%节点。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '50', + 'default' => '100', + ], + ], + [ + 'name' => 'MaxNodesInCluster', + 'in' => 'query', + 'schema' => [ + 'description' => '集群最多可以扩容的计算节点数量。取值范围：0~500'."\n" + ."\n" + .'默认值：100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'ExcludeNodes', + 'in' => 'query', + 'schema' => [ + 'description' => '例外节点列表，不参与自动伸缩的节点列表。节点之间用半角逗号（,）隔开。'."\n" + ."\n" + .'如果您希望一直保留某个节点，可以设置为例外节点，空闲时不被释放。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****', + ], + ], + [ + 'name' => 'SpotStrategy', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点抢占策略。取值范围：'."\n" + .'- NoSpot：正常按量付费节点。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式节点。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式节点。'."\n" + ."\n" + .'默认值：NoSpot', + 'type' => 'string', + 'required' => false, + 'example' => 'SpotWithPriceLimit', + ], + ], + [ + 'name' => 'SpotPriceLimit', + 'in' => 'query', + 'schema' => [ + 'description' => '设置节点的每小时最高价格，最多支持3位小数。参数`SpotStrategy`取值为`SpotWithPriceLimit`时生效。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.062', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像ID。'."\n" + ."\n" + .'> - 如果同时设置了`Queues.N.QueueImageId`和`ImageId`时，默认使用`Queues.N.QueueImageId`。'."\n" + .'- 如果设置了`Queues.N.QueueImageId`或`ImageId`，以设置的参数为准。'."\n" + .'- 如果`Queues.N.QueueImageId`和`ImageId`都为空，则默认使用集群上次扩容的镜像，若之前没有进行过扩容，则默认使用创建集群时的镜像。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_03_64_20G_alibase_201708****', + ], + ], + [ + 'name' => 'Queues', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '队列信息。', + 'type' => 'array', + 'items' => [ + 'description' => '队列信息数组。', + 'type' => 'object', + 'properties' => [ + 'QueueImageId' => [ + 'description' => ' 扩容队列的镜像ID。N的取值范围：1~8'."\n" + ."\n" + .'> - 如果同时设置了`Queues.N.QueueImageId`和`ImageId`时，默认使用`Queues.N.QueueImageId`。'."\n" + .'- 如果设置了`Queues.N.QueueImageId`或`ImageId`，以设置的参数为准。'."\n" + .'- 如果`Queues.N.QueueImageId`和`ImageId`都为空，则默认使用集群上次扩容的镜像，若之前没有进行过扩容，则默认使用创建集群时的镜像。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'centos_7_03_64_20G_alibase_201708****', + ], + 'SystemDiskCategory' => [ + 'description' => '队列中扩容的计算节点系统盘类型。取值范围：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘'."\n" + .'- cloud_ssd：SSD云盘'."\n" + .'- cloud_essd：ESSD云盘'."\n" + .'- cloud：普通云盘，已售罄'."\n" + ."\n" + .'N的取值范围：1~8'."\n" + ."\n" + .'默认值：cloud_efficiency', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_efficiency', + ], + 'InstanceType' => [ + 'description' => '队列中自动扩容的节点规格。N的取值范围：1~8', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.medium', + ], + 'HostNameSuffix' => [ + 'description' => ' 队列中扩容的主机名后缀。方便您管理具有指定后缀的节点。'."\n" + ."\n" + .'N的取值范围：1~8', + 'type' => 'string', + 'required' => false, + 'example' => '000', + ], + 'SpotStrategy' => [ + 'description' => '队列中自动扩容的计算节点的抢占策略。N的取值范围：1~8'."\n" + ."\n" + .'抢占策略取值范围为：'."\n" + .'- NoSpot：正常按量付费节点。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式节点。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式节点。'."\n" + ."\n" + .'默认值：NoSpot', + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + 'HostNamePrefix' => [ + 'description' => ' 队列中扩容的主机名前缀。方便您管理具有指定前缀的节点。'."\n" + ."\n" + .'N的取值范围：1~8', + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + 'MinNodesInQueue' => [ + 'description' => ' 队列允许收缩的最小节点数。取值范围：0~50'."\n" + ."\n" + .'N的取值范围：1~8'."\n" + ."\n" + .'默认值：0', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'SystemDiskSize' => [ + 'description' => '队列中扩容的节点系统盘大小。单位：GB'."\n" + ."\n" + .'取值范围：40~500'."\n" + ."\n" + .'N的取值范围：1~8'."\n" + ."\n" + .'默认值：40', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + 'MaxNodesInQueue' => [ + 'description' => '队列允许扩容的最大节点数。取值范围：0~500'."\n" + ."\n" + .'N的取值范围：1~8'."\n" + ."\n" + .'默认值：100', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'EnableAutoShrink' => [ + 'description' => '队列是否允许自动缩容。取值范围：'."\n" + .'- true：允许自动缩容'."\n" + .'- false：不允许自动缩容'."\n" + ."\n" + .'N的取值范围：1~8'."\n" + ."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'QueueName' => [ + 'description' => '队列名称。支持同时设置N个队列的名称，N的取值范围：1~8', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster1', + ], + 'EnableAutoGrow' => [ + 'description' => ' 队列是否允许自动扩容。取值范围：'."\n" + .'- true：允许自动扩容'."\n" + .'- false：不允许自动扩容'."\n" + ."\n" + .'N的取值范围：1~8'."\n" + ."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'SystemDiskLevel' => [ + 'description' => '队列中扩容的计算节点系统盘性能等级。取值范围：'."\n" + ."\n" + .'- PL0：单盘最高随机读写IOPS 1万'."\n" + .'- PL1：单盘最高随机读写IOPS 5万'."\n" + .'- PL2：单盘最高随机读写IOPS 10万'."\n" + .'- PL3：单盘最高随机读写IOPS 100万'."\n" + ."\n" + .'N的取值范围：1~8'."\n" + ."\n" + .'默认值：PL1', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'SpotPriceLimit' => [ + 'description' => '队列中自动扩容的计算节点的每小时最高价格，支持最多3位小数。参数`Queues.N.SpotStrategy`取值为`SpotWithPriceLimit`时生效。'."\n" + ."\n" + .'N的取值范围：1~8', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.662', + ], + 'InstanceTypes' => [ + 'description' => '队列中节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息数组。', + 'type' => 'object', + 'properties' => [ + 'VSwitchId' => [ + 'description' => '队列中自动扩容的节点绑定的交换机ID。'."\n" + ."\n" + .'支持同时设置N个队列的名称，N的取值范围：1~8'."\n" + ."\n" + .'队列自动扩容时支持同时为队列中N个节点设置交换机ID，N的取值范围：0~500', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + 'ZoneId' => [ + 'description' => '队列中自动扩容的节点所在可用区ID。'."\n" + ."\n" + .'支持同时设置N个队列的名称，N的取值范围：1~8'."\n" + ."\n" + .'队列自动扩容时支持同时为队列中N个节点设置可用区ID，N的取值范围：0~500', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + 'SpotPriceLimit' => [ + 'description' => '队列中自动扩容的节点每小时最高价格，支持最多3位小数。参数`Queues.N.InstanceTypes.N.SpotStrategy`取值为`SpotWithPriceLimit`时生效。'."\n" + ."\n" + .'支持同时设置N个队列的名称，N的取值范围：1~8'."\n" + ."\n" + .'队列自动扩容时支持同时为队列中N个节点设置每小时最高价格，N的取值范围：0~500', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '0.660', + ], + 'InstanceType' => [ + 'description' => '队列中自动扩容的节点规格。'."\n" + ."\n" + .'支持同时设置N个队列的名称，N的取值范围：1~8'."\n" + ."\n" + .'队列自动扩容时支持同时为队列中N个节点设置规格参数，N的取值范围：0~500', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n1.tiny', + ], + 'SpotStrategy' => [ + 'description' => '队列中自动扩容的计算节点竞价策略。取值范围：'."\n" + .'- NoSpot：正常按量付费节点。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式节点。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式节点。'."\n" + ."\n" + .'默认值：NoSpot'."\n" + ."\n" + .'支持同时设置N个队列的名称，N的取值范围：1~8'."\n" + ."\n" + .'队列自动扩容时支持同时为队列中N个节点设置计算节点竞价策略，N的取值范围：0~500', + 'type' => 'string', + 'required' => false, + 'example' => 'SpotWithPriceLimit', + ], + 'SpotDuration' => [ + 'title' => '抢占式实例的保留时长，单位为小时。取值范围：0~6。'."\n" + .'- 保留时长2~6正在邀测中，如需开通请提交工单。'."\n" + .'- 取值为0，则为无保护期模式。'."\n" + .'默认值：1。', + 'description' => '抢占式实例的保护期，单位为小时。取值为0~1，设置为0则表示无保护期，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'SpotInterruptionBehavior' => [ + 'title' => '抢占实例中断模式。目前仅支持Terminate（默认）直接释放实例。', + 'description' => '抢占实例中断模式。目前仅支持Terminate（默认）直接释放实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'Terminate', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + 'DataDisks' => [ + 'description' => '随节点创建的数据盘信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '随节点创建的数据盘信息列表。', + 'type' => 'object', + 'properties' => [ + 'DataDiskSize' => [ + 'description' => '第N个随节点创建的数据盘容量大小。单位：GB'."\n" + ."\n" + .'取值范围：40~500'."\n" + ."\n" + .'默认值：40'."\n" + ."\n" + .'N的取值范围：0~16', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + 'DataDiskCategory' => [ + 'description' => '第N个随节点创建的数据盘类型。取值范围：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘'."\n" + ."\n" + .'- cloud_ssd：SSD云盘'."\n" + ."\n" + .'- cloud_essd：ESSD云盘'."\n" + ."\n" + .'- cloud：普通云盘'."\n" + ."\n" + .'默认值：cloud_efficiency'."\n" + ."\n" + .'N的取值范围：0~16', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_efficiency', + ], + 'DataDiskDeleteWithInstance' => [ + 'description' => '第N个随节点创建的数据盘是否随实例释放。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'默认值：true'."\n" + ."\n" + .'N的取值范围：0~16', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'DataDiskPerformanceLevel' => [ + 'description' => '第N个随节点创建的数据盘类型为ESSD云盘时，区分性能等级。仅当Queues.N.DataDisks.N.DataDiskCategory=cloud_essd时该参数有效。取值范围：'."\n" + .'- PL0：单盘最高随机读写IOPS 1万'."\n" + .'- PL1：单盘最高随机读写IOPS 5万'."\n" + .'- PL2：单盘最高随机读写IOPS 10万'."\n" + .'- PL3：单盘最高随机读写IOPS 100万'."\n" + ."\n" + .'默认值：PL1'."\n" + ."\n" + .'N的取值范围：0~16', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'DataDiskEncrypted' => [ + 'description' => '第N个随节点创建的数据盘是否加密。取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'默认值：false'."\n" + ."\n" + .'N的取值范围：0~16', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'DataDiskKMSKeyId' => [ + 'description' => '第N个随节点创建的数据盘使用的KMS密钥ID。'."\n" + ."\n" + .'N的取值范围：0~16', + 'type' => 'string', + 'required' => false, + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40826X', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 16, + ], + 'MaxNodesPerCycle' => [ + 'description' => '自动伸缩每轮扩容的最大计算节点数。取值范围：0~99。'."\n" + ."\n" + .'默认值：0。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'MinNodesPerCycle' => [ + 'description' => '自动伸缩每轮扩容的最小计算节点数。取值范围：1~99。'."\n" + ."\n" + .'默认值：1。'."\n" + ."\n" + .'如果某一轮次需扩容节点数量小于所设置的最小计算节点数，自动伸缩为保证资源的正常交付，会将该轮次的最小计算节点数自动调整为当前轮次需要扩容节点数量。'."\n" + ."\n" + .'>该调整仅对当前轮次的最小计算节点数生效。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'AutoMinNodesPerCycle' => [ + 'description' => '自动设置单轮扩容的最小节点数量。'."\n" + .'如果设置为true，则每次扩容的最小节点数等于作业所需的节点数量，上限是99台。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'SortedByInventory' => [ + 'description' => '实例是否支持乱序排列，取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'> 如果设置为true，自动伸缩会按照实例库存数量从多到少的顺序选择实例规格，尽力交付实例资源。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 8, + ], + ], + [ + 'name' => 'ComputeEnableHt', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点对应的ECS实例是否开启超线程。'."\n" + ."\n" + .'> 该配置仅对部分支持开关超线程的实例规格生效。对于不支持的实例，默认开启超线程。具体请参见[自定义CPU选项](~~145895~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DnsConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'DNS配置信息。', + 'type' => 'string', + 'required' => false, + 'example' => '"{\\"DnsType\\":\\"PrivateZone\\",\\"DnsName\\":\\"xxxxx\\"}"', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '设置自动伸缩配置信息', + 'description' => '## 接口说明'."\n" + ."\n" + .'当队列配置和全局配置中配置不一致时，以队列设置为优先。'."\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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MaxNodesInCluster' => [ + 'description' => '集群最大计算节点数，集群最多可以扩展的节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'GrowTimeoutInMinutes' => [ + 'description' => '扩容超时时间，等待启动节点的超时时间。可能值：10~60', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SpotStrategy' => [ + 'description' => '计算节点竞价策略。可能值：'."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73', + ], + 'EnableAutoShrink' => [ + 'description' => '是否开启自动缩容。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ClusterType' => [ + 'description' => '集群的调度器类型。可能值：'."\n" + .'- pbs'."\n" + .'- slurm'."\n" + .'- opengridscheduler'."\n" + .'- deadline', + 'type' => 'string', + 'example' => 'slurm', + ], + 'EnableAutoGrow' => [ + 'description' => '是否开启自动扩容。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExcludeNodes' => [ + 'description' => '不使用自动伸缩的节点列表。', + 'type' => 'string', + 'example' => 'i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****', + ], + 'GrowIntervalInMinutes' => [ + 'description' => '扩容时间间隔，每轮计算节点扩容的时间间隔。可能值：2~10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ShrinkIntervalInMinutes' => [ + 'description' => '缩容时间间隔，每轮计算节点收缩的时间间隔。可能值：2~10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SpotPriceLimit' => [ + 'description' => '实例的每小时最高价格。支持最多3位小数，参数SpotStrategy取值为SpotWithPriceLimit时生效。', + 'type' => 'string', + 'example' => '0.062', + ], + 'ShrinkIdleTimes' => [ + 'description' => '节点连续空闲次数，资源收缩检查时，一个节点连续处于空闲的次数。可能值：2~5', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ExtraNodesGrowRatio' => [ + 'description' => '额外节点百分比。可能值：0~100', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'GrowRatio' => [ + 'description' => '扩容比例。可能值：1~100', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Uid' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => 'testu****', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + ], + ], + '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' => '查询自动伸缩配置信息', + 'summary' => '调用DescribeAutoScaleConfig查询指定集群的自动伸缩配置信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetAutoScaleConfig' => [ + 'summary' => '调用GetAutoScaleConfig获取指定集群的自动伸缩配置信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'MaxNodesInCluster' => [ + 'description' => '集群最多可以扩容的节点数量。可能值：0~500', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '300', + ], + 'GrowTimeoutInMinutes' => [ + 'description' => '扩容超时时间，等待启动节点的超时时间。单位：分钟，可能值：10~60'."\n" + ."\n" + .'如果扩容时间大于扩容超时时间，节点依然未达到运行状态，系统将此节点释放。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'SpotStrategy' => [ + 'description' => '计算节点抢占策略。可能值：'."\n" + .'- NoSpot：正常按量付费节点。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式节点。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式节点。', + 'type' => 'string', + 'example' => 'SpotWithPriceLimit', + ], + 'EnableAutoShrink' => [ + 'description' => '集群是否启动自动缩容。可能值：'."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'EnableAutoGrow' => [ + 'description' => '集群是否启动自动扩容。可能值：'."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ClusterType' => [ + 'description' => '集群的调度器类型。可能值：'."\n" + .'- slurm'."\n" + .'- pbs'."\n" + .'- opengridscheduler'."\n" + .'- deadline', + 'type' => 'string', + 'example' => 'pbs', + ], + 'ExcludeNodes' => [ + 'description' => '不参与自动伸缩的节点列表，多个节点之间用半角逗号（,）隔开。', + 'type' => 'string', + 'example' => 'i-bp19lgqwxb4206t5****,i-bp1g4hvzs9pywrhb****', + ], + 'ShrinkIntervalInMinutes' => [ + 'description' => '缩容时间间隔，每轮计算节点收缩的时间间隔。单位：分钟，可能值：2~10', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'GrowIntervalInMinutes' => [ + 'description' => '扩容时间间隔，每轮计算节点扩容的时间间隔。单位：分钟，可能值：2~10'."\n" + ."\n" + .'>一次扩容任务可能会分几次完成，或者连续触发扩容时的时间间隔。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SpotPriceLimit' => [ + 'description' => '计算节点每小时最高价格，最多支持3位小数。参数SpotStrategy取值为SpotWithPriceLimit时生效。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.062', + ], + 'ExtraNodesGrowRatio' => [ + 'description' => '额外节点百分比。可能值：0~100'."\n" + ."\n" + .'如果作业负载需要新增100个计算节点，ExtraNodesGrowRatio值为2，那么最终新增数量为102。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ShrinkIdleTimes' => [ + 'description' => '节点连续空闲（未运行作业）次数。节点收缩检查时，一个节点连续处于空闲状态的次数。可能值：2~5'."\n" + ."\n" + .'如果该参数值为3，表示一个计算节点连续空闲超过3次，就会被释放。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'ImageId' => [ + 'description' => '队列中计算节点镜像ID。', + 'type' => 'string', + 'example' => 'm-bp10txryr4mhrrt1****', + ], + 'GrowRatio' => [ + 'description' => '扩容比例。可能值：1~100'."\n" + ."\n" + .'如果作业负载需要新增10个计算节点，GrowRatio配置为50，那么会进行多轮扩容，每轮扩容当前所需的50%。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'Uid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '129845258050****', + ], + 'Queues' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'QueueInfo' => [ + 'description' => '集群队列的自动伸缩配置信息。'."\n" + .'>集群和队列同时开启了扩容或缩容时，则以队列设置为优先。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'QueueImageId' => [ + 'description' => '队列中计算节点镜像ID。', + 'type' => 'string', + 'example' => 'centos_7_06_64_20G_alibase_2019071****', + ], + 'SystemDiskCategory' => [ + 'description' => '系统盘类型。可能值：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘'."\n" + .'- cloud_ssd：SSD云盘'."\n" + .'- cloud_essd：ESSD云盘'."\n" + .'- cloud：普通云盘', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'InstanceType' => [ + 'description' => '该队列自动扩容的节点规格。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ecs.sn1ne.large', + ], + 'HostNameSuffix' => [ + 'description' => '队列名后缀。方便您查询具有指定后缀的队列。', + 'type' => 'string', + 'example' => '000', + ], + 'SpotStrategy' => [ + 'description' => '计算节点的抢占策略。可能值：'."\n" + .'- NoSpot：正常按量付费节点。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式节点。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式节点。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'MinNodesInQueue' => [ + 'description' => '单个队列最小计算节点数，队列最少可以保留的计算节点数量。可能值：0~50', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'HostNamePrefix' => [ + 'description' => '队列名前缀。方便您查询具有指定前缀的队列。', + 'type' => 'string', + 'example' => 'compute', + ], + 'SystemDiskSize' => [ + 'description' => '系统盘大小。单位：GB，可能值：40~500', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'MaxNodesInQueue' => [ + 'description' => '单个队列最多可以扩容的节点数量。可能值：0~500', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'EnableAutoShrink' => [ + 'description' => '队列是否启动自动缩容。可能值：'."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'QueueName' => [ + 'description' => '队列名称。', + 'type' => 'string', + 'example' => 'workq', + ], + 'EnableAutoGrow' => [ + 'description' => '队列是否启动自动扩容。可能值：'."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SystemDiskLevel' => [ + 'description' => '系统盘性能等级。可能值：'."\n" + ."\n" + .'- PL0：单盘最高随机读写IOPS 1万'."\n" + ."\n" + .'- PL1：单盘最高随机读写IOPS 5万'."\n" + ."\n" + .'- PL2：单盘最高随机读写IOPS10万'."\n" + ."\n" + .'- PL3：单盘最高随机读写IOPS 100万', + 'type' => 'string', + 'example' => 'PL1', + ], + 'ResourceGroupId' => [ + 'description' => '计算节点所属的资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxp7uc24****', + ], + 'SpotPriceLimit' => [ + 'description' => '计算节点每小时最高价格，支持最大3位小数。参数SpotStrategy取值为SpotWithPriceLimit时生效。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.062', + ], + 'InstanceTypes' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'InstanceTypeInfo' => [ + 'description' => '计算节点规格信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'HostNamePrefix' => [ + 'description' => '主机名前缀。方便您查询具有指定前缀的节点。', + 'type' => 'string', + 'example' => 'compute', + ], + 'VSwitchId' => [ + 'description' => '计算节点所属的交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + 'ZoneId' => [ + 'description' => '计算节点所属的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'SpotPriceLimit' => [ + 'description' => '计算节点每小时最高价格，支持最多3位小数。参数SpotStrategy取值为SpotWithPriceLimit时生效。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.062', + ], + 'InstanceType' => [ + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'ecs.sn1ne.large', + ], + 'SpotStrategy' => [ + 'description' => '计算节点竞价策略。可能值：'."\n" + .'- NoSpot：正常按量付费节点。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式节点。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格的抢占式节点。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'SpotDuration' => [ + 'description' => '抢占式实例的保护期，单位为小时。取值为0~1，默认为1，设置为0表示无保护期。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SpotInterruptionBehavior' => [ + 'title' => '抢占实例中断模式。目前仅支持Terminate（默认）直接释放实例。'."\n", + 'description' => '抢占实例中断模式。目前仅支持Terminate（默认）直接释放实例。'."\n", + 'type' => 'string', + 'example' => 'Terminate', + ], + ], + ], + ], + ], + ], + 'DataDisks' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'DataDisksInfo' => [ + 'description' => '节点上挂载的数据盘信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DataDiskCategory' => [ + 'description' => '第N个该节点挂载的数据盘类型。可能值：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘'."\n" + ."\n" + .'- cloud_ssd：SSD云盘'."\n" + ."\n" + .'- cloud_essd：ESSD云盘'."\n" + ."\n" + .'- cloud：普通云盘', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'DataDiskSize' => [ + 'description' => '第N个该节点挂载的数据盘容量大小。单位：GB'."\n" + ."\n" + .'可能值：40~500', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'DataDiskDeleteWithInstance' => [ + 'description' => '第N个该节点挂载的数据盘是否随实例释放。可能值：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DataDiskPerformanceLevel' => [ + 'description' => '第N个该节点的数据盘类型为ESSD云盘时，区分性能等级。仅当DataDisks.N.DataDiskCategory=cloud_essd时返回该参数。可能值：'."\n" + .'- PL0：单盘最高随机读写IOPS 1万'."\n" + .'- PL1：单盘最高随机读写IOPS 5万'."\n" + .'- PL2：单盘最高随机读写IOPS 10万'."\n" + .'- PL3：单盘最高随机读写IOPS 100万', + 'type' => 'string', + 'example' => 'PL1', + ], + 'DataDiskEncrypted' => [ + 'description' => '第N个该节点的数据盘是否加密。可能值：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否', + 'type' => 'boolean', + 'example' => 'false', + ], + 'DataDiskKMSKeyId' => [ + 'description' => '第N个该节点的数据盘使用的KMS密钥ID。', + 'type' => 'string', + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40826X', + ], + ], + ], + ], + ], + ], + 'MaxNodesPerCycle' => [ + 'description' => '自动伸缩每轮扩容的最大计算节点数。取值范围：0~99。'."\n" + ."\n" + .'默认值：0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'MinNodesPerCycle' => [ + 'description' => '自动伸缩每轮扩容的最小计算节点数。取值范围：1~99。'."\n" + ."\n" + .'默认值：1。'."\n" + ."\n" + .'如果某一轮次需扩容节点数量小于所设置的最小计算节点数，自动伸缩为保证资源的正常交付，会将该轮次的最小计算节点数自动调整为当前轮次需要扩容节点数量。'."\n" + ."\n" + .'>该调整仅对当前轮次的最小计算节点数生效。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'AutoMinNodesPerCycle' => [ + 'description' => '自动设置单轮扩容的最小节点数量。'."\n" + .'如果设置为true，则每次扩容的最小节点数等于作业所需的节点数量，上限是99台。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SortedByInventory' => [ + 'description' => '实例是否支持乱序排列，取值范围：'."\n" + ."\n" + .'- true：是'."\n" + ."\n" + .'- false：否'."\n" + ."\n" + .'> 如果设置为true，自动伸缩会按照实例库存数量从多到少的顺序选择实例规格，尽力交付实例资源。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + 'ComputeEnableHt' => [ + 'description' => '计算节点对应的ECS实例是否开启超线程。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DnsConfig' => [ + 'description' => 'DNS配置信息。', + 'type' => 'string', + 'example' => '"{\\"DnsType\\":\\"PrivateZone\\",\\"DnsName\\":\\"xxxxx\\"}"', + ], + ], + ], + ], + ], + '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' => '获取自动伸缩配置信息', + '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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'HostName', + 'in' => 'query', + 'schema' => [ + 'description' => '主机名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'compute0', + ], + ], + [ + 'name' => 'ProcessId', + 'in' => 'query', + 'schema' => [ + 'description' => '剖析进程ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '29075', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '剖析时长。单位：秒'."\n" + ."\n" + .'取值范围：10~300'."\n" + ."\n" + .'默认值：30', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '300', + 'default' => '300', + ], + ], + [ + 'name' => 'Freq', + 'in' => 'query', + 'schema' => [ + 'description' => '采样频率。单位：Hz'."\n" + .'取值范围：1~2000'."\n" + ."\n" + .'默认值：2000', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2000', + 'default' => '2000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8442AF35-875B-4FC0-8B7AAFDC339335D5', + ], + ], + ], + ], + ], + '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' => '启动集群的性能剖析', + 'summary' => '调用RunCloudMetricProfiling启动指定集群的性能剖析。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'ProfilingId', + 'in' => 'query', + 'schema' => [ + 'description' => '性能剖析ID。您可以通过调用[ListCloudMetricProfilings](~~188711~~)接口获取性能剖析ID。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '0DD6F715-85EE-4EA6-BDC4-48A75B719068', + ], + 'SvgUrls' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SvgInfo' => [ + 'description' => '性能剖析结果列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'SVG文件类型。', + 'type' => 'string', + 'example' => 'file', + ], + 'Url' => [ + 'description' => 'SVG文件存储在OSS的URL。', + 'type' => 'string', + 'example' => 'https://cloudmetrics-****-hz.oss-cn-hangzhou.aliyuncs.com/112****/ehpc-hz-faRavb****njuik%Oxlftyhujmi0Y****', + ], + 'Name' => [ + 'description' => 'SVG文件名称。', + 'type' => 'string', + 'example' => 'ehpc-hz-faRavbPf6b_i-bdrftgyh890654****_21687_2019-09-09-02-37-40.bottomup.svg', + ], + 'Size' => [ + 'description' => 'SVG文件大小。单位为字节（Byte）。', + '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' => '获取集群任务性能剖析结果', + 'summary' => '调用GetCloudMetricProfiling获取集群任务性能剖析结果。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'default' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'起始值：1'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。取值范围：1~50'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9A05F620-ED46-4A57-95F1-C67D6D3C5DD2', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Profilings' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ProfilingInfo' => [ + 'description' => '历史性能剖析信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProfilingId' => [ + 'description' => '剖析ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-i-bplukzqgl****_21687_2019-09-09-02-37-40', + ], + 'TriggerTime' => [ + 'description' => '触发时间。', + 'type' => 'string', + 'example' => '2019-09-09 02:37:40', + ], + 'Pid' => [ + 'description' => '进程ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '21687', + ], + 'HostName' => [ + 'description' => '实例机器名称。', + 'type' => 'string', + 'example' => 'compute5', + ], + 'Duration' => [ + 'description' => '采集时长。单位：秒'."\n" + ."\n" + .'可能值：10~300', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-bp1j76z8dlukzqgl0****', + ], + 'Freq' => [ + 'description' => '采集频率。单位：Hz'."\n" + ."\n" + .'可能值：1~2000', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群的历史性能剖析信息', + 'summary' => '调用ListCloudMetricProfilings查询指定集群的历史性能剖析信息。', + ], + 'GetCloudMetricLogs' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间点。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1583907780', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间点。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1583907790', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => '按时间逆序返回日志。'."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AggregationType', + 'in' => 'query', + 'schema' => [ + 'description' => "\n" + .'数据聚合类别。取值范围：'."\n" + .'- sum：统计和。'."\n" + .'- avg：平均值。'."\n" + .'- max：最大值。'."\n" + .'- min：最小值。'."\n" + ."\n" + .'默认不使用聚合。', + 'type' => 'string', + 'required' => false, + 'example' => 'avg', + ], + ], + [ + 'name' => 'AggregationInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '数据聚合间隔。单位：秒。'."\n" + ."\n" + .'取值范围：1、10、60、600、3600。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MetricScope', + 'in' => 'query', + 'schema' => [ + 'description' => '性能指标的维度。取值范围：'."\n" + .'- machine： 整机。'."\n" + .'- process：进程。'."\n" + .'- network：网络。'."\n" + .'- disk：磁盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'network', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'description' => '指定过滤条件。JSON格式字符串，包含若干key:value对。key的取值范围：'."\n" + .'- InstanceId：节点ID。'."\n" + .'- Hostname：节点主机名称。'."\n" + .'- NetworkInterface：网络接口名称。'."\n" + .'- DiskDevice：磁盘设备名称。', + 'type' => 'string', + 'required' => false, + 'example' => '{"Hostname":"compute000"}', + ], + ], + [ + 'name' => 'MetricCategories', + 'in' => 'query', + 'schema' => [ + 'description' => "\n" + .'输出性能指标的类别，多个指标用半角逗号（,）隔开。取值范围：'."\n" + .'- cpu：CPU。'."\n" + .'- memory：内存。'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cpu', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '015C2C4D-1884-4EB7-BCD3-C5BB8D7E56DB', + ], + 'MetricLogs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MetricLog' => [ + 'description' => '性能数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'description' => '日志时间戳。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1583907780', + ], + 'DiskDevice' => [ + 'description' => '磁盘设备名称。', + 'type' => 'string', + 'example' => 'vda1', + ], + 'NetworkInterface' => [ + 'description' => '网络接口名称。', + 'type' => 'string', + 'example' => 'eth1', + ], + 'MetricData' => [ + 'description' => 'JSON序列化字符串，包含多个类别性能指标数值。', + 'type' => 'string', + 'example' => '{\\"process|cpusage\\":0,\\"process|cpuser\\":0,\\"process|cpusys\\":0,******}', + ], + 'Hostname' => [ + 'description' => '节点主机名称。', + 'type' => 'string', + 'example' => 'compute000', + ], + 'InstanceId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'i-bp132g97g7zwnvta****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '读取性能指标日志', + 'summary' => '调用GetCloudMetricLogs读取EHPC性能指标（CloudMetrics）日志。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间点。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '1576922873', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间点。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '1577441873', + ], + ], + [ + 'name' => 'ReportType', + 'in' => 'query', + 'schema' => [ + 'description' => "\n" + .'查询类别。取值范围：'."\n" + .'- total_report：查询不同维度的核时数。'."\n" + .'- job_report：统计节点的历史节点数据。'."\n" + .'- number_report：查询不同维度的作业信息。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'job_report', + ], + ], + [ + 'name' => 'FilterValue', + 'in' => 'query', + 'schema' => [ + 'description' => '查询对应维度的实际名称。取值范围：'."\n" + .'- 当参数Dim取值为user时，FilterValue取值为指定的用户名称。'."\n" + .'- 当参数Dim取值为queue时，FilterValue取值为指定的队列名称。'."\n" + .'- 当参数Dim取值为instance时，FilterValue取值为实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'userNo1', + ], + ], + [ + 'name' => 'Dim', + 'in' => 'query', + 'schema' => [ + 'description' => "\n" + .'查询维度。取值范围：'."\n" + .'- user：按用户查询。'."\n" + .'- queue：按队列查询。'."\n" + .'- instance：按实例查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'user', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'required' => false, + 'example' => '[{Id: 1.scheduler}]', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'起始值：1'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。取值范围：1~50'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCoreTime' => [ + 'description' => '查询的集群总核数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '261300', + ], + 'Metrics' => [ + 'description' => 'JSON序列化的列表，包含Data中每条记录的列名称。', + 'type' => 'string', + 'example' => '[\\"user\\",\\"coreTime\\",\\"usedMem\\"]', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B1DCB399-9333-4B38-A35A-0BDFABC71881', + ], + 'PageSize' => [ + 'description' => '显示本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '显示当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '显示列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Data' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Data' => [ + 'description' => 'JSON序列化的列表，列表包含多条记录。', + 'type' => 'array', + 'items' => [ + 'description' => 'JSON序列化的列表，列表包含多条记录。', + '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' => '获取资源报表信息', + 'summary' => '调用GetAccountingReport获取指定集群的资源报表信息。', + '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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '显示的页码，起始值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。取值范围：1~100。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + 'default' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BBC2F93D-003A-49C4-850C-B826EECF6667', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'Logs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'LogInfo' => [ + 'description' => '操作日志简要信息数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Operation' => [ + 'description' => '操作类型。可能值：'."\n" + ."\n" + .'- CreateCluster'."\n" + .'- StartCluster'."\n" + .'- StopCluster'."\n" + .'- DeleteCluster'."\n" + .'- AddNodes'."\n" + .'- StartNodes'."\n" + .'- ResetNodes'."\n" + .'- StopNodes'."\n" + .'- DeleteNodes', + 'type' => 'string', + 'example' => 'CreateCluster', + ], + 'Message' => [ + 'description' => '日志内容。', + 'type' => 'string', + 'example' => 'Begin to create cluster', + ], + 'CreateTime' => [ + 'description' => '日志创建时间。', + 'type' => 'string', + 'example' => '2019-09-18T13:24:13.000', + ], + 'Level' => [ + 'description' => '日志级别。可能值：'."\n" + ."\n" + .'- warn'."\n" + .'- error'."\n" + .'- info', + 'type' => 'string', + 'example' => 'info', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群近期操作记录', + 'summary' => '调用ListClusterLogs查询集群三天内的操作记录。', + ], + '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' => 'ehpcutil最新版本号。', + 'type' => 'string', + 'example' => '1.1.1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + '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' => '查询ehpcutil最新版本号', + 'summary' => '调用ListCurrentClientVersion查询集群客户端（ehpcutil）的最新版本号。', + ], + 'UpgradeClient' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'ehpcutil将升级到的版本，默认升级到最新版本。您可以调用[ListCurrentClientVersion](~~87223~~)查询ehpcutil最新版本号。', + 'type' => 'string', + 'required' => false, + 'example' => '2.0.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4994fbcd-2a09-4045-b2b2-2c3bee8e9296', + ], + ], + ], + ], + ], + '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' => '升级ehpcutil到目标版本', + 'summary' => '调用UpgradeClient升级集群客户端（ehpcutil）到目标版本。', + 'extraInfo' => ' ', + ], + 'ListUpgradeClients' => [ + 'summary' => '调用ListUpgradeClients查询集群当前可升级的客户端（ehpcutil）最新版本和历史升级操作。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '89A1AC0F-4A6C-4F3D-98F9-BEF9A823****', + ], + 'LatestVersion' => [ + 'description' => '当前已发布的最新ehpcutil版本。', + 'type' => 'string', + 'example' => '1.2.22', + ], + 'ClientRecords' => [ + 'description' => '集群的ehpcutil升级操作记录。', + 'type' => 'array', + 'items' => [ + 'description' => '集群的ehpcutil升级操作记录。', + 'type' => 'object', + 'properties' => [ + 'SubUid' => [ + 'description' => '升级ehpcutil版本的用户ID。', + 'type' => 'string', + 'example' => '129******84', + ], + 'OldVersion' => [ + 'description' => '升级前的ehpcutil版本。', + 'type' => 'string', + 'example' => '1.2.16', + ], + 'NewVersion' => [ + 'description' => '升级后的ehpcutil版本。', + 'type' => 'string', + 'example' => '1.2.21', + ], + 'UpdateTime' => [ + 'description' => '操作时间。', + 'type' => 'string', + 'example' => '2022-08-26T06:26:57.000Z', + ], + ], + ], + ], + 'CurrentVersion' => [ + 'description' => '集群当前的ehpcutil版本。', + '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' => '查询集群当前可升级的ehpcutil最新版本和历史升级操作', + ], + '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' => '请求ID。', + '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' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ServicePack' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'ServicePackInfo' => [ + 'description' => 'E-HPC服务包列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'E-HPC服务包列表。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '服务包到期时间。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1612705988', + ], + 'Capacity' => [ + 'description' => '服务包规格。单位：核。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'StartTime' => [ + 'description' => '服务包购买时间。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + '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' => '查询服务包和按量付费信息', + 'summary' => '调用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' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '安全组ID。'."\n" + ."\n" + .'您可以调用[DescribeSecurityGroups](~~25556~~)查询可以使用的安全组。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sg-bp13n61xsydodfyg****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + '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' => '将集群加入到指定的安全组', + 'summary' => '调用AddSecurityGroup将集群加入到指定的安全组。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '集群加入的安全组总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6D9A3378-61CA-4415-BEB0-1168C2A15975', + ], + 'SecurityGroups' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SecurityGroup' => [ + 'description' => '安全组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => '["sg-bp13n61xsydodfyg****"]', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询集群加入的安全组列表', + 'summary' => '调用ListSecurityGroups查询指定集群加入的安全组列表。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'sg-bp13n61xsydodfyg****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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.', + ], + [ + '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' => '将集群移出指定的安全组', + 'summary' => '调用DeleteSecurityGroup将集群移出指定的安全组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => '调用TagResources为指定资源创建并绑定标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型。目前仅支持cluster，即E-HPC集群。', + 'type' => 'string', + 'required' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID，最多50个。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID，最多50个。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-xxxx', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '标签列表，最多20个。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表，最多20个。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键。一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值。一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '为指定资源创建并绑定标签', + ], + 'ListTagResources' => [ + 'summary' => '调用ListTagResources查询资源绑定的标签信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '下一个查询开始Token', + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0axxxx', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型定义。目前仅支持cluster，即E-HPC集群。', + 'type' => 'string', + 'required' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID，最多50个。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID，最多50个。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-xxxx', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '标签列表，最多20个。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表，最多20个。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => '下一个查询开始Token，NextToken为空说明没有下一个。', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0axxxx', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '484256DA-D816-44D2-9D86-B6EE4D5BA78C', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'title' => '资源列表', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型。目前仅支持cluster，即E-HPC集群。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'TagValue' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + 'ResourceId' => [ + 'title' => '资源ID', + 'description' => '资源ID，即集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-xxxx', + ], + 'TagKey' => [ + 'title' => '标签键', + 'description' => '标签键。', + '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' => '查询资源绑定的标签信息', + ], + 'UnTagResources' => [ + 'summary' => '调用UnTagResources为指定的资源解绑标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。目前仅支持cluster，即E-HPC集群。', + 'type' => 'string', + 'required' => true, + 'example' => 'cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID，最多50个。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID，最多50个。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-xxxx', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源的标签键，最多20个。', + 'type' => 'array', + 'items' => [ + 'description' => '资源的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否解绑资源上全部的标签。当请求中未设置TagKey.N时，该参数才有效。取值范围：'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '为指定资源解绑标签', + ], + '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' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'RegionInfo' => [ + 'description' => '地域信息组成的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地域信息组成的列表。', + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => '华东1（杭州）', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询可以使用E-HPC的地域列表', + 'summary' => '调用ListRegions查询可以使用E-HPC的地域列表。', + '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' => '待查询的集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '显示的页码，起始值为1，取值范围：1~999。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '999', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。取值范围：1~50。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '任务ID。您可以调用以下异步API获取对应的TaskId。'."\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~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + ], + [ + 'name' => 'Archived', + 'in' => 'query', + 'schema' => [ + 'description' => '是否显示已运行的异步API的历史返回结果。取值范围：'."\n" + ."\n" + .'- true：显示正在运行和历史运行的任务返回结果。'."\n" + ."\n" + .'- false：仅显示正在运行的任务返回结果，当没有正在运行的任务时，task返回为`[]`。'."\n" + ."\n" + .'默认值：false。'."\n" + ."\n" + .'>当您配置了TaskId参数时，此参数无效。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + 'enum' => [ + 'true', + 'false', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '89A1AC0F-4A6C-4F3D-98F9-BEF9A823****', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '任务列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Tasks' => [ + 'description' => '任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务信息列表。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '任务运行状态。可能值：'."\n" + ."\n" + .'- Processing：运行中'."\n" + .'- Success：运行成功'."\n" + .'- Fail：运行失败'."\n" + .'- PartialFail：部分运行失败', + 'type' => 'string', + 'example' => 'Processing', + ], + 'TaskType' => [ + 'description' => '任务类型。可能值：'."\n" + ."\n" + .'- CreateCluster：创建集群，对应的API为[CreateCluster](~~87100~~)'."\n" + .'- StartCluster：启动集群，对应的API为[StartCluster](~~200345~~)'."\n" + .'- StopCluster：停止集群，对应的API为[StopCluster](~~200346~~)'."\n" + .'- DeleteCluster：释放集群，对应的API为[DeleteCluster](~~87110~~)'."\n" + .'- AddComputes：添加节点到集群，对应的API为[AddNodes](~~87147~~)'."\n" + .'- StartComputes：启动节点，对应的API为[StartNodes](~~87159~~)'."\n" + .'- ResetComputes：重置节点，对应的API为[ResetNodes](~~87158~~)'."\n" + .'- StopComputes：停止节点，对应的API为[StopNodes](~~87160~~)'."\n" + .'- DeleteComputes：删除节点，对应的API为[DeleteNodes](~~87155~~)', + 'type' => 'string', + 'example' => 'StopCluster', + ], + 'TotalSteps' => [ + 'description' => '任务总操作步数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '35', + ], + 'CurrentStep' => [ + 'description' => '任务当前操作步数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'Result' => [ + 'description' => '任务运行结果。可能值：'."\n" + ."\n" + .'- 当TaskType为CreateCluster和AddComputes时，格式为`{\\"Instances\\":[]}`，表示加入到集群的节点信息。'."\n" + ."\n" + .'- 当TaskType为除CreateCluster和AddComputes的其他值时，格式为`{}`。'."\n" + ."\n", + 'type' => 'string', + 'example' => '{\\"Instances\\":[{\\"InstanceId\\":\\"i-bp1inb1j2xz8pnoi****\\",\\"Ip\\":\\"192.168.*.*\\",\\"Hostname\\":\\"login0\\",\\"role\\":\\"login\\"}]}', + ], + 'Errors' => [ + 'description' => '任务运行错误信息列表。'."\n" + ."\n" + .'<props="china">您可以在[错误中心](https://error-center.aliyun.com/status/product/EHPC)查看错误信息及对应的解决方案。</props>'."\n" + ."\n\n" + ."\n" + .'<props="intl">您可以在[错误中心](https://error-center.alibabacloud.com/status/product/EHPC)查看错误信息及对应的解决方案。</props>'."\n", + 'type' => 'string', + 'example' => '[]', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'Request' => [ + 'description' => '任务的请求参数信息，格式为JSON字符串。', + 'type' => 'string', + 'example' => '{\\"requestId\\":\\"0A6CA33E-BFBF-4F92-BDAE-4E8860DA****\\",\\"uid\\":\\"160998252992****\\",\\"bid\\":\\"268**\\",\\"clusterId\\":\\"ehpc-hz-ysQtcZ****\\"}', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + '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', + ], + ], + 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' => '获取任务列表', + 'summary' => '调用ListTasks查询指定集群下异步API的返回结果。', + 'description' => '对于一些异步API（如AddNodes），请求成功会立即返回结果，但不会等待节点创建成功。此时，您可以使用接口返回的TaskId查询具体的任务运行结果。', + ], + 'InitializeEHPC' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'autoTest' => false, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '创建服务关联角色的地域ID。'."\n" + ."\n" + .'您可以通过调用[ListRegions](~~188593~~)接口查询E-HPC支持的地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '要使用的服务名称，需要创建对应的服务关联角色。取值范围：'."\n" + ."\n" + .'- E-HPC：表示创建AliyunServiceRoleForEHPC。'."\n" + .'- E-HPC Instant：表示创建AliyunServiceRoleForEHPCManagedNetwork。'."\n" + ."\n" + .'> 该参数暂未开放使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'E-HPC', + 'enum' => [ + 'E-HPC', + 'E-HPC Instant', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + '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' => '创建EHPC关联角色', + 'summary' => '创建EHPC的服务关联角色（首次使用必须）。', + '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', + ], + ], +]; diff --git a/data/zh_cn/ehpc/2024-07-30/api-docs.php b/data/zh_cn/ehpc/2024-07-30/api-docs.php new file mode 100644 index 0000000..3dcd0e6 --- /dev/null +++ b/data/zh_cn/ehpc/2024-07-30/api-docs.php @@ -0,0 +1,10728 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'EHPC', + 'version' => '2024-07-30', + ], + 'directories' => [ + [ + 'id' => 196224, + 'title' => '集群', + 'type' => 'directory', + 'children' => [ + 'CreateCluster', + 'UpdateCluster', + 'InstallSoftwares', + 'UninstallSoftwares', + 'InstallAddon', + 'UnInstallAddon', + 'AttachSharedStorages', + 'DetachSharedStorages', + 'ListSoftwares', + 'ListSharedStorages', + 'ListInstalledSoftwares', + 'ListClusters', + 'ListAvailableImages', + 'ListAvailableFileSystems', + 'ListAddons', + 'ListAddonTemplates', + 'GetCluster', + 'GetAddon', + 'DescribeAddonTemplate', + 'DeleteCluster', + ], + ], + [ + 'id' => 196249, + 'title' => '用户', + 'type' => 'directory', + 'children' => [ + 'CreateUsers', + 'UpdateUser', + 'ListUsers', + 'DeleteUsers', + ], + ], + [ + 'id' => 196254, + 'title' => '节点与队列', + 'type' => 'directory', + 'children' => [ + 'CreateQueue', + 'CreateNodes', + 'UpdateQueue', + 'UpdateNodes', + 'ListQueues', + 'ListNodes', + 'GetQueue', + 'DeleteQueues', + 'DeleteNodes', + ], + ], + [ + 'id' => 196454, + 'title' => '作业', + 'type' => 'directory', + 'children' => [ + 'CreateJob', + 'ListJobs', + 'GetJobLog', + 'GetJob', + 'StopJobs', + ], + ], + [ + 'id' => 196273, + 'title' => '监控与日志', + 'type' => 'directory', + 'children' => [ + 'ListCommonLogs', + 'GetCommonLogDetail', + ], + ], + [ + 'id' => 365937, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'AttachNodes', + 'ListRegions', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'CreateReservedNodePool', + 'DeleteReservedNodePool', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AddonNodeTemplate' => [ + 'title' => 'A short description of struct', + 'description' => 'ECS资源公共描述，包含付费类型、实例规格、镜像、系统盘和数据盘等参数', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'title' => 'InstanceType', + 'description' => 'ECS实例的资源规格。'."\n" + .'- 产品选型：参见[实例规格族](https://help.aliyun.com/zh/ecs/user-guide/overview-of-instance-families?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX)或调用 [DescribeInstanceTypes](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeinstancetypes?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) 查看目标实例规格的性能数据。'."\n" + .'- 查询库存：调用 [DescribeAvailableResource](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeavailableresource?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) 查看指定地域或者可用区内的资源供给情况。', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs.c7.4xlarge', + ], + 'InstanceId' => [ + 'title' => 'InstanceId', + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'i-bp1bzqq4rj1eemun****', + ], + 'PrivateIpAddress' => [ + 'title' => 'PrivateIpAddress', + 'description' => '实例的VPC网络IP地址。', + 'type' => 'string', + 'example' => '172.16.**.**', + ], + 'ImageId' => [ + 'title' => 'ImageId', + 'description' => '镜像 ID，启动实例时选择的镜像资源。您可以通过 [DescribeImages](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeimages?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) 查询您可以使用的镜像资源。', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun_3_x64_20G_alibase_20221102.vhd', + ], + 'OsName' => [ + 'title' => 'OsName', + 'description' => 'OsName', + 'type' => 'string', + 'required' => true, + 'example' => 'CentOS 7.6 64 位', + ], + 'OsNameEN' => [ + 'title' => 'OsNameEN', + 'description' => 'OsNameEN', + 'type' => 'string', + 'required' => true, + 'example' => 'CentOS 7.6 64 bit', + ], + 'InstanceChargeType' => [ + 'title' => 'InstanceChargeType', + 'description' => '实例的付费方式。取值范围：'."\n" + ."\n" + .'- PrePaid：包年包月。'."\n" + .'- PostPaid：按量付费。'."\n" + ."\n" + .'默认值：PostPaid。'."\n" + ."\n" + .'选择包年包月时，您必须确认自己的账号支持余额支付或者信用支付，否则将返回InvalidPayMethod的错误提示。', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'PeriodUnit' => [ + 'title' => 'PeriodUnit', + 'description' => '包年包月计费方式的时长单位。取值范围：'."\n" + ."\n" + .'- Week。'."\n" + .'- Month（默认）。', + 'type' => 'string', + 'example' => 'Month', + ], + 'Period' => [ + 'title' => 'Period', + 'description' => '购买资源的时长，单位由PeriodUnit指定。当参数InstanceChargeType取值为PrePaid时才生效且为必选值。一旦指定了DedicatedHostId，则取值范围不能超过专有宿主机的订阅时长。取值范围：'."\n" + ."\n" + .'- PeriodUnit=Week 时，Period 取值：1、2、3、4。'."\n" + .'- PeriodUnit=Month 时，Period 取值：1、2、3、4、5、6、7、8、9、12、24、36、48、60。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AutoRenew' => [ + 'title' => 'AutoRenew', + 'description' => '是否要自动续费。当参数InstanceChargeType取值PrePaid时才生效。取值范围：'."\n" + ."\n" + .'- true：自动续费。'."\n" + .'- false：不自动续费。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AutoRenewPeriod' => [ + 'title' => 'AutoRenewPeriod', + 'description' => '单次自动续费的续费时长。取值范围：'."\n" + ."\n" + .'- PeriodUnit=Week 时：1、2、3。'."\n" + .'- PeriodUnit=Month 时：1、2、3、6、12、24、36、48、60。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SpotStrategy' => [ + 'title' => 'SpotStrategy', + 'description' => '按量付费实例的竞价策略。当参数InstanceChargeType取值为PostPaid时生效。取值范围：'."\n" + ."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。'."\n" + ."\n" + .'默认值：NoSpot。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'SpotPriceLimit' => [ + 'title' => 'SpotPriceLimit', + 'description' => '设置实例的每小时最高价格。支持最大 3 位小数，参数SpotStrategy取值为SpotWithPriceLimit时生效。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.97', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => '抢占式实例的保留时长，单位为小时。 默认值：1。取值范围：'."\n" + ."\n" + .'- 1：创建后阿里云会保证实例运行 1 小时不会被自动释放；超过 1 小时后，系统会自动比较出价与市场价格、检查资源库存，来决定实例的持有和回收。'."\n" + .'- 0：创建后，阿里云不保证实例运行 1 小时，系统会自动比较出价与市场价格、检查资源库存，来决定实例的持有和回收。'."\n" + ."\n" + .'实例回收前 5 分钟阿里云会通过 ECS 系统事件向您发送通知。抢占式实例按秒计费，建议您结合具体任务执行耗时来选择合适的保留时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnableHT' => [ + 'title' => 'EnableHT', + 'description' => '节点是否开启超线程。可选范围：'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SystemDisk' => [ + 'title' => 'SystemDisk', + 'description' => '节点系统盘配置详情。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => 'Category', + 'description' => '系统盘的云盘种类。取值范围：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘。'."\n" + .'- cloud_ssd：SSD 云盘。'."\n" + .'- cloud_essd：ESSD 云盘。'."\n" + .'- cloud：普通云盘。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'Size' => [ + 'title' => 'Size', + 'description' => '系统盘大小，内存单位为 GiB。取值范围：'."\n" + ."\n" + .'- cloud_efficiency：40~32768。'."\n" + .'- cloud_ssd：40~32768。'."\n" + .'- cloud_essd：具体取值范围与DataDisk.N.PerformanceLevel的取值有关。'."\n" + ."\n" + .' - PL0：40~65,536。'."\n" + .' - PL1：40~65,536。'."\n" + .' - PL2：461~65,536。'."\n" + .' - PL3：1261~65,536。'."\n" + .'- cloud：40~500。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'Level' => [ + 'title' => 'Level', + 'description' => '创建 ESSD 云盘作为系统盘使用时，设置云盘的性能等级。取值范围：'."\n" + ."\n" + .'- PL0：单盘最高随机读写 IOPS 1 万。'."\n" + .'- PL1（默认）：单盘最高随机读写 IOPS 5 万。'."\n" + .'- PL2：单盘最高随机读写 IOPS 10 万。'."\n" + .'- PL3：单盘最高随机读写 IOPS 100 万。'."\n" + .'有关如何选择 ESSD 性能等级，请参见[ ESSD 云盘](https://help.aliyun.com/zh/ecs/user-guide/essds?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX)。', + 'type' => 'string', + 'example' => 'PL0', + ], + ], + ], + 'DataDisks' => [ + 'title' => 'DataDisk', + 'description' => '数据盘信息集合列表。'."\n" + ."\n\n" + ."\n\n" + .'> 子级条数 <= 16', + 'type' => 'array', + 'items' => [ + 'description' => '数据盘的配置详情。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => 'Category', + 'description' => '数据盘 N 的云盘种类。取值范围：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘。'."\n" + .'- cloud_ssd：SSD 云盘。'."\n" + .'- cloud_essd：ESSD 云盘。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'Size' => [ + 'title' => 'Size', + 'description' => '第 N 个数据盘的容量大小，N 的取值范围为 1~16，内存单位为 GiB。取值范围：'."\n" + ."\n" + .'- cloud_efficiency：40~32768。'."\n" + .'- cloud_ssd：40~32768。'."\n" + .'- cloud_essd：具体取值范围与DataDisk.N.PerformanceLevel的取值有关。'."\n" + ."\n" + .' - PL0：40~65,536。'."\n" + .' - PL1：40~65,536。'."\n" + .' - PL2：461~65,536。'."\n" + .' - PL3：1261~65,536。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'Level' => [ + 'title' => 'Level', + 'description' => '创建 ESSD 云盘作为数据盘使用时，设置云盘的性能等级。取值范围：'."\n" + ."\n" + .'- PL0：单盘最高随机读写 IOPS 1 万。'."\n" + .'- PL1（默认）：单盘最高随机读写 IOPS 5 万。'."\n" + .'- PL2：单盘最高随机读写 IOPS 10 万。'."\n" + .'- PL3：单盘最高随机读写 IOPS 100 万。'."\n" + .'有关如何选择 ESSD 性能等级，请参见[ ESSD 云盘](https://help.aliyun.com/zh/ecs/user-guide/essds?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX)。', + 'type' => 'string', + 'example' => 'PL0', + ], + 'DeleteWithInstance' => [ + 'title' => 'DeleteWithInstance', + 'description' => '表示数据盘是否随实例释放。取值范围：'."\n" + ."\n" + .'- true：数据盘随实例释放。'."\n" + .'- false：数据盘不随实例释放。'."\n" + ."\n" + .'默认值为 true。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + ], + 'NodeTemplate' => [ + 'title' => '创建节点资源模版', + 'description' => 'ECS资源的公共描述，包含付费类型、实例规格、镜像、系统盘和数据盘等参数', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'title' => 'InstanceTypes', + 'description' => 'ECS实例的资源规格。'."\n" + .'- 产品选型：参见[实例规格族](https://help.aliyun.com/zh/ecs/user-guide/overview-of-instance-families?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX)或调用 [DescribeInstanceTypes](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeinstancetypes?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) 查看目标实例规格的性能数据。'."\n" + .'- 查询库存：调用 [DescribeAvailableResource](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeavailableresource?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) 查看指定地域或者可用区内的资源供给情况。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c7.4xlarge', + ], + 'ImageId' => [ + 'title' => 'ImageId', + 'description' => '镜像 ID，启动实例时选择的镜像资源。您可以通过 [DescribeImages](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeimages?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) 查询您可以使用的镜像资源。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun_3_x64_20G_alibase_20221102.vhd', + ], + 'InstanceChargeType' => [ + 'title' => 'InstanceChargeType', + 'description' => '实例的付费方式。取值范围：'."\n" + ."\n" + .'- PrePaid：包年包月。'."\n" + .'- PostPaid：按量付费。'."\n" + ."\n" + .'默认值：PostPaid。'."\n" + ."\n" + .'选择包年包月时，您必须确认自己的账号支持余额支付或者信用支付，否则将返回InvalidPayMethod的错误提示。', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'PeriodUnit' => [ + 'title' => 'PeriodUnit', + 'description' => '包年包月计费方式的时长单位。取值范围：'."\n" + ."\n" + .'- Week。'."\n" + .'- Month（默认）。', + 'type' => 'string', + 'example' => 'Month', + ], + 'Period' => [ + 'title' => 'Period', + 'description' => '购买资源的时长，单位由PeriodUnit指定。当参数InstanceChargeType取值为PrePaid时才生效且为必选值。一旦指定了DedicatedHostId，则取值范围不能超过专有宿主机的订阅时长。取值范围：'."\n" + ."\n" + .'- PeriodUnit=Week 时，Period 取值：1、2、3、4。'."\n" + .'- PeriodUnit=Month 时，Period 取值：1、2、3、4、5、6、7、8、9、12、24、36、48、60。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AutoRenew' => [ + 'title' => 'AutoRenew', + 'description' => '是否要自动续费。当参数InstanceChargeType取值PrePaid时才生效。取值范围：'."\n" + ."\n" + .'- true：自动续费。'."\n" + .'- false：不自动续费。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'AutoRenewPeriod' => [ + 'title' => 'AutoRenewPeriod', + 'description' => '单次自动续费的续费时长。取值范围：'."\n" + ."\n" + .'- PeriodUnit=Week 时：1、2、3。'."\n" + .'- PeriodUnit=Month 时：1、2、3、6、12、24、36、48、60。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SpotStrategy' => [ + 'title' => 'SpotStrategy', + 'description' => '按量付费实例的竞价策略。当参数InstanceChargeType取值为PostPaid时生效。取值范围：'."\n" + ."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。'."\n" + ."\n" + .'默认值：NoSpot。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'SpotPriceLimit' => [ + 'title' => 'SpotPriceLimit', + 'description' => '设置实例的每小时最高价格。支持最大 3 位小数，参数SpotStrategy取值为SpotWithPriceLimit时生效。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.97', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => '抢占式实例的保留时长，单位为小时。 默认值：1。取值范围：'."\n" + ."\n" + .'- 1：创建后阿里云会保证实例运行 1 小时不会被自动释放；超过 1 小时后，系统会自动比较出价与市场价格、检查资源库存，来决定实例的持有和回收。'."\n" + .'- 0：创建后，阿里云不保证实例运行 1 小时，系统会自动比较出价与市场价格、检查资源库存，来决定实例的持有和回收。'."\n" + ."\n" + .'实例回收前 5 分钟阿里云会通过 ECS 系统事件向您发送通知。抢占式实例按秒计费，建议您结合具体任务执行耗时来选择合适的保留时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'EnableHT' => [ + 'title' => 'EnableHT', + 'description' => '节点是否开启超线程。可选范围：'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SystemDisk' => [ + 'title' => 'SystemDisk', + 'description' => '节点系统盘配置详情。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => 'Category', + 'description' => '系统盘的云盘种类。取值范围：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘。'."\n" + .'- cloud_ssd：SSD 云盘。'."\n" + .'- cloud_essd：ESSD 云盘。'."\n" + .'- cloud：普通云盘。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'Size' => [ + 'title' => 'Size', + 'description' => '系统盘大小，内存单位为 GiB。取值范围：'."\n" + ."\n" + .'- cloud_efficiency：40~32768。'."\n" + .'- cloud_ssd：40~32768。'."\n" + .'- cloud_essd：具体取值范围与DataDisk.N.PerformanceLevel的取值有关。'."\n" + ."\n" + .' - PL0：40~65,536。'."\n" + .' - PL1：40~65,536。'."\n" + .' - PL2：461~65,536。'."\n" + .' - PL3：1261~65,536。'."\n" + .'- cloud：40~500。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'Level' => [ + 'title' => 'Level', + 'description' => '创建 ESSD 云盘作为系统盘使用时，设置云盘的性能等级。取值范围：'."\n" + ."\n" + .'- PL0：单盘最高随机读写 IOPS 1 万。'."\n" + .'- PL1（默认）：单盘最高随机读写 IOPS 5 万。'."\n" + .'- PL2：单盘最高随机读写 IOPS 10 万。'."\n" + .'- PL3：单盘最高随机读写 IOPS 100 万。'."\n" + .'有关如何选择 ESSD 性能等级，请参见[ ESSD 云盘](https://help.aliyun.com/zh/ecs/user-guide/essds?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX)。', + 'type' => 'string', + 'example' => 'PL0', + ], + ], + ], + 'DataDisks' => [ + 'title' => 'DataDisk', + 'description' => '数据盘信息集合列表。'."\n" + ."\n\n" + ."\n\n" + .'> 子级条数 <= 16', + 'type' => 'array', + 'items' => [ + 'description' => '数据盘的配置详情。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => 'Category', + 'description' => '数据盘 N 的云盘种类。取值范围：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘。'."\n" + .'- cloud_ssd：SSD 云盘。'."\n" + .'- cloud_essd：ESSD 云盘。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'Size' => [ + 'title' => 'Size', + 'description' => '第 N 个数据盘的容量大小，N 的取值范围为 1~16，内存单位为 GiB。取值范围：'."\n" + ."\n" + .'- cloud_efficiency：40~32768。'."\n" + .'- cloud_ssd：40~32768。'."\n" + .'- cloud_essd：具体取值范围与DataDisk.N.PerformanceLevel的取值有关。'."\n" + ."\n" + .' - PL0：40~65,536。'."\n" + .' - PL1：40~65,536。'."\n" + .' - PL2：461~65,536。'."\n" + .' - PL3：1261~65,536。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'Level' => [ + 'title' => 'Level', + 'description' => '创建 ESSD 云盘作为数据盘使用时，设置云盘的性能等级。取值范围：'."\n" + ."\n" + .'- PL0：单盘最高随机读写 IOPS 1 万。'."\n" + .'- PL1（默认）：单盘最高随机读写 IOPS 5 万。'."\n" + .'- PL2：单盘最高随机读写 IOPS 10 万。'."\n" + .'- PL3：单盘最高随机读写 IOPS 100 万。'."\n" + .'有关如何选择 ESSD 性能等级，请参见[ ESSD 云盘](https://help.aliyun.com/zh/ecs/user-guide/essds?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX)。', + 'type' => 'string', + 'example' => 'PL0', + ], + 'DeleteWithInstance' => [ + 'title' => 'DeleteWithInstance', + 'description' => '表示数据盘是否随实例释放。取值范围：'."\n" + ."\n" + .'- true：数据盘随实例释放。'."\n" + .'- false：数据盘不随实例释放。'."\n" + ."\n" + .'默认值为 true。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MountDir' => [ + 'title' => 'MountDir', + 'description' => 'MountDir', + 'type' => 'string', + 'example' => '/data1', + ], + 'Device' => [ + 'title' => 'Device', + 'description' => 'Device', + 'type' => 'string', + 'example' => '/dev/xvdb', + ], + 'SnapshotId' => [ + 'title' => 'SnapshotId', + 'description' => 'SnapshotId', + 'type' => 'string', + 'example' => 's-bp1ei2b44ripxuo46hym', + ], + ], + ], + ], + ], + ], + 'QueueTemplate' => [ + 'title' => 'A description of struct', + 'description' => '队列配置模版', + 'type' => 'object', + 'properties' => [ + 'QueueName' => [ + 'title' => 'QueueName', + 'description' => '队列名称。长度为1～15个字符，支持 Unicode 中 letter 分类下的字符（其中包括英文和数字等），可以包含半角句号（.）。', + 'type' => 'string', + 'required' => true, + 'example' => 'comp', + ], + 'EnableScaleOut' => [ + 'title' => 'EnableScaleOut', + 'description' => '队列是否开启自动扩容。取值范围：'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableScaleIn' => [ + 'title' => 'EnableScaleIn', + 'description' => '队列是否开启自动缩容。取值范围：'."\n" + ."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MinCount' => [ + 'title' => 'MinCount', + 'description' => '队列保有的最小计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxCount' => [ + 'title' => 'MaxCount', + 'description' => '队列可保有的最大计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'InitialCount' => [ + 'title' => 'InitialCount', + 'description' => '队列保有的初始计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InterConnect' => [ + 'title' => 'HPCInterConnect', + 'description' => '队列中计算节点间的网络类型，可能值：'."\n" + ."\n" + .'- vpc'."\n" + .'- eRDMA', + 'type' => 'string', + 'example' => 'erdma', + ], + 'VSwitchIds' => [ + 'title' => 'VSwitchIds', + 'description' => '队列中计算节点可用的虚拟交换机列表。N的取值范围1～5。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'VSwitchId', + ], + ], + 'ComputeNodes' => [ + 'title' => 'Resources', + 'description' => '队列中计算节点的硬件配置列表。N的取值范围是0～10。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点的硬件配置。', + '$ref' => '#/components/schemas/NodeTemplate', + ], + ], + 'AllocationStrategy' => [ + 'title' => 'AllocationStrategy', + 'description' => '队列自动扩容的策略。', + 'type' => 'string', + 'example' => 'PriorityInstanceType', + ], + 'RamRole' => [ + 'title' => 'RamRole', + 'description' => '队列中计算节点绑定的授权实例角色名称。', + 'type' => 'string', + 'example' => 'AliyunECSInstanceForEHPCRole', + ], + 'HostnamePrefix' => [ + 'title' => 'HostNamePrefix', + 'description' => '队列中计算节点的主机名前缀。', + 'type' => 'string', + 'example' => 'compute', + ], + 'HostnameSuffix' => [ + 'title' => 'HostNameSuffix', + 'description' => '队列中计算节点的主机名后缀。', + 'type' => 'string', + 'example' => 'demo', + ], + 'KeepAliveNodes' => [ + 'title' => 'KeepAliveNodes', + 'description' => '队列中开启删除保护的节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '开启删除保护的节点主机名。', + 'type' => 'string', + 'example' => 'compute000', + ], + ], + 'MaxCountPerCycle' => [ + 'title' => 'MaxCountPerCycle', + 'description' => '队列在每个扩容轮次中最大扩容的计算节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99', + ], + 'ReservedNodePoolId' => [ + 'title' => 'ReservedNodePoolId', + 'description' => 'ReservedNodePoolId', + 'type' => 'string', + 'example' => 'rnp-756vlp7a', + ], + ], + ], + 'SharedStorageTemplate' => [ + 'title' => '挂载的文件系统的相关参数。', + 'description' => '共享存储的配置模版。', + 'type' => 'object', + 'properties' => [ + 'MountDirectory' => [ + 'title' => '挂载文件系统的本地挂载目录。', + 'description' => '挂载文件系统的本地挂载目录。', + 'type' => 'string', + 'example' => '/home', + ], + 'FileSystemId' => [ + 'title' => '挂载的文件系统ID。', + 'description' => '挂载的文件系统ID。', + 'type' => 'string', + 'example' => '008b63****', + ], + 'NASDirectory' => [ + 'title' => '挂载的文件系统需要挂载的远程目录。', + 'description' => '挂载的文件系统需要挂载的远程目录。', + 'type' => 'string', + 'example' => '/', + ], + 'MountTargetDomain' => [ + 'title' => '挂载的文件系统挂载点地址', + 'description' => '挂载的文件系统挂载点地址。', + 'type' => 'string', + 'example' => '008b****-sihc.cn-hangzhou.extreme.nas.aliyuncs.com', + ], + 'ProtocolType' => [ + 'title' => '挂载的文件系统协议类型。取值范围：- NFS - SMB', + 'description' => '挂载的文件系统协议类型。取值范围：'."\n" + ."\n" + .'- NFS'."\n" + ."\n" + .'- SMB', + 'type' => 'string', + 'example' => 'NFS', + ], + 'MountOptions' => [ + 'title' => '挂载的文件系统的存储挂载选项', + 'description' => '挂载的文件系统的存储挂载选项。', + 'type' => 'string', + 'example' => '-t nfs -o vers=3,nolock,noresvport', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateCluster' => [ + 'summary' => '创建一个按量付费或者预付费（包年包月）集群。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '227341', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => '集群名称，长度为2~64个字符。', + 'description' => '集群名称。长度为2~128个字符，支持英文、中文和数字。可以包含短划线（-）和下划线（_）。', + 'type' => 'string', + 'required' => false, + 'example' => 'slurm22.05.8-cluster-20240718', + ], + ], + [ + 'name' => 'ClusterDescription', + 'in' => 'query', + 'schema' => [ + 'title' => '集群描述信息。长度为2~256个英文或中文字符，不能以http://和https://开头。', + 'description' => '集群描述。长度为2~128个字符，支持英文、中文和数字。可以包含短划线（-）和下划线（_）。', + 'type' => 'string', + 'required' => false, + 'example' => 'slurm22.05.8-cluster-20240718'."\n", + ], + ], + [ + 'name' => 'ClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '集群系列，取值范围：'."\n" + ."\n" + .'- Standard：标准版。'."\n" + .'- Serverless：托管版。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Standard' => 'Standard', + 'Serverless' => 'Serverless', + ], + 'example' => 'Standard', + ], + ], + [ + 'name' => 'ClusterVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群使用的专有网络VPC ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-m5efjevmclc0xdmys****', + ], + ], + [ + 'name' => 'ClusterVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群使用的虚拟交换机ID。虚拟交换机ID需在`ClusterVpcId`中。'."\n" + ."\n" + .'您可以调用[DescribeVpcs](~~448581~~)查询已创建的VPC和VSwitch信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-f8za5p0mwzgdu3wgx****', + ], + ], + [ + 'name' => 'IsEnterpriseSecurityGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用企业级安全组。取值范围：'."\n" + ."\n" + .'- true：自动创建并使用企业级安全组。'."\n" + .'- false：不使用企业级安全组，自动创建并使用普通安全组。'."\n" + ."\n" + .'关于如何选择安全组类型，请参见[普通安全组与企业级安全组](~~605897~~)。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定新创建集群所属的安全组ID。'."\n" + ."\n" + .'您可以调用[DescribeSecurityGroups](~~25556~~)查询当前地域可以使用的安全组。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp13n61xsydodfyg****', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '集群客户端版本。默认使用最新版本。', + 'type' => 'string', + 'required' => false, + 'example' => '2.1.0', + ], + ], + [ + 'name' => 'ClusterCustomConfiguration', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群后处理脚本。', + 'type' => 'object', + 'properties' => [ + 'Script' => [ + 'description' => '后处理脚本的下载地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://*****', + ], + 'Args' => [ + 'description' => '安装后脚本的执行参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'E-HPC cn-hangzhou', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ClusterCredentials', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群的安全凭证。', + 'type' => 'object', + 'properties' => [ + 'KeyPairName' => [ + 'description' => '密钥对名称。长度为2~128个英文或中文字符。必须以大小写字母或中文开头，不能以`http://`和`https://`开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。'."\n" + .'>如果您要使用ECS密钥对功能，具体操作，请参见[创建密钥对](~~51793~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ali0824', + ], + 'Password' => [ + 'description' => '登录节点的root密码。长度为8至20个字符，必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是：'."\n" + .'`() ~ ! @ # $ % ^ & * - = + { } [ ] : ; ‘ < > , . ? / `'."\n" + ."\n" + .'> 建议使用HTTPS协议调用API避免密码泄露。', + 'type' => 'string', + 'required' => false, + 'example' => '**********', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'MaxCount', + 'in' => 'query', + 'schema' => [ + 'description' => '集群可管理的计算节点数量，取值范围：0～5,000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'MaxCoreCount', + 'in' => 'query', + 'schema' => [ + 'description' => '集群可管理的计算节点总核数，取值范围：0～100,000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'DeletionProtection', + 'in' => 'query', + 'schema' => [ + 'description' => '集群删除保护属性，指定是否支持通过控制台或API [DeleteCluster](~~424406~~)删除集群。'."\n" + ."\n" + .'- true：开启集群删除保护。'."\n" + .'- false：关闭集群删除保护。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。'."\n" + ."\n" + .'您可以调用[ListResourceGroups](~~158855~~)查询资源组ID。 ', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxazb4******', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群的标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群的标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '集群的标签键。N的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'ClusterId', + ], + 'Value' => [ + 'description' => '集群的标签值。N的取值范围：1~20。一旦传入该值，可以为空字符串。最多支持128个字符，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-******', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Manager', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群管理节点配置。', + 'type' => 'object', + 'properties' => [ + 'Scheduler' => [ + 'description' => '调度器服务配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '调度器类型。取值范围：'."\n" + ."\n" + .'- SLURM'."\n" + .'- PBS'."\n" + .'- OPENGRIDSCHEDULER'."\n" + .'- LSF_PLUGIN'."\n" + .'- PBS_PLUGIN', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PBS' => 'PBS', + 'SLURM' => 'SLURM', + 'PBS_PLUGIN' => 'PBS_PLUGIN', + 'OPENGRIDSCHEDULER' => 'OPENGRIDSCHEDULER', + 'LSF_PLUGIN' => 'LSF_PLUGIN', + ], + 'example' => 'SLURM', + ], + 'Version' => [ + 'description' => '调度器版本。', + 'type' => 'string', + 'required' => false, + 'example' => '22.05.8', + ], + ], + 'required' => false, + ], + 'DirectoryService' => [ + 'description' => '域账号服务配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '域账号类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NIS' => 'NIS', + ], + 'example' => 'NIS', + ], + 'Version' => [ + 'description' => '域账号版本。', + 'type' => 'string', + 'required' => false, + 'example' => '2.31', + ], + ], + 'required' => false, + ], + 'DNS' => [ + 'description' => '域名解析服务配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '域名解析类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NIS' => 'NIS', + ], + 'example' => 'NIS', + ], + 'Version' => [ + 'description' => '域名解析版本。', + 'type' => 'string', + 'required' => false, + 'example' => '2.31', + ], + ], + 'required' => false, + ], + 'ManagerNode' => [ + 'description' => '管理节点的硬件配置信息。', + 'required' => false, + '$ref' => '#/components/schemas/NodeTemplate', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Queues', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群队列的配置。队列数量支持0～8个。', + 'type' => 'array', + 'items' => [ + 'description' => '集群队列的详细配置。', + 'required' => false, + '$ref' => '#/components/schemas/QueueTemplate', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SharedStorages', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群共享存储配置。', + 'type' => 'array', + 'items' => [ + 'description' => '集群共享存储的详细配置。', + 'required' => false, + '$ref' => '#/components/schemas/SharedStorageTemplate', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AdditionalPackages', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群待安装的软件列表，N的取值范围：0～10。', + 'type' => 'array', + 'items' => [ + 'description' => '待安装软件的具体信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '待安装软件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mpich', + ], + 'Version' => [ + 'description' => '待安装软件版本。', + 'type' => 'string', + 'required' => false, + 'example' => '4.0.3', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Addons', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群自定义服务组件配置，仅支持一个组件。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义服务组件的具体配置信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '自定义服务组件的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => '自定义服务组件的版本。', + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'ServicesSpec' => [ + 'description' => '自定义服务组件的服务配置。', + 'type' => 'string', + 'required' => false, + 'example' => '"[{\\\\"ServiceName\\\\": \\\\"SSH\\\\", \\\\"ServiceAccessType\\\\": null, \\\\"ServiceAccessUrl\\\\": null, \\\\"NetworkACL\\\\": [{\\\\"IpProtocol\\\\": \\\\"TCP\\\\", \\\\"Port\\\\": 22, \\\\"SourceCidrIp\\\\": \\\\"0.0.0.0/0\\\\"}]}, {\\\\"ServiceName\\\\": \\\\"VNC\\\\", \\\\"ServiceAccessType\\\\": null, \\\\"ServiceAccessUrl\\\\": null, \\\\"NetworkACL\\\\": [{\\\\"IpProtocol\\\\": \\\\"TCP\\\\", \\\\"Port\\\\": 12016, \\\\"SourceCidrIp\\\\": \\\\"0.0.0.0/0\\\\"}]}, {\\\\"ServiceName\\\\": \\\\"CLIENT\\\\", \\\\"ServiceAccessType\\\\": \\\\"URL\\\\", \\\\"ServiceAccessUrl\\\\": \\\\"\\\\", \\\\"NetworkACL\\\\": [{\\\\"IpProtocol\\\\": \\\\"TCP\\\\", \\\\"Port\\\\": 12011, \\\\"SourceCidrIp\\\\": \\\\"0.0.0.0/0\\\\"}]}]"', + ], + 'ResourcesSpec' => [ + 'description' => '自定义服务组件的资源配置。', + 'type' => 'string', + 'required' => false, + 'example' => '"{\\\\"EipResource\\\\": {\\\\"AutoCreate\\\\": true}, \\\\"EcsResources\\\\": [{\\\\"InstanceType\\\\": \\\\"ecs.c7.xlarge\\\\", \\\\"ImageId\\\\": \\\\"centos_7_6_x64_20G_alibase_20211130.vhd\\\\", \\\\"SystemDisk\\\\": {\\\\"Category\\\\": \\\\"cloud_essd\\\\", \\\\"Size\\\\": 40, \\\\"Level\\\\": \\\\"PL0\\\\"}, \\\\"EnableHT\\\\": true, \\\\"InstanceChargeType\\\\": \\\\"PostPaid\\\\", \\\\"SpotStrategy\\\\": \\\\"NoSpot\\\\"}]}"', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ClusterMode', + 'in' => 'query', + 'schema' => [ + 'description' => '集群部署类型，取值范围：'."\n" + ."\n" + .'- Integrated：公共云集群。'."\n" + .'- Hybrid：混合云集群。'."\n" + .'- Custom：自定义集群。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Hybrid' => 'Hybrid', + 'Custom' => 'Custom', + 'Integrated' => 'Integrated', + ], + 'example' => 'Integrated', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求结果，可能值：'."\n" + ."\n" + .'- true：请求成功。'."\n" + ."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C0******', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr******', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C0******'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'OrderError.Arrearage', + 'errorMessage' => 'Your account balance is less than CNY 100. Please add funds to your account and try again.', + ], + [ + 'errorCode' => 'OrderError.InstHasUnpaidOrder', + 'errorMessage' => 'Your account has an unpaid order.', + ], + [ + 'errorCode' => 'OrderError.InsufficientBalance', + 'errorMessage' => 'The account balance is insufficient. Please add funds first and try again.', + ], + [ + 'errorCode' => 'OrderError.InvalidPayMethod', + 'errorMessage' => 'No valid default payment method is specified for your account.', + ], + [ + 'errorCode' => 'OrderError.NoCard', + 'errorMessage' => 'No credit card is bound to 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' => 'Cluster.NotSupported', + 'errorMessage' => 'Current cluster does not support this operation.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ConflictOpt', + 'errorMessage' => 'A conflicting operation is running.', + ], + [ + 'errorCode' => 'TooManyClusters', + 'errorMessage' => 'The number of user clusters exceeds the quota.', + ], + ], + [ + [ + 'errorCode' => 'KeyPairNotFound', + 'errorMessage' => 'The specified KeyPair does not exist.', + ], + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'OrderError', + 'errorMessage' => 'An order request error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"F6757FA4-8FED-4602-B7F5-3550C0******\\",\\n \\"ClusterId\\": \\"ehpc-hz-FYUr******\\",\\n \\"TaskId\\": \\"F6757FA4-8FED-4602-B7F5-3550C0******\\\\n\\"\\n}","type":"json"}]', + 'title' => '创建集群', + 'description' => '## 接口说明'."\n" + .'请确保在使用该接口前，已充分了解E-HPC产品的收费方式和价格。更多信息，请参见[计费概述](~~2842985~~)。', + ], + 'UpdateCluster' => [ + 'summary' => '修改指定集群的配置信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227339', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => '集群名称。长度为2~128个字符，支持英文、中文和数字。可以包含短划线（-）和下划线（_）。', + 'type' => 'string', + 'required' => false, + 'example' => 'slurm22.05.8-serverless-cluster-20240805', + ], + ], + [ + 'name' => 'ClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '集群描述。长度为2~128个字符，支持英文、中文和数字。可以包含短划线（-）和下划线（_）。', + 'type' => 'string', + 'required' => false, + 'example' => 'slurm22.05.8-serverless-cluster-20240805'."\n", + ], + ], + [ + 'name' => 'MaxCount', + 'in' => 'query', + 'schema' => [ + 'description' => '集群可管理的计算节点数量，取值范围：0～5,000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'MaxCoreCount', + 'in' => 'query', + 'schema' => [ + 'description' => '集群可管理的计算节点总核数，取值范围：0～100,000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'DeletionProtection', + 'in' => 'query', + 'schema' => [ + 'description' => '集群删除保护属性，指定是否支持通过控制台或API DeleteCluster删除集群。'."\n" + ."\n" + .'- true：开启集群删除保护。'."\n" + .'- false：关闭集群删除保护。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '集群客户端版本。默认使用最新版本。', + 'type' => 'string', + 'required' => false, + 'example' => '2.1.0', + ], + ], + [ + 'name' => 'ClusterCustomConfiguration', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群后处理脚本。', + 'type' => 'object', + 'properties' => [ + 'Script' => [ + 'description' => '后处理脚本的下载地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://*****'."\n", + ], + 'Args' => [ + 'description' => '后处理脚本的执行参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'E-HPC cn-hangzhou'."\n", + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'GrowInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '集群自动扩容的时间间隔。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'IdleInterval', + 'in' => 'query', + 'schema' => [ + 'description' => '集群计算节点的空闲时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'EnableScaleOut', + 'in' => 'query', + 'schema' => [ + 'description' => '集群是否开启自动扩容。可选值：'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EnableScaleIn', + 'in' => 'query', + 'schema' => [ + 'description' => '集群是否开启自动缩容，可能值：'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MonitorSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群监控详情。', + 'type' => 'object', + 'properties' => [ + 'EnableComputeLoadMonitor' => [ + 'description' => '集群是否开启计算节点的监控组件，可能值：'."\n" + ."\n" + .'- true：开启'."\n" + ."\n" + .'- false：关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SchedulerSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '集群调度详情。', + 'type' => 'object', + 'properties' => [ + 'EnableTopologyAwareness' => [ + 'description' => '集群是否开启拓扑感知功能，可能值：'."\n" + ."\n" + .'- true：开启'."\n" + ."\n" + .'- false：关闭', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求结果，可能值：'."\n" + .'- true：请求成功'."\n" + .'- false：请求失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","type":"json"}]', + 'title' => '修改集群信息', + ], + 'InstallSoftwares' => [ + 'summary' => '为指定集群安装软件。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227329', + 'abilityTreeNodes' => [ + 'FEATUREehpcL8RMWH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '待安装软件的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AdditionalPackages', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待安装软件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待安装软件列表。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '待安装软件的名称。关于E-HPC支持的软件列表，请参见[支持的软件列表](~~2843041~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'gromacs', + ], + 'Version' => [ + 'description' => '待安装软件的版本。关于如何获取软件版本信息，请参见[支持的软件列表](~~2843041~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '2024.1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => '安装软件', + 'description' => '## 接口说明'."\n" + ."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'- 集群状态必须处于`运行中`。'."\n" + .'- 若集群系列为`托管版`（Serverless），请确保集群中存在至少一个登录节点或计算节点，否则无法为目标集群添加软件。', + ], + 'UninstallSoftwares' => [ + 'summary' => '卸载E-HPC集群中已安装的指定软件。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '228511', + 'abilityTreeNodes' => [ + 'FEATUREehpcL8RMWH', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AdditionalPackages', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待卸载软件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待卸载软件的详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '待卸载软件的名称。关于E-HPC支持的软件列表详情，请参见[支持的软件列表](~~2843041~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'gromacs', + ], + 'Version' => [ + 'description' => '待卸载软件的版本。关于E-HPC支持的软件列表详情，请参见[支持的软件列表](~~2843041~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '2024.1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + ], + ], + ], + ], + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => '卸载软件', + 'description' => '## 接口说明'."\n" + ."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'集群状态必须处于`运行中`。', + ], + 'InstallAddon' => [ + 'summary' => '安装自定义服务组件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '228008', + 'abilityTreeNodes' => [ + 'FEATUREehpcL8RMWH', + ], + ], + 'parameters' => [ + [ + 'name' => 'AddonName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义服务组件名称。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Login', + ], + ], + [ + 'name' => 'AddonVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义服务组件版本。', + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ServicesSpec', + 'in' => 'query', + 'schema' => [ + 'description' => '组件服务配置详情。', + 'type' => 'string', + 'required' => true, + 'example' => '`[{"ServiceName": "SSH", "ServiceAccessType": null, "ServiceAccessUrl": null, "NetworkACL": [{"IpProtocol": "TCP", "Port": 22, "SourceCidrIp": "0.0.0.0/0"}]}, {"ServiceName": "VNC", "ServiceAccessType": null, "ServiceAccessUrl": null, "NetworkACL": [{"IpProtocol": "TCP", "Port": 12016, "SourceCidrIp": "0.0.0.0/0"}]}]`', + ], + ], + [ + 'name' => 'ResourcesSpec', + 'in' => 'query', + 'schema' => [ + 'description' => '组件资源配置详情。', + 'type' => 'string', + 'required' => true, + 'example' => '`{"EipResource": {"AutoCreate": true}, "EcsResources": [{"InstanceType": "ecs.c7.xlarge", "ImageId": "centos_7_6_xxx.vhd", "SystemDisk": {"Category": "cloud_essd", "Size": 40, "Level": "PL0"}]}`', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'AddonId' => [ + 'description' => '自定义服务组件ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login-1.0-W4g****', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B745C159-3155-4B94-95D0-4B73D4D2****\\",\\n \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\",\\n \\"AddonId\\": \\"Login-1.0-W4g****\\"\\n}","type":"json"}]', + 'title' => '安装组件', + 'description' => '## 接口说明'."\n" + .'调用该接口时，请注意以下信息：'."\n" + ."\n" + .'- 集群状态处于`运行中`。'."\n" + ."\n" + .'- 集群系列为以下两种：'."\n" + .' - 公共云标准版集群'."\n" + .' - 公共云托管版集群', + ], + 'UnInstallAddon' => [ + 'summary' => '卸载自定义服务组件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228010', + 'abilityTreeNodes' => [ + 'FEATUREehpcXOL4GQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AddonId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义服务组件ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login-1.0-W2g****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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', + ], + ], + 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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","type":"json"}]', + 'title' => '卸载组件', + 'description' => '## 接口说明'."\n" + ."\n" + .'调用该接口时，请注意以下信息：'."\n" + ."\n" + .'- 集群状态处于`运行中`。'."\n" + ."\n" + .'- 集群系列为以下两种：'."\n" + ."\n" + .' - 公共云标准版集群'."\n" + .' - 公共云托管版集群', + ], + 'AttachSharedStorages' => [ + 'summary' => '为E-HPC集群挂载共享存储。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227346', + 'abilityTreeNodes' => [ + 'FEATUREehpcR3Y7DN', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'SharedStorages', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '共享存储信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '共享存储信息。', + 'type' => 'object', + 'properties' => [ + 'MountDirectory' => [ + 'description' => '需要挂载文件系统的本地挂载目录。', + 'type' => 'string', + 'required' => true, + 'example' => '/test', + ], + 'FileSystemId' => [ + 'description' => '需要挂载的文件系统ID。', + 'type' => 'string', + 'required' => true, + 'example' => '0bd504b0**', + ], + 'StorageDirectory' => [ + 'description' => '文件系统存储目录。支持将文件系统内的任意文件目录，挂载到指定的集群目录', + 'type' => 'string', + 'required' => true, + 'example' => '/testehpc', + ], + 'MountTarget' => [ + 'description' => '挂载文件系统的挂载点地址。', + 'type' => 'string', + 'required' => true, + 'example' => '0bd504b***-ngq26.cn-hangzhou.nas.aliyuncs.com', + ], + 'ProtocolType' => [ + 'description' => '挂载的文件系统协议类型。取值范围：'."\n" + .'- NFS'."\n" + .'- SMB', + 'type' => 'string', + 'required' => true, + 'example' => 'NFS', + ], + 'MountOptions' => [ + 'description' => '挂载的文件系统挂载选项。取值范围：'."\n" + .'- -t nfs -o vers=3,nolock,proto=tcp,noresvport'."\n" + .'- -t nfs -o vers=4.0,noresvport'."\n" + ."\n" + .'默认值：-t nfs -o vers=3,nolock,proto=tcp,noresvport'."\n" + .'> 在没有多台ECS同时编辑修改同一文件的场景时，推荐使用v3版本，性能更好', + 'type' => 'string', + 'required' => false, + 'example' => '-t nfs -o vers=3,nolock,proto=tcp,noresvport', + ], + 'Location' => [ + 'description' => '需要挂载的文件系统的存储位置。取值范围：'."\n" + .'- OnPremise：混合云集群。'."\n" + .'- PublicCloud：公有云集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'PublicCloud', + ], + 'VolumeType' => [ + 'description' => '要挂载的文件系统类型。取值范围：'."\n" + .'- nas'."\n" + .'- cpfs', + 'type' => 'string', + 'required' => true, + 'example' => 'nas', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F9B7BEF8-E42E-5090-9880-55FB7872****', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。可能值：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'VolumeNotFound', + 'errorMessage' => 'The specified volume does not exist.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'NasError', + 'errorMessage' => 'NAS API request failed.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product 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\\": \\"F9B7BEF8-E42E-5090-9880-55FB7872****\\",\\n \\"Success\\": \\"true\\",\\n \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\"\\n}","type":"json"}]', + 'title' => '挂载共享存储', + 'description' => '## 接口说明'."\n" + .'调用该接口时，您需要注意：'."\n" + ."\n" + .'- 已创建存储资源，且创建的文件系统必须与待挂载的集群处于同一VPC。具体操作，请参见[创建文件系统](~~27530~~)和[添加挂载点](~~27531~~)。'."\n" + .'- E-HPC集群支持挂载NAS<props="china">和CPFS</props>文件系统。', + ], + 'DetachSharedStorages' => [ + 'summary' => '卸载指定集群的挂载目录的共享存储资源。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '227345', + 'abilityTreeNodes' => [ + 'FEATUREehpcR3Y7DN', + ], + ], + 'parameters' => [ + [ + 'name' => 'SharedStorages', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '已挂载的共享存储列表。', + 'type' => 'array', + 'items' => [ + 'description' => '共享存储配置信息。', + 'type' => 'object', + 'properties' => [ + 'MountDirectory' => [ + 'description' => '挂载文件系统的本地挂载目录。', + 'type' => 'string', + 'required' => true, + 'example' => '/test', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。可能值：'."\n" + .'- true：成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'ClusterId' => [ + 'description' => '待查询的集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'VolumeNotFound', + 'errorMessage' => 'The specified volume does not exist.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'NasError', + 'errorMessage' => 'NAS API request failed.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product 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-6C044FE7****\\",\\n \\"Success\\": \\"true\\",\\n \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\"\\n}","type":"json"}]', + 'title' => '卸载共享存储', + ], + 'ListSoftwares' => [ + 'summary' => '查询E-HPC支持安装的软件列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227328', + 'abilityTreeNodes' => [ + 'FEATUREehpcL8RMWH', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '本页条数。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '指定集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + 'default' => '10', + ], + ], + [ + 'name' => 'OsInfos', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '操作系统信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OsTag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.9_64', + ], + 'Architecture' => [ + 'description' => '操作系统架构。可能值：'."\n" + .'- x86_64'."\n" + .'- arm64'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'x86_64', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '行业应用分类。', + 'type' => 'string', + 'required' => false, + 'example' => 'NWP', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '软件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'gromacs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页条数。', + 'type' => 'string', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'string', + 'example' => '2', + ], + 'AdditionalPackages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AdditionalPackageInfos' => [ + 'description' => '支持的软件数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '软件名称。', + 'type' => 'string', + 'example' => 'gromacs', + ], + 'Category' => [ + 'description' => '行业应用分类。', + 'type' => 'string', + 'example' => 'NWP', + ], + 'Icon' => [ + 'description' => '软件图标URL。', + 'type' => 'string', + 'example' => 'https://gw.alicdn.com/imgextra/i2/O1CN01FIkxZ81LmE0fvrAyR_!!6000000001341-55-tps-6349-1603.svg', + ], + 'Description' => [ + 'description' => '软件描述。', + 'type' => 'string', + 'example' => 'gromacs 2024.1版本', + ], + 'Versions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VersionInfos' => [ + 'description' => '支持的软件版本数组。', + 'type' => 'array', + 'items' => [ + 'description' => '软件信息列表。', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => '软件版本。', + 'type' => 'string', + 'example' => '2024.1', + ], + 'Latest' => [ + 'description' => '是否为最新版本。', + 'type' => 'string', + 'example' => 'false', + ], + 'SupportOs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportOsInfos' => [ + 'description' => '支持的操作系统数组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OsTag' => [ + 'description' => '镜像标签。', + 'type' => 'string', + 'example' => 'Alibaba Cloud Linux 3.2104 LTS 64 bit ARM Edition', + ], + 'Architecture' => [ + 'description' => '操作系统架构。可能值：'."\n" + .'- x86_64'."\n" + .'- arm64', + 'type' => 'string', + 'example' => 'x86_64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\",\\n \\"AdditionalPackages\\": {\\n \\"AdditionalPackageInfos\\": [\\n {\\n \\"Name\\": \\"gromacs\\",\\n \\"Category\\": \\"NWP\\",\\n \\"Icon\\": \\"https://gw.alicdn.com/imgextra/i2/O1CN01FIkxZ81LmE0fvrAyR_!!6000000001341-55-tps-6349-1603.svg\\",\\n \\"Description\\": \\"gromacs 2024.1版本\\",\\n \\"Versions\\": {\\n \\"VersionInfos\\": [\\n {\\n \\"Version\\": \\"2024.1\\",\\n \\"Latest\\": \\"false\\",\\n \\"SupportOs\\": {\\n \\"SupportOsInfos\\": [\\n {\\n \\"OsTag\\": \\"Alibaba Cloud Linux 3.2104 LTS 64 bit ARM Edition\\",\\n \\"Architecture\\": \\"x86_64\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询支持安装软件列表', + ], + 'ListSharedStorages' => [ + 'summary' => '查询指定集群下已挂载的共享存储信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228377', + 'abilityTreeNodes' => [ + 'FEATUREehpcR3Y7DN', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => '已挂载的文件系统类型。取值范围：'."\n" + .'- nas'."\n" + .'- cpfs', + 'type' => 'string', + 'required' => false, + 'example' => 'nas', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => '已挂载的文件系统ID。', + 'type' => 'string', + 'required' => false, + 'example' => '0bd504b0**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C084****', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。可能值：'."\n" + .'- true：成功'."\n" + .'- false：失败', + 'type' => 'string', + 'example' => 'true', + ], + 'SharedStorages' => [ + 'description' => '共享存储信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '共享存储信息配置。', + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '已挂载的文件系统ID。', + 'type' => 'string', + 'example' => '08c7f4b***', + ], + 'FileSystemType' => [ + 'description' => '已挂载的文件系统类型。可能值：'."\n" + .'- nas'."\n" + .'- cpfs', + 'type' => 'string', + 'example' => 'nas', + ], + 'MountInfo' => [ + 'description' => '挂载信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '挂载配置。', + 'type' => 'object', + 'properties' => [ + 'MountDirectory' => [ + 'description' => '挂载文件系统的本地挂载目录。', + 'type' => 'string', + 'example' => '/test', + ], + 'StorageDirectory' => [ + 'description' => '挂载文件系统的存储目录。', + 'type' => 'string', + 'example' => '/testehpc', + ], + 'MountOptions' => [ + 'description' => '已挂载文件系统的挂载选项。可能值：'."\n" + .'- -t nfs -o vers=3,nolock,proto=tcp,noresvport'."\n" + .'- -t nfs -o vers=4.0,noresvport', + 'type' => 'string', + 'example' => '-t nfs -o vers=4.0,noresvport', + ], + 'MountTarget' => [ + 'description' => '已挂载的文件系统挂载点地址。', + 'type' => 'string', + 'example' => '0bd504b***-ngq26.cn-hangzhou.nas.aliyuncs.com', + ], + 'ProtocolType' => [ + 'description' => '已挂载的文件系统挂载点的协议类型。可能值：'."\n" + .'- nfs3'."\n" + .'- nfs4'."\n" + .'- cpfs', + 'type' => 'string', + 'example' => 'nfs3', + ], + ], + ], + ], + 'FileSystemProtocol' => [ + 'description' => '已挂载的文件系统协议类型。可能值：'."\n" + .'- nfs3'."\n" + .'- nfs4'."\n" + .'- cpfs', + 'type' => 'string', + 'example' => 'nfs4', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F6757FA4-8FED-4602-B7F5-3550C084****\\",\\n \\"Success\\": \\"true\\",\\n \\"SharedStorages\\": [\\n {\\n \\"FileSystemId\\": \\"08c7f4b***\\",\\n \\"FileSystemType\\": \\"nas\\",\\n \\"MountInfo\\": [\\n {\\n \\"MountDirectory\\": \\"/test\\",\\n \\"StorageDirectory\\": \\"/testehpc\\",\\n \\"MountOptions\\": \\"-t nfs -o vers=4.0,noresvport\\",\\n \\"MountTarget\\": \\"0bd504b***-ngq26.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"ProtocolType\\": \\"nfs3\\"\\n }\\n ],\\n \\"FileSystemProtocol\\": \\"nfs4\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询共享存储列表', + ], + 'ListInstalledSoftwares' => [ + 'summary' => '查询集群已安装软件。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227332', + 'abilityTreeNodes' => [ + 'FEATUREehpcL8RMWH', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的本页条数。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => '显示的页码。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页条数。', + 'type' => 'string', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询结果条数。', + 'type' => 'string', + 'example' => '2', + ], + 'AdditionalPackages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AdditionalPackageInfos' => [ + 'description' => '安装的软件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '软件名称。', + 'type' => 'string', + 'example' => 'gromacs', + ], + 'Category' => [ + 'description' => '应用行业分类。', + 'type' => 'string', + 'example' => 'NWP', + ], + 'Icon' => [ + 'description' => '软件图标URL。', + 'type' => 'string', + 'example' => 'https://gw.alicdn.com/imgextra/i2/O1CN01FIkxZ81LmE0fvrAyR_!!6000000001341-55-tps-6349-1603.svg', + ], + 'Description' => [ + 'description' => '软件描述。', + 'type' => 'string', + 'example' => 'gromacs 2024.1版本', + ], + 'Version' => [ + 'description' => '软件版本。', + 'type' => 'string', + 'example' => '2024.1', + ], + 'Status' => [ + 'description' => '软件安装状态。'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Installed' => 'Installed', + 'Uninstalled' => 'Uninstalled', + 'Installing' => 'Installing', + 'Exception' => 'Exception', + ], + 'example' => 'Installed', + ], + 'CreateTime' => [ + 'description' => '软件安装时间。', + 'type' => 'string', + 'example' => '2024-03-05 18:24:08', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + [ + 'errorCode' => 'LoginNotFound', + 'errorMessage' => 'The specified login node 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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"2\\",\\n \\"AdditionalPackages\\": {\\n \\"AdditionalPackageInfos\\": [\\n {\\n \\"Name\\": \\"gromacs\\",\\n \\"Category\\": \\"NWP\\",\\n \\"Icon\\": \\"https://gw.alicdn.com/imgextra/i2/O1CN01FIkxZ81LmE0fvrAyR_!!6000000001341-55-tps-6349-1603.svg\\",\\n \\"Description\\": \\"gromacs 2024.1版本\\",\\n \\"Version\\": \\"2024.1\\",\\n \\"Status\\": \\"Installed\\",\\n \\"CreateTime\\": \\"2024-03-05 18:24:08\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询集群已安装软件', + ], + 'ListClusters' => [ + 'summary' => '查询用户账号中在每个地域拥有的所有集群的列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227335', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待查询集群ID。N的取值范围：0～20。', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-cn-wulanchabu-llsu******', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ClusterNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待查询的集群名称列表。N的取值范围：0～20。', + 'type' => 'array', + 'items' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'slurm22.05.8-cluster-20240802'."\n", + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的页码，默认值为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。 取值范围：10~100。 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Clusters' => [ + 'description' => '集群详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '集群信息。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-VMKe******', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'slurm22.05.8-cluster-20240227', + ], + 'ClusterDescription' => [ + 'description' => '集群描述。', + 'type' => 'string', + 'example' => 'Demo', + ], + 'ClusterCreateTime' => [ + 'description' => '集群的创建时间。以 ISO 8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。更多信息，请参见[ISO 8601](~~25696~~)。', + 'type' => 'string', + 'example' => '2024-08-06T12:43:01.000Z', + ], + 'ClusterModifyTime' => [ + 'description' => '集群的修改时间。以 ISO 8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。更多信息，请参见[ISO 8601](~~25696~~)。', + 'type' => 'string', + 'example' => '2024-08-06T12:43:01.000Z', + ], + 'ClusterCategory' => [ + 'description' => '集群系列，取值范围：'."\n" + .'- Standard'."\n" + ."\n" + .'- Serverless', + 'type' => 'string', + 'example' => 'Standard', + ], + 'ClusterStatus' => [ + 'description' => '集群状态。取值范围：'."\n" + ."\n" + .'- uninit：安装中。'."\n" + .'- creating：创建中。'."\n" + .'- initing：初始化中。'."\n" + .'- running：运行中。'."\n" + .'- releasing：释放中。'."\n" + .'- stopping：停止中。'."\n" + .'- stopped：已停止。'."\n" + .'- exception：异常。'."\n" + .'- pending：待配置。', + 'type' => 'string', + 'example' => 'running', + ], + 'ClusterVpcId' => [ + 'description' => '集群使用的专有网络 VPC ID。', + 'type' => 'string', + 'example' => 'vpc-m5efjevmclc0xdmys****'."\n", + ], + 'ClusterVSwitchId' => [ + 'description' => '集群使用的虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-f8za5p0mwzgdu3wgx****'."\n", + ], + 'SecurityGroupId' => [ + 'description' => '集群使用的安全组ID。', + 'type' => 'string', + 'example' => 'sg-bp13n61xsydodfyg****'."\n", + ], + 'ClusterCustomConfiguration' => [ + 'description' => '集群使用的后处理脚本。', + 'type' => 'object', + 'properties' => [ + 'Script' => [ + 'description' => '集群后处理脚本的链接。', + 'type' => 'string', + 'example' => 'https://xxxxx', + ], + 'Args' => [ + 'description' => '集群后处理脚本的参数。', + 'type' => 'string', + 'example' => 'demo', + ], + ], + ], + 'MaxCount' => [ + 'description' => '集群可管理的计算节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'MaxCoreCount' => [ + 'description' => '集群可管理的计算节点总核数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'DeletionProtection' => [ + 'description' => '集群是否开启删除保护。取值范围：'."\n" + ."\n" + .'- true：启动删除保护。'."\n" + .'- false：不启用删除保护。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxazb4ph****', + ], + 'Manager' => [ + 'description' => '集群管理节点配置。', + 'type' => 'object', + 'properties' => [ + 'Scheduler' => [ + 'description' => '调度器服务配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '调度器类型。', + 'type' => 'string', + 'example' => 'SLURM', + ], + 'Version' => [ + 'description' => '调度器版本。', + 'type' => 'string', + 'example' => '22.05.8'."\n", + ], + ], + ], + 'DirectoryService' => [ + 'description' => '域账号服务配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '域账号类型。', + 'type' => 'string', + 'example' => 'NIS', + ], + 'Version' => [ + 'description' => '域账号版本。', + 'type' => 'string', + 'example' => '2.31'."\n", + ], + ], + ], + 'DNS' => [ + 'description' => '域名解析服务配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '域名解析类型。', + 'type' => 'string', + 'example' => 'NIS', + ], + 'Version' => [ + 'description' => '域名解析版本。', + 'type' => 'string', + 'example' => '2.31', + ], + ], + ], + ], + ], + 'EhpcVersion' => [ + 'description' => 'E-HPC产品集群的版本。', + 'type' => 'string', + 'example' => '2.0.0', + ], + 'Nodes' => [ + 'description' => '集群的节点数量信息。', + 'type' => 'object', + 'properties' => [ + 'RunningCounts' => [ + 'description' => '运行中的计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AbnormalCounts' => [ + 'description' => '异常的计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatingCounts' => [ + 'description' => '创建中的计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'Users' => [ + 'description' => '集群的用户属性信息。', + 'type' => 'object', + 'properties' => [ + 'SudoCounts' => [ + 'description' => '管理员用户数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NormalCounts' => [ + 'description' => '普通用户数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'AdditionalPackages' => [ + 'description' => '集群安装的软件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '软件信息详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '软件名称。', + 'type' => 'string', + 'example' => 'gromacs', + ], + 'Version' => [ + 'description' => '软件版本。', + 'type' => 'string', + 'example' => '2024.1', + ], + ], + ], + ], + 'Addons' => [ + 'description' => '集群自定义服务组件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义服务组件详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '自定义服务组件的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => '自定义服务组件的版本。', + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'Label' => [ + 'description' => '自定义服务组件标签。', + 'type' => 'string', + 'example' => '登录节点'."\n", + ], + 'AddonId' => [ + 'description' => '自定义服务组件ID。', + 'type' => 'string', + 'example' => 'Login-1.0-W2g****'."\n", + ], + 'Description' => [ + 'description' => '自定义服务组件描述。', + 'type' => 'string', + 'example' => '登录节点，主要用于E-HPC集群环境的连接登录及用户任务的提交。'."\n", + ], + 'Status' => [ + 'description' => '自定义服务组件状态。', + 'type' => 'string', + 'example' => 'Running'."\n", + ], + 'ServicesSpec' => [ + 'description' => '组件服务配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务配置详情。', + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Web Portal'."\n", + ], + 'ServiceAccessType' => [ + 'description' => '服务访问类型。', + 'type' => 'string', + 'example' => 'URL', + ], + 'ServiceAccessUrl' => [ + 'description' => '服务访问Url。', + 'type' => 'string', + 'example' => 'https://47.96.xx.xx:12008'."\n", + ], + ], + ], + ], + 'ResourcesSpec' => [ + 'description' => '组件资源配置信息。', + 'type' => 'object', + 'properties' => [ + 'EipInstanceId' => [ + 'description' => '弹性公网IP ID。', + 'type' => 'string', + 'example' => 'eip-bp1vi9124tbx1g3kr****'."\n", + ], + 'EcsInstanceId' => [ + 'description' => '组件实例ID。', + 'type' => 'string', + 'example' => 'i-bp1bg85d2q6laic8****', + ], + ], + ], + ], + ], + ], + 'ClusterUsedCoreTime' => [ + 'description' => '集群已用核时信息。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1000', + ], + 'ClusterMode' => [ + 'description' => '集群的部署类型。可能值：'."\n" + .'- Integrated：公共云'."\n" + .'- Hybrid：混合云'."\n" + .'- Custom：自定义集群', + 'type' => 'string', + 'example' => 'Integrated', + ], + 'ClusterCredentials' => [ + 'description' => '集群登录凭证的类型。取值范围：'."\n" + ."\n" + .'- password：使用密码登录集群。'."\n" + .'- keypair：使用密钥对登录集群。', + 'type' => 'array', + 'items' => [ + 'description' => '凭证类型。', + 'type' => 'string', + 'example' => 'password', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 407 => [ + [ + '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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 2,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": 10,\\n \\"Clusters\\": [\\n {\\n \\"ClusterId\\": \\"ehpc-hz-VMKe******\\",\\n \\"ClusterName\\": \\"slurm22.05.8-cluster-20240227\\",\\n \\"ClusterDescription\\": \\"Demo\\",\\n \\"ClusterCreateTime\\": \\"2024-08-06T12:43:01.000Z\\",\\n \\"ClusterModifyTime\\": \\"2024-08-06T12:43:01.000Z\\",\\n \\"ClusterCategory\\": \\"Standard\\",\\n \\"ClusterStatus\\": \\"running\\",\\n \\"ClusterVpcId\\": \\"vpc-m5efjevmclc0xdmys****\\\\n\\",\\n \\"ClusterVSwitchId\\": \\"vsw-f8za5p0mwzgdu3wgx****\\\\n\\",\\n \\"SecurityGroupId\\": \\"sg-bp13n61xsydodfyg****\\\\n\\",\\n \\"ClusterCustomConfiguration\\": {\\n \\"Script\\": \\"https://xxxxx\\",\\n \\"Args\\": \\"demo\\"\\n },\\n \\"MaxCount\\": 500,\\n \\"MaxCoreCount\\": 10000,\\n \\"DeletionProtection\\": true,\\n \\"ResourceGroupId\\": \\"rg-acfmxazb4ph****\\",\\n \\"Manager\\": {\\n \\"Scheduler\\": {\\n \\"Type\\": \\"SLURM\\",\\n \\"Version\\": \\"22.05.8\\\\n\\"\\n },\\n \\"DirectoryService\\": {\\n \\"Type\\": \\"NIS\\",\\n \\"Version\\": \\"2.31\\\\n\\"\\n },\\n \\"DNS\\": {\\n \\"Type\\": \\"NIS\\",\\n \\"Version\\": \\"2.31\\"\\n }\\n },\\n \\"EhpcVersion\\": \\"2.0.0\\",\\n \\"Nodes\\": {\\n \\"RunningCounts\\": 1,\\n \\"AbnormalCounts\\": 0,\\n \\"CreatingCounts\\": 0\\n },\\n \\"Users\\": {\\n \\"SudoCounts\\": 2,\\n \\"NormalCounts\\": 2\\n },\\n \\"AdditionalPackages\\": [\\n {\\n \\"Name\\": \\"gromacs\\",\\n \\"Version\\": \\"2024.1\\"\\n }\\n ],\\n \\"Addons\\": [\\n {\\n \\"Name\\": \\"Login\\",\\n \\"Version\\": \\"1.0\\",\\n \\"Label\\": \\"登录节点\\\\n\\",\\n \\"AddonId\\": \\"Login-1.0-W2g****\\\\n\\",\\n \\"Description\\": \\"登录节点，主要用于E-HPC集群环境的连接登录及用户任务的提交。\\\\n\\",\\n \\"Status\\": \\"Running\\\\n\\",\\n \\"ServicesSpec\\": [\\n {\\n \\"ServiceName\\": \\"Web Portal\\\\n\\",\\n \\"ServiceAccessType\\": \\"URL\\",\\n \\"ServiceAccessUrl\\": \\"https://47.96.xx.xx:12008\\\\n\\"\\n }\\n ],\\n \\"ResourcesSpec\\": {\\n \\"EipInstanceId\\": \\"eip-bp1vi9124tbx1g3kr****\\\\n\\",\\n \\"EcsInstanceId\\": \\"i-bp1bg85d2q6laic8****\\"\\n }\\n }\\n ],\\n \\"ClusterUsedCoreTime\\": 1000,\\n \\"ClusterMode\\": \\"Integrated\\",\\n \\"ClusterCredentials\\": [\\n \\"password\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群列表', + ], + 'ListAvailableImages' => [ + 'summary' => '获取E-HPC集群可用镜像列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ImageOwnerAlias', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像来源。取值范围：'."\n" + .'- system：系统镜像。'."\n" + .'- self：自定义镜像。'."\n" + .'- others：共享镜像。', + 'type' => 'string', + 'required' => false, + 'example' => 'self', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定查询的实例规格。'."\n" + ."\n" + .'>如果不指定实例规格，则默认查询所有实例规格支持的镜像列表。更多信息，请参见[ECS实例规格族](~~25378~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c7.large', + ], + ], + [ + 'name' => 'IsPublic', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询已发布的社区镜像。取值范围：'."\n" + ."\n" + .'- true：查询已发布的社区镜像。当您指定该参数值为`true`时，`ImageOwnerAlias`必须为`others`。'."\n" + .'- false：查询除社区镜像的其他镜像类型，具体以`ImageOwnerAlias`参数值为准。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'HPCInterConnect', + 'in' => 'query', + 'schema' => [ + 'description' => '网络互联类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + ], + [ + 'name' => 'EnableHT', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启超线程。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Scheduler', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '调度器详细信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '调度器类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'SLURM', + ], + 'Version' => [ + 'description' => '调度器版本。', + 'type' => 'string', + 'required' => false, + 'example' => '22.05.8', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DirectoryService', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '域账户服务详细信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '域账户类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'NIS', + ], + 'Version' => [ + 'description' => '域账户版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。 取值范围：1~50。 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'title' => 'Id of the request', + 'description' => '返回条目数量。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'Id of the request', + 'description' => '每页行数。', + 'type' => 'string', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => 'Id of the request', + 'description' => '当前页码。'."\n" + ."\n" + .'- 起始值为 1。'."\n" + .'- 默认值为 1。', + 'type' => 'string', + 'example' => '1', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。可能值：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Images' => [ + 'description' => '镜像信息。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像信息。', + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'centos_7_06_64_20G_alibase_2019071****', + ], + 'OSNameEn' => [ + 'description' => '操作系统的英文名称。', + 'type' => 'string', + 'example' => 'CentOS 7.9 64 bit', + ], + 'ImageOwnerAlias' => [ + 'description' => '镜像来源。可能值：'."\n" + ."\n" + .'- system：系统镜像。'."\n" + ."\n" + .'- self：自定义镜像。'."\n" + ."\n" + .'- others：共享镜像。', + 'type' => 'string', + 'example' => 'self', + ], + 'Description' => [ + 'description' => '镜像描述。', + 'type' => 'string', + 'example' => 'ExampleDescription', + ], + 'Size' => [ + 'description' => '镜像大小。单位：GiB', + 'type' => 'string', + 'example' => '40', + ], + 'Platform' => [ + 'description' => '操作系统平台。可能值：'."\n" + .'- CentOS'."\n" + .'- windows', + 'type' => 'string', + 'example' => 'windows', + ], + 'OSName' => [ + 'description' => '操作系统的中文名称。', + 'type' => 'string', + 'example' => 'CentOS 7.9 64位', + ], + 'Architecture' => [ + 'description' => '操作系统架构。可能值：'."\n" + .'- x86_64'."\n" + .'- arm64', + 'type' => 'string', + 'example' => 'x86_64', + ], + 'BootMode' => [ + 'description' => '镜像的启动模式。可能值：'."\n" + ."\n" + .'- BIOS：BIOS启动模式。'."\n" + .'- UEFI：UEFI启动模式。'."\n" + ."\n" + .'> 您需要了解指定的镜像支持的启动模式，当通过该参数修改启动模式后，必须与镜像本身支持的启动模式匹配，实例才能正常启动。', + 'type' => 'string', + 'example' => 'BIOS', + ], + 'ImageName' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'CHESS5V5.0.27', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 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 \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"20\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Success\\": true,\\n \\"Images\\": [\\n {\\n \\"ImageId\\": \\"centos_7_06_64_20G_alibase_2019071****\\",\\n \\"OSNameEn\\": \\"CentOS 7.9 64 bit\\",\\n \\"ImageOwnerAlias\\": \\"self\\",\\n \\"Description\\": \\"ExampleDescription\\",\\n \\"Size\\": \\"40\\",\\n \\"Platform\\": \\"windows\\",\\n \\"OSName\\": \\"CentOS 7.9 64位\\",\\n \\"Architecture\\": \\"x86_64\\",\\n \\"BootMode\\": \\"BIOS\\",\\n \\"ImageName\\": \\"CHESS5V5.0.27\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询可用镜像列表', + ], + 'ListAvailableFileSystems' => [ + 'summary' => '查询指定地域可挂载的文件系统列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227344', + 'abilityTreeNodes' => [ + 'FEATUREehpcR3Y7DN', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。 起始值：1。 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页行数。 取值范围：1~50。 默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BF4E8AB1-02A3-5ECF-87CC-3AB7BE98**', + ], + 'TotalCount' => [ + 'description' => '列表总条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '65', + ], + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FileSystemList' => [ + 'description' => '文件系统列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件系统信息。', + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => '文件系统ID。', + 'type' => 'string', + 'example' => '2fa0248***', + ], + 'FileSystemType' => [ + 'description' => '文件系统类型。可能值：'."\n" + .'- standard：通用型 NAS'."\n" + .'- extreme：极速型 NAS'."\n" + ."\n" + .'<props="china">'."\n" + ."\n" + .'- cpfs：CPFS'."\n" + ."\n" + .'</props>', + 'type' => 'string', + 'example' => 'cpfs', + ], + 'Status' => [ + 'description' => '文件系统状态。可能值：'."\n" + .'- Pending：当前文件系统正在处理任务中。'."\n" + .'- Running：当前文件系统可用，当状态为 Running 时才可以进行后续操作（例如：创建挂载点等）。'."\n" + .'- Stopped：当前文件系统不可用。'."\n" + .'- Extending：当前文件系统扩容中。'."\n" + .'- Stopping：当前文件系统停机中。'."\n" + .'- Deleting：当前文件系统删除中。', + 'type' => 'string', + 'example' => 'Running', + ], + 'ProtocolType' => [ + 'description' => '文件系统的协议类型。可能值：'."\n" + .'- nfs'."\n" + .'- smb'."\n" + .'- cpfs', + 'type' => 'string', + 'example' => 'cpfs', + ], + 'CreateTime' => [ + 'description' => '文件系统创建时间。', + 'type' => 'string', + 'example' => '2024-7-29 15:43:53', + ], + 'MountTargetList' => [ + 'description' => '文件系统挂载点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '文件系统挂载点信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-8vbvb34rtyh6xb3zrehs1****', + ], + 'MountTargetDomain' => [ + 'description' => '文件系统挂载点地址。', + 'type' => 'string', + 'example' => 'c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com', + ], + 'Status' => [ + 'description' => '挂载点状态。可能值：'."\n" + .'- Active：可用'."\n" + .'- Inactive：不可用'."\n" + .'- Pending：挂载中'."\n" + .'- Deleting：删除中', + 'type' => 'string', + 'example' => 'Active', + ], + 'VSwitchId' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-2ze0c41hwu7lc29ris***', + ], + 'NetworkType' => [ + 'description' => '网络类型。可能值：'."\n" + .'- vpc：专有网络', + 'type' => 'string', + 'example' => 'vpc', + ], + ], + ], + ], + 'StorageType' => [ + 'description' => '存储规格类型。'."\n" + ."\n" + .'- 当FileSystemType为standard时，可能值：Capacity（容量型）、Performance（性能型）'."\n" + .'- 当FileSystemType为extreme时，可能值：standard（标准型）、advance（高级型）'."\n" + .'<props="china">'."\n" + .'- 当FileSystemType为CPFS时，可能值：advance_100（100MB/s/TiB基线）、advance_200（200MB/s/TiB基线）</props>', + 'type' => 'string', + 'example' => 'Performance', + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp132kgui8n0targb****', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product 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\\": \\"BF4E8AB1-02A3-5ECF-87CC-3AB7BE98**\\",\\n \\"TotalCount\\": 65,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"FileSystemList\\": [\\n {\\n \\"FileSystemId\\": \\"2fa0248***\\",\\n \\"FileSystemType\\": \\"cpfs\\",\\n \\"Status\\": \\"Running\\",\\n \\"ProtocolType\\": \\"cpfs\\",\\n \\"CreateTime\\": \\"2024-7-29 15:43:53\\",\\n \\"MountTargetList\\": [\\n {\\n \\"VpcId\\": \\"vpc-8vbvb34rtyh6xb3zrehs1****\\",\\n \\"MountTargetDomain\\": \\"c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com\\",\\n \\"Status\\": \\"Active\\",\\n \\"VSwitchId\\": \\"vsw-2ze0c41hwu7lc29ris***\\",\\n \\"NetworkType\\": \\"vpc\\"\\n }\\n ],\\n \\"StorageType\\": \\"Performance\\",\\n \\"VpcId\\": \\"vpc-bp132kgui8n0targb****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询挂载的文件系统列表', + ], + 'ListAddons' => [ + 'summary' => '查看已安装的自定义服务组件列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228012', + 'abilityTreeNodes' => [ + 'FEATUREehpcXOL4GQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AddonIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义服务组件ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义服务组件ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'Login-1.0-W4g****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求下的总条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '当前页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '分页查询时设置的每页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Addons' => [ + 'title' => 'Addons', + 'description' => '自定义服务组件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义服务组件。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '自定义服务组件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => '自定义服务组件版本。', + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'AddonId' => [ + 'description' => '自定义服务组件ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login-1.0-W4g****'."\n", + ], + 'Label' => [ + 'description' => '自定义服务组件标签。', + 'type' => 'string', + 'example' => '登录节点。', + ], + 'Description' => [ + 'description' => '自定义服务组件描述。', + 'type' => 'string', + 'example' => '登录节点，主要用于E-HPC集群环境的连接登录及用户任务的提交。', + ], + 'InstallTime' => [ + 'description' => '自定义服务组件安装日期。', + 'type' => 'string', + 'example' => '2024-08-22 18:11:17', + ], + 'Status' => [ + 'description' => '自定义服务组件状态。', + 'type' => 'string', + 'example' => 'Running', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 20,\\n \\"Addons\\": [\\n {\\n \\"Name\\": \\"Login\\",\\n \\"Version\\": \\"1.0\\",\\n \\"AddonId\\": \\"Login-1.0-W4g****\\\\n\\",\\n \\"Label\\": \\"登录节点。\\",\\n \\"Description\\": \\"登录节点，主要用于E-HPC集群环境的连接登录及用户任务的提交。\\",\\n \\"InstallTime\\": \\"2024-08-22 18:11:17\\",\\n \\"Status\\": \\"Running\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询已安装组件列表', + ], + 'ListAddonTemplates' => [ + 'summary' => '查询支持的自定义服务组件模板列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREehpcL8RMWH', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页序号，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页大小，默认值20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'AddonNames', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '自定义服务组件名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义服务组件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Login', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '集群系列，取值范围：'."\n" + ."\n" + .'- Standard'."\n" + .'- Serverless', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求下的总条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '本次请求所返回的最大记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Addons' => [ + 'title' => 'Addons', + 'description' => '自定义服务组件模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义服务组件模板信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '自定义服务组件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => '自定义服务组件版本。', + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'Label' => [ + 'description' => '自定义服务组件标签。', + 'type' => 'string', + 'example' => '登录节点', + ], + 'Description' => [ + 'description' => '自定义服务组件描述。', + 'type' => 'string', + 'example' => '登录节点，主要用于E-HPC集群环境的连接登录及用户任务的提交。', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Addons\\": [\\n {\\n \\"Name\\": \\"Login\\",\\n \\"Version\\": \\"1.0\\",\\n \\"Label\\": \\"登录节点\\",\\n \\"Description\\": \\"登录节点，主要用于E-HPC集群环境的连接登录及用户任务的提交。\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询组件模板列表', + ], + 'GetCluster' => [ + 'summary' => '查询指定E-HPC集群信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227340', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => 'E-HPC集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ClusterId' => [ + 'title' => 'E-HPC集群ID', + 'description' => 'E-HPC集群ID', + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'ClusterName' => [ + 'title' => 'E-HPC集群名称', + 'description' => 'E-HPC集群名称', + 'type' => 'string', + 'example' => 'slurm22.05.8-cluster-20240614', + ], + 'ClusterCategory' => [ + 'title' => '', + 'description' => '集群系列，可能值：'."\n" + .'- Standard'."\n" + ."\n" + .'- Serverless', + 'type' => 'string', + 'example' => 'Standard', + ], + 'MaxCount' => [ + 'description' => '集群可管理的计算节点数量。', + 'type' => 'string', + 'example' => '100', + ], + 'MaxCoreCount' => [ + 'description' => '集群可管理的计算节点总核数。', + 'type' => 'string', + 'example' => '10000', + ], + 'DeleteProtection' => [ + 'description' => '集群是否开启删除保护。可能值：'."\n" + ."\n" + .'- true：启动删除保护。'."\n" + .'- false：不启用删除保护。', + 'type' => 'string', + 'example' => 'true', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxazb4ph****', + ], + 'ClusterCreateTime' => [ + 'description' => '集群的创建时间。以 ISO 8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。更多信息，请参见[ISO 8601](~~25696~~)。', + 'type' => 'string', + 'example' => '2024-08-06T12:43:01.000Z'."\n", + ], + 'ClusterModifyTime' => [ + 'description' => '集群的修改时间。以 ISO 8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。更多信息，请参见[ISO 8601](~~25696~~)。', + 'type' => 'string', + 'example' => '2024-08-06T12:43:01.000Z'."\n", + ], + 'ClusterVpcId' => [ + 'description' => '集群使用的专有网络 VPC ID。', + 'type' => 'string', + 'example' => 'vpc-uf6u3lk1pjy28eg*****', + ], + 'ClusterVSwitchId' => [ + 'description' => '集群使用的虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1p2uugqsjppno******', + ], + 'SecurityGroupId' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-f8z9vb2zaezpkr69a21k', + ], + 'EhpcVersion' => [ + 'description' => 'E-HPC产品版本号。', + 'type' => 'string', + 'example' => '2.0.0', + ], + 'ClientVersion' => [ + 'description' => '集群使用的E-HPC Util版本。', + 'type' => 'string', + 'example' => '2.0.31', + ], + 'ClusterStatus' => [ + 'description' => '集群状态。可能值：'."\n" + .'- uninit：安装中'."\n" + .'- creating：创建中'."\n" + .'- initing：初始化中'."\n" + .'- running；运行中'."\n" + .'- exception：异常'."\n" + .'- raleasing：释放中'."\n" + .'- stopping：停止中'."\n" + .'- stopped：已停止'."\n" + .'- pending：待配置', + 'type' => 'string', + 'example' => 'running', + ], + 'ClusterMode' => [ + 'description' => '集群的部署类型。可能值：'."\n" + .'- Integrated：公共云'."\n" + .'- Hybrid：混合云'."\n" + .'- Custom：自定义集群', + 'type' => 'string', + 'example' => 'Integrated', + ], + 'Manager' => [ + 'description' => '集群管理节点配置。', + 'type' => 'object', + 'properties' => [ + 'Scheduler' => [ + 'description' => '调度器服务信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '调度器类型。可能值：'."\n" + .'- SLURM'."\n" + .'- PBS'."\n" + .'- OPENGRIDSCHEDULER'."\n" + .'- LSF_PLUGIN'."\n" + .'- PBS_PLUGIN', + 'type' => 'string', + 'example' => 'SLURM', + ], + 'Version' => [ + 'description' => '调度器版本。', + 'type' => 'string', + 'example' => '22.05.8', + ], + 'Status' => [ + 'description' => '调度器服务状态，可能值：'."\n" + .'- uninit：安装中'."\n" + .'- initing：初始化中'."\n" + .'- running：运行中'."\n" + .'- exception：异常'."\n" + .'- releasing：释放中'."\n" + .'- stopped：已停止'."\n" + .'- pending：待配置', + 'type' => 'string', + 'example' => 'running', + ], + ], + ], + 'DirectoryService' => [ + 'description' => '域账号服务信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '域账号类型。', + 'type' => 'string', + 'example' => 'nis', + ], + 'Version' => [ + 'description' => '域账号版本。', + 'type' => 'string', + 'example' => '2.31', + ], + 'Status' => [ + 'description' => '域账号服务状态，可能值：'."\n" + ."\n" + .'- uninit：安装中'."\n" + .'- initing：初始化中'."\n" + .'- running：运行中'."\n" + .'- exception：异常'."\n" + .'- releasing：释放中'."\n" + .'- stopped：已停止'."\n" + .'- pending：待配置', + 'type' => 'string', + 'example' => 'running', + ], + ], + ], + 'DNS' => [ + 'description' => '域名解析服务配置信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '域名解析类型。', + 'type' => 'string', + 'example' => 'nis', + ], + 'Version' => [ + 'description' => '域名解析版本。', + 'type' => 'string', + 'example' => '2.31', + ], + 'Status' => [ + 'description' => '域名解析服务状态，可能值：'."\n" + ."\n" + .'- uninit：安装中'."\n" + .'- initing：初始化中'."\n" + .'- running：运行中'."\n" + .'- exception：异常'."\n" + .'- releasing：释放中'."\n" + .'- stopped：已停止'."\n" + .'- pending：待配置', + 'type' => 'string', + 'example' => 'running', + ], + ], + ], + 'ManagerNode' => [ + 'description' => '管理节点的配置信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '管理节点实例ID。', + 'type' => 'string', + 'example' => 'i-bp1a170jgea1vl******', + ], + 'InstanceType' => [ + 'description' => '管控节点实例规格。', + 'type' => 'string', + 'example' => 'ecs.g6.4xlarge', + ], + 'InstanceChargeType' => [ + 'description' => '管理节点的实例付费类型。可能值：'."\n" + ."\n" + .'- PostPaid：按量付费'."\n" + .'- PrePaid：包年包月', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'ExpiredTime' => [ + 'description' => '管理节点的过期时间。', + 'type' => 'string', + 'example' => '2099-12-31T15:59Z', + ], + 'ImageId' => [ + 'title' => '集群管理节点使用的镜像ID。', + 'description' => '集群管理节点使用的镜像ID。', + 'type' => 'string', + 'example' => 'aliyun_2_1903_x64_20G_alibase_20200324.vhd', + ], + 'PeriodUnit' => [ + 'title' => '集群管理节点包年包月计费方式的时长单位。', + 'description' => '集群管理节点包年包月计费方式的时长单位。', + 'type' => 'string', + 'example' => 'Month', + ], + 'Period' => [ + 'title' => '集群管理节点包年包月付费类型是否开启自动续费。', + 'description' => '集群管理节点包年包月付费类型是否开启自动续费。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AutoRenew' => [ + 'title' => '集群管理节点包你那包月付费类型是否开启自动续费。', + 'description' => '集群管理节点包你那包月付费类型是否开启自动续费。', + 'type' => 'boolean', + 'default' => 'false', + ], + 'AutoRenewPeriod' => [ + 'title' => '集群管理节点包年包月付费类型单词自动续费的续费时长。', + 'description' => '集群管理节点包年包月付费类型单词自动续费的续费时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'Month', + ], + 'SpotStrategy' => [ + 'title' => '集群管理节点按量付费的竞价策略。', + 'description' => '集群管理节点按量付费的竞价策略。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'SpotPriceLimit' => [ + 'title' => '集群管理节点抢占式实例的每小时最高价格。', + 'description' => '集群管理节点抢占式实例的每小时最高价格。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Duration' => [ + 'title' => '集群管理节点抢占式实例的保有时长。', + 'description' => '集群管理节点抢占式实例的保有时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'EnableHt' => [ + 'title' => '集群管理节点是否开启HT。', + 'description' => '集群管理节点是否开启HT。', + 'type' => 'boolean', + ], + 'SystemDisk' => [ + 'title' => '集群管理节点的系统盘配置。', + 'description' => '集群管理节点的系统盘配置。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => '集群管理节点系统盘的云盘种类。', + 'description' => '集群管理节点系统盘的云盘种类。', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'Size' => [ + 'title' => '集群管理节点系统盘的大小，单位是GiB。', + 'description' => '集群管理节点系统盘的大小，单位是GiB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + ], + 'Level' => [ + 'title' => '集群管理节点ESSD系统盘的性能等级。', + 'description' => '集群管理节点ESSD系统盘的性能等级。', + 'type' => 'string', + 'example' => 'PL0', + ], + ], + ], + ], + ], + ], + ], + 'ClusterCustomConfiguration' => [ + 'description' => '集群后处理脚本。', + 'type' => 'object', + 'properties' => [ + 'Script' => [ + 'description' => '后处理脚本的下载地址。', + 'type' => 'string', + 'example' => 'http://*****'."\n", + ], + 'Args' => [ + 'description' => '安装后脚本的执行参数。', + 'type' => 'string', + 'example' => 'E-HPC cn-hangzhou'."\n", + ], + ], + ], + 'GrowInterval' => [ + 'description' => '集群自动扩容的时间间隔。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'IdleInterval' => [ + 'description' => '集群计算节点的空闲时间。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'EnableScaleOut' => [ + 'description' => '集群是否开启自动扩容。可选值：'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableScaleIn' => [ + 'description' => '集群是否开启自动缩容，可能值：'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MonitorSpec' => [ + 'description' => '集群监控详情。', + 'type' => 'object', + 'properties' => [ + 'EnableComputeLoadMonitor' => [ + 'description' => '集群是否开启计算节点的监控组件，可能值：'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'SchedulerSpec' => [ + 'description' => '集群调度详情。', + 'type' => 'object', + 'properties' => [ + 'EnableTopologyAwareness' => [ + 'description' => '集群是否开启拓扑感知功能，可能值：'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnablePowerSaving' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 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 \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\",\\n \\"ClusterName\\": \\"slurm22.05.8-cluster-20240614\\",\\n \\"ClusterCategory\\": \\"Standard\\",\\n \\"MaxCount\\": \\"100\\",\\n \\"MaxCoreCount\\": \\"10000\\",\\n \\"DeleteProtection\\": \\"true\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxazb4ph****\\",\\n \\"ClusterCreateTime\\": \\"2024-08-06T12:43:01.000Z\\\\n\\",\\n \\"ClusterModifyTime\\": \\"2024-08-06T12:43:01.000Z\\\\n\\",\\n \\"ClusterVpcId\\": \\"vpc-uf6u3lk1pjy28eg*****\\",\\n \\"ClusterVSwitchId\\": \\"vsw-bp1p2uugqsjppno******\\",\\n \\"SecurityGroupId\\": \\"sg-f8z9vb2zaezpkr69a21k\\",\\n \\"EhpcVersion\\": \\"2.0.0\\",\\n \\"ClientVersion\\": \\"2.0.31\\",\\n \\"ClusterStatus\\": \\"running\\",\\n \\"ClusterMode\\": \\"Integrated\\",\\n \\"Manager\\": {\\n \\"Scheduler\\": {\\n \\"Type\\": \\"SLURM\\",\\n \\"Version\\": \\"22.05.8\\",\\n \\"Status\\": \\"running\\"\\n },\\n \\"DirectoryService\\": {\\n \\"Type\\": \\"nis\\",\\n \\"Version\\": \\"2.31\\",\\n \\"Status\\": \\"running\\"\\n },\\n \\"DNS\\": {\\n \\"Type\\": \\"nis\\",\\n \\"Version\\": \\"2.31\\",\\n \\"Status\\": \\"running\\"\\n },\\n \\"ManagerNode\\": {\\n \\"InstanceId\\": \\"i-bp1a170jgea1vl******\\",\\n \\"InstanceType\\": \\"ecs.g6.4xlarge\\",\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"ExpiredTime\\": \\"2099-12-31T15:59Z\\",\\n \\"ImageId\\": \\"aliyun_2_1903_x64_20G_alibase_20200324.vhd\\",\\n \\"PeriodUnit\\": \\"Month\\",\\n \\"Period\\": 1,\\n \\"AutoRenew\\": true,\\n \\"AutoRenewPeriod\\": 0,\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"SpotPriceLimit\\": 1,\\n \\"Duration\\": 1,\\n \\"EnableHt\\": true,\\n \\"SystemDisk\\": {\\n \\"Category\\": \\"cloud_ssd\\",\\n \\"Size\\": 40,\\n \\"Level\\": \\"PL0\\"\\n }\\n }\\n },\\n \\"ClusterCustomConfiguration\\": {\\n \\"Script\\": \\"http://*****\\\\n\\",\\n \\"Args\\": \\"E-HPC cn-hangzhou\\\\n\\"\\n },\\n \\"GrowInterval\\": 2,\\n \\"IdleInterval\\": 4,\\n \\"EnableScaleOut\\": true,\\n \\"EnableScaleIn\\": true,\\n \\"MonitorSpec\\": {\\n \\"EnableComputeLoadMonitor\\": true\\n },\\n \\"SchedulerSpec\\": {\\n \\"EnableTopologyAwareness\\": true,\\n \\"EnablePowerSaving\\": true\\n }\\n}","type":"json"}]', + 'title' => '查询集群详情', + ], + 'GetAddon' => [ + 'summary' => '查询已安装的自定义服务组件详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228026', + 'abilityTreeNodes' => [ + 'FEATUREehpcXOL4GQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AddonId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义服务组件ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login-1.0-W4g****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BBC2F93D-003A-49C4-850C-B826EECF****', + ], + 'Addon' => [ + 'title' => 'Addon', + 'description' => '自定义服务组件。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '自定义服务组件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => '自定义服务组件版本。', + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'AddonId' => [ + 'description' => '自定义服务组件ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login-1.0-W2g****', + ], + 'Label' => [ + 'description' => '自定义服务组件标签。', + 'type' => 'string', + 'example' => '登录节点', + ], + 'Description' => [ + 'description' => '自定义服务组件描述。', + 'type' => 'string', + 'example' => '登录节点，主要用于E-HPC集群环境的连接登录及用户任务的提交。', + ], + 'Icon' => [ + 'description' => '自定义服务组件图标。', + 'type' => 'string', + 'example' => '/assets/icons/your_icon.svg'."\n", + ], + 'InstallTime' => [ + 'description' => '自定义服务组件安装日期。', + 'type' => 'string', + 'example' => '2024-08-22 18:11:17'."\n", + ], + 'Status' => [ + 'description' => '自定义服务组件状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'ServicesSpec' => [ + 'description' => '组件服务配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务配置详情。', + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Web Portal', + ], + 'ServiceAccessType' => [ + 'description' => '服务访问类型。', + 'type' => 'string', + 'example' => 'URL', + ], + 'ServiceAccessUrl' => [ + 'description' => '服务访问Url。', + 'type' => 'string', + 'example' => 'https://47.96.xx.xx:12008', + ], + 'InputParams' => [ + 'description' => '服务参数配置。', + 'type' => 'array', + 'items' => [ + 'description' => '参数详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '参数名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MYSQL_HOME'."\n", + ], + 'Label' => [ + 'description' => '参数标签。', + 'type' => 'string', + 'example' => 'Mysql安装路径'."\n", + ], + 'Value' => [ + 'description' => '参数值。', + 'type' => 'string', + 'required' => true, + 'example' => 'usr/local/mysql'."\n", + ], + 'Type' => [ + 'description' => '参数类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'String'."\n", + ], + 'HelpText' => [ + 'description' => '参数帮助。', + 'type' => 'string', + 'example' => 'Mysql安装根目录', + ], + ], + ], + ], + 'NetworkACL' => [ + 'description' => '服务安全组配置。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组规则。', + 'type' => 'object', + 'properties' => [ + 'IpProtocol' => [ + 'description' => '协议类型，可取值：'."\n" + ."\n" + .'TCP：转发TCP协议的报文。'."\n" + ."\n" + .'UDP：转发UDP协议的报文。'."\n" + ."\n" + .'Any：转发所有协议的报文。', + 'type' => 'string', + 'required' => true, + 'example' => 'TCP', + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '3306'."\n", + ], + 'SourceCidrIp' => [ + 'description' => '源地址段。', + 'type' => 'string', + 'required' => true, + 'example' => '172.16.0.0/12'."\n", + ], + ], + ], + ], + ], + ], + ], + 'ResourcesSpec' => [ + 'description' => '组件资源配置信息。', + 'type' => 'object', + 'properties' => [ + 'EipResource' => [ + 'description' => '弹性公网IP配置。', + 'type' => 'object', + 'properties' => [ + 'AutoCreate' => [ + 'description' => '是否自动创建。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'EipInstanceId' => [ + 'description' => '弹性公网IP ID。', + 'type' => 'string', + 'example' => 'eip-bp1vi9124tbx1g3kr****', + ], + 'EipAddress' => [ + 'description' => '弹性公网IP地址。', + 'type' => 'string', + 'example' => '39.108.xx.xx', + ], + 'InstanceChargeType' => [ + 'description' => 'EIP 的计费方式。'."\n" + ."\n" + .'- PostPaid：按量付费'."\n" + .'- PrePaid：包年包月'."\n" + ."\n" + .'默认值：PostPaid', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'InternetChargeType' => [ + 'description' => 'EIP 的计量方式。取值范围：'."\n" + ."\n" + .'- PayByBandwidth：按固定带宽收费'."\n" + .'- PayByTraffic：按流量计费'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'string', + 'example' => 'PayByTraffic', + ], + 'Bandwidth' => [ + 'description' => 'EIP 的带宽峰值。单位：Mbps。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + 'EcsResources' => [ + 'description' => '自定义服务组件ECS资源配置。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS节点配置信息。', + '$ref' => '#/components/schemas/AddonNodeTemplate', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBC2F93D-003A-49C4-850C-B826EECF****\\",\\n \\"Addon\\": {\\n \\"Name\\": \\"Login\\",\\n \\"Version\\": \\"1.0\\",\\n \\"AddonId\\": \\"Login-1.0-W2g****\\",\\n \\"Label\\": \\"登录节点\\",\\n \\"Description\\": \\"登录节点，主要用于E-HPC集群环境的连接登录及用户任务的提交。\\",\\n \\"Icon\\": \\"/assets/icons/your_icon.svg\\\\n\\",\\n \\"InstallTime\\": \\"2024-08-22 18:11:17\\\\n\\",\\n \\"Status\\": \\"Running\\",\\n \\"ServicesSpec\\": [\\n {\\n \\"ServiceName\\": \\"Web Portal\\",\\n \\"ServiceAccessType\\": \\"URL\\",\\n \\"ServiceAccessUrl\\": \\"https://47.96.xx.xx:12008\\",\\n \\"InputParams\\": [\\n {\\n \\"Name\\": \\"MYSQL_HOME\\\\n\\",\\n \\"Label\\": \\"Mysql安装路径\\\\n\\",\\n \\"Value\\": \\"usr/local/mysql\\\\n\\",\\n \\"Type\\": \\"String\\\\n\\",\\n \\"HelpText\\": \\"Mysql安装根目录\\"\\n }\\n ],\\n \\"NetworkACL\\": [\\n {\\n \\"IpProtocol\\": \\"TCP\\",\\n \\"Port\\": 3306,\\n \\"SourceCidrIp\\": \\"172.16.0.0/12\\\\n\\"\\n }\\n ]\\n }\\n ],\\n \\"ResourcesSpec\\": {\\n \\"EipResource\\": {\\n \\"AutoCreate\\": true,\\n \\"EipInstanceId\\": \\"eip-bp1vi9124tbx1g3kr****\\",\\n \\"EipAddress\\": \\"39.108.xx.xx\\",\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"InternetChargeType\\": \\"PayByTraffic\\",\\n \\"Bandwidth\\": \\"100\\"\\n },\\n \\"EcsResources\\": [\\n {\\n \\"InstanceType\\": \\"ecs.c7.4xlarge\\",\\n \\"InstanceId\\": \\"\\",\\n \\"PrivateIpAddress\\": \\"\\",\\n \\"ImageId\\": \\"aliyun_3_x64_20G_alibase_20221102.vhd\\",\\n \\"OsName\\": \\"CentOS 7.6 64 位\\",\\n \\"OsNameEN\\": \\"CentOS 7.6 64 bit\\",\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"PeriodUnit\\": \\"Month\\",\\n \\"Period\\": 1,\\n \\"AutoRenew\\": false,\\n \\"AutoRenewPeriod\\": 1,\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"SpotPriceLimit\\": 0.97,\\n \\"Duration\\": 1,\\n \\"EnableHT\\": true,\\n \\"SystemDisk\\": {\\n \\"Category\\": \\"cloud_auto\\",\\n \\"Size\\": 40,\\n \\"Level\\": \\"PL0\\"\\n },\\n \\"DataDisks\\": [\\n {\\n \\"Category\\": \\"cloud_auto\\",\\n \\"Size\\": 40,\\n \\"Level\\": \\"PL0\\",\\n \\"DeleteWithInstance\\": false\\n }\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询已安装组件详情', + ], + 'DescribeAddonTemplate' => [ + 'summary' => '查询自定义服务组件模板详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREehpcL8RMWH', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页序号，默认值为1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的每页大小，默认值20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'AddonName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义服务组件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + ], + [ + 'name' => 'AddonVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义服务组件版本。', + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => '可用区ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求下的总条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '本次请求所返回的最大记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Addon' => [ + 'title' => 'Addon', + 'description' => '自定义服务组件模板详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '自定义服务组件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => '自定义服务组件版本。', + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'Label' => [ + 'description' => '自定义服务组件标签。', + 'type' => 'string', + 'example' => '登录节点', + ], + 'Description' => [ + 'description' => '自定义服务组件描述。', + 'type' => 'string', + 'example' => '登录节点，主要用于E-HPC集群环境的连接登录及用户任务的提交。', + ], + 'Icon' => [ + 'description' => '自定义服务组件图标。', + 'type' => 'string', + 'example' => '/assets/icons/your_icon.svg', + ], + 'LastUpdate' => [ + 'description' => '组件模板最新更新日期。', + 'type' => 'string', + 'example' => '2024-08-22 18:11:17', + ], + 'ServicesSpec' => [ + 'description' => '组件服务配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '服务配置详情。', + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Web Portal', + ], + 'ServiceAccessType' => [ + 'description' => '服务访问类型。', + 'type' => 'string', + 'example' => 'URL', + ], + 'ServiceAccessUrl' => [ + 'description' => '服务访问Url。', + 'type' => 'string', + 'example' => 'https://47.96.xx.xx:12008', + ], + 'InputParams' => [ + 'description' => '服务参数配置。', + 'type' => 'array', + 'items' => [ + 'description' => '参数详情。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '参数名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'MYSQL_HOME', + ], + 'Label' => [ + 'description' => '参数标签。', + 'type' => 'string', + 'example' => 'Mysql安装路径', + ], + 'Value' => [ + 'description' => '参数值。', + 'type' => 'string', + 'required' => true, + 'example' => 'usr/local/mysql', + ], + 'Type' => [ + 'description' => '参数类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'String', + ], + 'HelpText' => [ + 'description' => '参数帮助。', + 'type' => 'string', + 'example' => 'Mysql安装根目录', + ], + ], + ], + ], + 'NetworkACL' => [ + 'description' => '服务安全组配置。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组规则。', + 'type' => 'object', + 'properties' => [ + 'IpProtocol' => [ + 'description' => '协议类型，取值范围：'."\n" + ."\n" + .'- **TCP**：转发TCP协议的报文。'."\n" + ."\n" + .'- **UDP**：转发UDP协议的报文。'."\n" + ."\n" + .'- **Any**：转发所有协议的报文。', + 'type' => 'string', + 'required' => true, + 'example' => 'TCP', + ], + 'Port' => [ + 'description' => '端口号。', + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '3306', + ], + 'SourceCidrIp' => [ + 'description' => '源地址段。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => '172.16.0.0/12', + ], + ], + ], + ], + ], + ], + ], + 'ResourcesSpec' => [ + 'description' => '组件资源配置信息。', + 'type' => 'object', + 'properties' => [ + 'EipResource' => [ + 'description' => '弹性公网IP配置。', + 'type' => 'object', + 'properties' => [ + 'AutoCreate' => [ + 'description' => '是否自动创建。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'EipInstanceId' => [ + 'description' => '弹性公网IP ID。', + 'type' => 'string', + 'example' => 'eip-bp1jwtsuoiif2qf90****', + ], + 'InstanceChargeType' => [ + 'description' => 'EIP 的计费方式。'."\n" + .'- PostPaid：按量付费'."\n" + .'- PrePaid：包年包月'."\n" + ."\n" + .'默认值：PostPaid', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'InternetChargeType' => [ + 'description' => 'EIP 的计量方式。取值范围：'."\n" + ."\n" + .'- PayByBandwidth：按固定带宽收费'."\n" + .'- PayByTraffic：按流量计费'."\n" + ."\n" + .'N的取值范围：1~10', + 'type' => 'string', + 'example' => 'PayByTraffic', + ], + 'Bandwidth' => [ + 'description' => 'EIP 的带宽峰值。单位：Mbps。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + 'EcsResources' => [ + 'description' => '自定义服务组件ECS资源配置。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS节点配置信息。', + '$ref' => '#/components/schemas/AddonNodeTemplate', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Addon\\": {\\n \\"Name\\": \\"Login\\",\\n \\"Version\\": \\"1.0\\",\\n \\"Label\\": \\"登录节点\\",\\n \\"Description\\": \\"登录节点，主要用于E-HPC集群环境的连接登录及用户任务的提交。\\",\\n \\"Icon\\": \\"/assets/icons/your_icon.svg\\",\\n \\"LastUpdate\\": \\"2024-08-22 18:11:17\\",\\n \\"ServicesSpec\\": [\\n {\\n \\"ServiceName\\": \\"Web Portal\\",\\n \\"ServiceAccessType\\": \\"URL\\",\\n \\"ServiceAccessUrl\\": \\"https://47.96.xx.xx:12008\\",\\n \\"InputParams\\": [\\n {\\n \\"Name\\": \\"MYSQL_HOME\\",\\n \\"Label\\": \\"Mysql安装路径\\",\\n \\"Value\\": \\"usr/local/mysql\\",\\n \\"Type\\": \\"String\\",\\n \\"HelpText\\": \\"Mysql安装根目录\\"\\n }\\n ],\\n \\"NetworkACL\\": [\\n {\\n \\"IpProtocol\\": \\"TCP\\",\\n \\"Port\\": 3306,\\n \\"SourceCidrIp\\": \\"172.16.0.0/12\\"\\n }\\n ]\\n }\\n ],\\n \\"ResourcesSpec\\": {\\n \\"EipResource\\": {\\n \\"AutoCreate\\": true,\\n \\"EipInstanceId\\": \\"eip-bp1jwtsuoiif2qf90****\\",\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"InternetChargeType\\": \\"PayByTraffic\\",\\n \\"Bandwidth\\": \\"100\\"\\n },\\n \\"EcsResources\\": [\\n {\\n \\"InstanceType\\": \\"ecs.c7.4xlarge\\",\\n \\"InstanceId\\": \\"\\",\\n \\"PrivateIpAddress\\": \\"\\",\\n \\"ImageId\\": \\"aliyun_3_x64_20G_alibase_20221102.vhd\\",\\n \\"OsName\\": \\"CentOS 7.6 64 位\\",\\n \\"OsNameEN\\": \\"CentOS 7.6 64 bit\\",\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"PeriodUnit\\": \\"Month\\",\\n \\"Period\\": 1,\\n \\"AutoRenew\\": false,\\n \\"AutoRenewPeriod\\": 1,\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"SpotPriceLimit\\": 0.97,\\n \\"Duration\\": 1,\\n \\"EnableHT\\": true,\\n \\"SystemDisk\\": {\\n \\"Category\\": \\"cloud_auto\\",\\n \\"Size\\": 40,\\n \\"Level\\": \\"PL0\\"\\n },\\n \\"DataDisks\\": [\\n {\\n \\"Category\\": \\"cloud_auto\\",\\n \\"Size\\": 40,\\n \\"Level\\": \\"PL0\\",\\n \\"DeleteWithInstance\\": false\\n }\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => '查询组件模板详情', + ], + 'DeleteCluster' => [ + 'summary' => '释放指定的E-HPC集群。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '待释放的E-HPC集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-QKKVqO****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '请求结果，可能值：'."\n" + ."\n" + .'- true：请求成功。'."\n" + ."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F1AB6D8D-E185-4D94-859C-7CE7B8B7****', + ], + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'F1AB6D8D-E185-4D94-859C-7CE7B8B7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"F1AB6D8D-E185-4D94-859C-7CE7B8B7****\\",\\n \\"TaskId\\": \\"F1AB6D8D-E185-4D94-859C-7CE7B8B7****\\"\\n}","type":"json"}]', + 'title' => '释放集群', + 'description' => '## 接口说明'."\n" + .'调用该接口前，请确保您已备份好集群数据。'."\n" + ."\n" + .'><notice>集群释放后，无法恢复数据，请谨慎操作。</notice>', + ], + 'CreateUsers' => [ + 'summary' => '为指定集群新增一个或多个用户。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227336', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '详细用户信息', + 'type' => 'object', + 'properties' => [ + 'UserName' => [ + 'description' => '第 N 个新增的用户名。长度为 1~30 个字符，必须以英文字母开头，可以包含数字、特殊字符（.）。'."\n" + ."\n" + .'N 的取值范围：1~20', + 'type' => 'string', + 'required' => false, + 'example' => 'testuser', + ], + 'Group' => [ + 'description' => '第 N 个新增用户的用户组。取值范围：'."\n" + ."\n" + .'users：普通权限组，适用于只有提交、调试作业需求的普通用户。'."\n" + .'wheel：sudo 权限组，适用于需要管理集群的管理员，除提交、调试作业外，还可以执行 sudo 命令进行安装软件、重启节点等操作。'."\n" + .'N 的取值范围：1~20', + 'type' => 'string', + 'required' => false, + 'example' => 'users', + ], + 'Password' => [ + 'description' => '第 N 个新增用户的密码。长度为 6~30 个字符，必须同时包含以下四项中的三项：'."\n" + .'- 大写英文字母'."\n" + .'- 小写英文字母'."\n" + .'- 数字'."\n" + .'- 特殊字符：()~!@#$%^&*-_+=|{}[]:;\'/<>,.?/'."\n" + ."\n" + .'N 的取值范围：1~20'."\n" + ."\n" + .'与AuthKey参数互斥，当集群认证方式为密码时生效（推荐方式）。', + 'type' => 'string', + 'required' => false, + 'example' => '1@a2****', + ], + 'AuthKey' => [ + 'description' => '第 N 个新增用户的公钥。'."\n" + ."\n" + .'N 的取值范围：1~20'."\n" + ."\n" + .'与Password参数互斥，当集群认证方式为密钥时生效（不推荐）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Abc****', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError.Account.UserAddFailure', + 'errorMessage' => 'Failed to add user to domain: %s.', + ], + ], + 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-6C044FE7****\\"\\n}","type":"json"}]', + 'title' => '创建集群用户', + ], + 'UpdateUser' => [ + 'summary' => '更新指定集群用户的信息，包括用户组、密码等属性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228355', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => '用户名。', + 'type' => 'string', + 'required' => true, + 'example' => 'testuser', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => '待更新的用户组属性。取值范围：'."\n" + ."\n" + .'- users：普通权限组，适用于只有提交、调试作业需求的普通用户。'."\n" + ."\n" + .'- wheel：sudo 权限组，适用于需要管理集群的管理员，除提交、调试作业外，还可以执行 sudo 命令进行安装软件、重启节点等操作。', + 'type' => 'string', + 'required' => false, + 'example' => 'users', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '待更新的用户密码属性。长度为 6~30 个字符，必须同时包含以下四项中的三项：'."\n" + ."\n" + .'- 大写英文字母'."\n" + .'- 小写英文字母'."\n" + .'- 数字'."\n" + .'- 特殊字符：()~!@#$%^&*-_+=|{}[]:;\'/<>,.?/', + 'type' => 'string', + 'required' => false, + 'example' => '123****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Success' => [ + 'description' => '请求结果，可能值：'."\n" + ."\n" + .'- true：请求成功。'."\n" + ."\n" + .'- false：请求失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.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' => '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '更新集群用户', + ], + 'ListUsers' => [ + 'summary' => '查询指定集群的用户列表信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228357', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'起始值：1'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。取值范围：1~50'."\n" + ."\n" + .'默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '用户列表总条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'Users' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UserInfo' => [ + 'description' => '用户数组。', + 'type' => 'array', + 'items' => [ + 'description' => '用户详细信息。', + 'type' => 'object', + 'properties' => [ + 'UserName' => [ + 'description' => '用户名。', + 'type' => 'string', + 'example' => 'testuser', + ], + 'AddTime' => [ + 'description' => '用户首次添加时间。', + 'type' => 'string', + 'example' => '2014-08-22T17:46:47', + ], + 'Group' => [ + 'description' => '用户组。可能值：'."\n" + ."\n" + .'users：普通权限组，适用于只有提交、调试作业需求的普通用户。'."\n" + ."\n" + .'wheel：sudo 权限组，适用于需要管理集群的管理员，除提交、调试作业外，还可以执行 sudo 命令进行安装软件、重启节点等操作。', + 'type' => 'string', + 'example' => 'users', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '1001', + ], + 'GroupId' => [ + 'description' => '用户组ID。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 15,\\n \\"Users\\": {\\n \\"UserInfo\\": [\\n {\\n \\"UserName\\": \\"testuser\\",\\n \\"AddTime\\": \\"2014-08-22T17:46:47\\",\\n \\"Group\\": \\"users\\",\\n \\"UserId\\": \\"1001\\",\\n \\"GroupId\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询集群用户列表', + ], + 'DeleteUsers' => [ + 'summary' => '删除指定集群的一个或多个用户。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '228356', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户列表。', + 'type' => 'array', + 'items' => [ + 'description' => '用户详细信息。', + 'type' => 'object', + 'properties' => [ + 'UserName' => [ + 'description' => '第 N 个要删除的用户名。'."\n" + ."\n" + .'N 的取值范围：1~100', + 'type' => 'string', + 'required' => true, + 'example' => 'testuser', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE****\\"\\n}","type":"json"}]', + 'title' => '删除集群用户', + ], + 'CreateQueue' => [ + 'summary' => '为指定的E-HPC集群创建队列。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228055', + 'abilityTreeNodes' => [ + 'FEATUREehpcAB36B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Queue', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待创建的队列配置信息。', + 'required' => false, + '$ref' => '#/components/schemas/QueueTemplate', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Name' => [ + 'description' => '新建队列的名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service 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 \\"Name\\": \\"test\\"\\n}","type":"json"}]', + 'title' => '创建队列', + ], + 'CreateNodes' => [ + 'summary' => '批量给E-HPC集群创建计算节点。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '228052', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询的集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点所属的队列名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'Count', + 'in' => 'query', + 'schema' => [ + 'description' => '添加的计算节点数量。取值范围：1~99，并且MinCount<Count。'."\n" + ."\n" + .'- ECS库存数量<MinCount，添加节点失败。'."\n" + ."\n" + .'- MinCount<ECS库存数量<Count，按照MinCount指定的数量添加节点。'."\n" + ."\n" + .'- Count<ECS库存数量，按照Count指定的数量添加节点。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MinCount', + 'in' => 'query', + 'schema' => [ + 'title' => '添加的计算节点最小数量。', + 'description' => '添加的计算节点最小数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ComputeNode', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '计算节点的硬件配置。', + 'required' => false, + 'example' => '10', + '$ref' => '#/components/schemas/NodeTemplate', + ], + ], + [ + 'name' => 'HPCInterConnect', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点间的网络类型。可能值：'."\n" + .'- vpc'."\n" + .'- eRDMA', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + ], + [ + 'name' => 'RamRole', + 'in' => 'query', + 'schema' => [ + 'description' => '队列中计算节点绑定的是授权实例角色名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunServiceRoleForOOSBandwidthScheduler', + ], + ], + [ + 'name' => 'HostnamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '队列中计算节点主机名前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + ], + [ + 'name' => 'HostnameSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => '队列中计算节点主机名后缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'demo', + ], + ], + [ + 'name' => 'KeepAlive', + 'in' => 'query', + 'schema' => [ + 'description' => '计算节点是否开启删除保护。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DeploymentSetId', + 'in' => 'query', + 'schema' => [ + 'description' => '部署集ID。'."\n" + .'您可以通过[DescribeDeploymentSets](~~91313~~)获取部署集ID，当前仅支持网络低时延策略的部署集。', + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp1frxuzdg87zh4pzq****', + ], + ], + [ + 'name' => 'ReservedNodePoolId', + 'in' => 'query', + 'schema' => [ + 'description' => '预设节点池ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rnp-756vlp7a', + ], + ], + [ + 'name' => 'Hostnames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。取值范围：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceIds' => [ + 'description' => '待创建的计算节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待创建的计算节点列表。', + 'type' => 'string', + 'example' => '[ "i-uf68t1zu3jkhs8w****", "i-uf6abz34m2714bp****", "i-uf65bh2113hlqvyx****", "i-uf68t1zu3jkhs8wx****", "i-uf6b0mtpx166fxxi****", "i-uf6faknz4dy1bit7****" ]', + ], + ], + ], + ], + ], + ], + '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' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'InsufficientReservedNodes', + 'errorMessage' => 'There is no more available reserved nodes.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Success\\": true,\\n \\"InstanceIds\\": [\\n \\"[ \\\\\\"i-uf68t1zu3jkhs8w****\\\\\\", \\\\\\"i-uf6abz34m2714bp****\\\\\\", \\\\\\"i-uf65bh2113hlqvyx****\\\\\\", \\\\\\"i-uf68t1zu3jkhs8wx****\\\\\\", \\\\\\"i-uf6b0mtpx166fxxi****\\\\\\", \\\\\\"i-uf6faknz4dy1bit7****\\\\\\" ]\\"\\n ]\\n}","type":"json"}]', + 'title' => '批量创建计算节点', + ], + 'UpdateQueue' => [ + 'summary' => '修改E-HPC集群指定队列的配置信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227338', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Queue', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待更新队列信息。', + 'type' => 'object', + 'properties' => [ + 'QueueName' => [ + 'title' => 'QueueName', + 'description' => '队列名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'comp', + ], + 'EnableScaleOut' => [ + 'title' => 'EnableScaleOut', + 'description' => '队列是否启动自动扩容。可选值：'."\n" + .'- true：开启。'."\n" + .'- false：关闭。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'EnableScaleIn' => [ + 'title' => 'EnableScaleIn', + 'description' => '队列是否开启自动缩容。可选值：'."\n" + .'- true：开启'."\n" + .'- false：关闭。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'MinCount' => [ + 'title' => 'MinCount', + 'description' => '队列保有的最小节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'MaxCount' => [ + 'title' => 'MaxCount', + 'description' => '队列可保有的最大计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + 'InitialCount' => [ + 'title' => 'InitialCount', + 'description' => '队列的初始计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'InterConnect' => [ + 'title' => 'HPCInterConnect', + 'description' => '队列中计算节点的互联网络类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'erdma', + ], + 'VSwitchIds' => [ + 'title' => 'VSwitchIds', + 'description' => '队列中计算节点可用的交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'VSwitchId', + ], + 'required' => false, + ], + 'ComputeNodes' => [ + 'title' => 'Resources', + 'description' => '队列中计算节点的硬件配置信息。N的取值范围是1～10。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点的详细配置。', + 'required' => false, + '$ref' => '#/components/schemas/NodeTemplate', + ], + 'required' => false, + ], + 'AllocationStrategy' => [ + 'title' => 'AllocationStrategy', + 'description' => '队列自动扩容时计算节点实例规格的选择策略。可选值：'."\n" + .'- PriorityInstanceType', + 'type' => 'string', + 'required' => false, + 'example' => 'PriorityInstanceType', + ], + 'RamRole' => [ + 'title' => 'RamRole', + 'description' => '队列中计算节点绑定的是授权实例角色名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunECSInstanceForEHPCRole', + ], + 'HostnamePrefix' => [ + 'title' => 'HostNamePrefix', + 'description' => '队列中计算节点主机名前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + 'HostnameSuffix' => [ + 'title' => 'HostNameSuffix', + 'description' => '队列中计算节点主机名后缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'hpc', + ], + 'MaxCountPerCycle' => [ + 'title' => 'MaxCountPerCycle', + 'description' => '自动扩容时队列创建的最小计算节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '99', + ], + 'KeepAliveNodes' => [ + 'description' => '队列中例外计算节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '例外的计算节点主机名。', + 'type' => 'string', + 'required' => false, + 'example' => 'compute000', + ], + 'required' => false, + ], + 'ReservedNodePoolId' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。取值范围：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service 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 \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改队列配置', + 'description' => '调用该接口更新队列配置时，所有字段以本次传入的参数为准。如果多次调用，配置以最后一次传入的参数为准。', + ], + 'UpdateNodes' => [ + 'summary' => '批量更新E-HPC集群计算节点配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228050', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待更新计算节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点配置信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => '计算节点实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1bzqq1ddeemuddn****', + ], + 'KeepAlive' => [ + 'description' => '计算节点是否开启删除保护。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Success' => [ + 'description' => '请求结果，可能值：'."\n" + ."\n" + .'- true：请求成功。'."\n" + ."\n" + .'- false：请求失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidNodeStatus', + 'errorMessage' => 'The operation failed due to invalid node status.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '批量更新计算节点信息', + 'description' => '## 接口说明'."\n" + .'删除节点前，建议您导出节点上所有作业数据，以免因为删除节点而导致数据丢失。', + ], + 'ListQueues' => [ + 'summary' => '查询指定E-HPC集群的队列列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228051', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待查询队列名称列表，N的取值范围：0～8。', + 'type' => 'array', + 'items' => [ + 'description' => '队列名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C6E5005C-00B0-4F27-98BB-95AB88016C22', + ], + 'TotalCount' => [ + 'description' => '查询结果条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterId' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页查询时设置的本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Queues' => [ + 'description' => '查询队列的详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '队列详细信息。', + 'type' => 'object', + 'properties' => [ + 'QueueName' => [ + 'description' => '队列名称。', + 'type' => 'string', + 'example' => 'comp', + ], + 'EnableScaleOut' => [ + 'description' => '队列是否开启自动扩容。取值范围：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableScaleIn' => [ + 'description' => '队列是否开启自动缩容。取值范围：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MinCount' => [ + 'description' => '队列保有的最小计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxCount' => [ + 'description' => '队列保有的最大计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'MaxCountPerCycle' => [ + 'description' => '队列在每个扩容轮次中最小扩容的计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ComputeNodes' => [ + 'description' => '队列自动扩容时计算节点的硬件配置列表。N的取值范围：0～5。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点的硬件配置。', + '$ref' => '#/components/schemas/NodeTemplate', + ], + ], + 'VSwitchIds' => [ + 'description' => '队列自动扩容时可使用的交换机列表。N的取值范围是：0～3。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp12pmqe9gh0pi7i1f2ed', + ], + ], + 'Nodes' => [ + 'description' => '队列保有的计算节点数量信息。', + 'type' => 'object', + 'properties' => [ + 'RunningCounts' => [ + 'description' => '处于运行状态的计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExceptionCounts' => [ + 'description' => '处于异常状态的计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatingCounts' => [ + 'description' => '未就绪的计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'CreateTime' => [ + 'description' => '队列的创建时间。以 ISO 8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。更多信息，请参见[ISO 8601](~~25696~~)。', + 'type' => 'string', + 'example' => '2023-11-10T02:04:00Z', + ], + 'UpdateTime' => [ + 'description' => '队列的更新时间。以 ISO 8601 为标准，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mmZ。更多信息，请参见[ISO 8601](~~25696~~)。', + 'type' => 'string', + 'example' => '2024-04-25T02:02:32', + ], + 'TotalCores' => [ + 'description' => '队列中所有计算节点的总vCPU数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C6E5005C-00B0-4F27-98BB-95AB88016C22\\",\\n \\"TotalCount\\": 1,\\n \\"ClusterId\\": \\"ehpc-hz-FYUr32****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Queues\\": [\\n {\\n \\"QueueName\\": \\"comp\\",\\n \\"EnableScaleOut\\": true,\\n \\"EnableScaleIn\\": true,\\n \\"MinCount\\": 0,\\n \\"MaxCount\\": 100,\\n \\"MaxCountPerCycle\\": 1,\\n \\"ComputeNodes\\": [\\n {\\n \\"InstanceType\\": \\"ecs.c7.4xlarge\\",\\n \\"ImageId\\": \\"aliyun_3_x64_20G_alibase_20221102.vhd\\",\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"PeriodUnit\\": \\"Month\\",\\n \\"Period\\": 1,\\n \\"AutoRenew\\": false,\\n \\"AutoRenewPeriod\\": 1,\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"SpotPriceLimit\\": 0.97,\\n \\"Duration\\": 1,\\n \\"EnableHT\\": true,\\n \\"SystemDisk\\": {\\n \\"Category\\": \\"cloud_auto\\",\\n \\"Size\\": 40,\\n \\"Level\\": \\"PL0\\"\\n },\\n \\"DataDisks\\": [\\n {\\n \\"Category\\": \\"cloud_auto\\",\\n \\"Size\\": 40,\\n \\"Level\\": \\"PL0\\",\\n \\"DeleteWithInstance\\": false,\\n \\"MountDir\\": \\"/data1\\",\\n \\"Device\\": \\"/dev/xvdb\\",\\n \\"SnapshotId\\": \\"s-bp1ei2b44ripxuo46hym\\"\\n }\\n ]\\n }\\n ],\\n \\"VSwitchIds\\": [\\n \\"vsw-bp12pmqe9gh0pi7i1f2ed\\"\\n ],\\n \\"Nodes\\": {\\n \\"RunningCounts\\": 1,\\n \\"ExceptionCounts\\": 0,\\n \\"CreatingCounts\\": 2\\n },\\n \\"CreateTime\\": \\"2023-11-10T02:04:00Z\\",\\n \\"UpdateTime\\": \\"2024-04-25T02:02:32\\",\\n \\"TotalCores\\": 24\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询队列列表', + ], + 'ListNodes' => [ + 'summary' => '查询E-HPC集群的节点列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228053', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。您可以通过调用[listclusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Hostnames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待查询计算节点的主机名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点主机名。', + 'type' => 'string', + 'required' => false, + 'example' => 'compute000', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待查询计算节点的IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点的VPC网络的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.**.**', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => '节点列表排序方式。取值范围：'."\n" + .'- Forward：正序排序。'."\n" + .'- Backward：逆序排序。'."\n" + ."\n" + .'默认值：Forward', + 'type' => 'string', + 'required' => false, + 'example' => 'Forward', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => '节点列表排序方式。取值范围：'."\n" + .'- addedtime：按加入时间排序。'."\n" + .'- hostname：按节点主机名称排序。'."\n" + ."\n" + .'默认值：addedtime', + 'type' => 'string', + 'required' => false, + 'example' => 'AddedTime', + ], + ], + [ + 'name' => 'QueueNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待查询计算节点所属的队列列表。', + 'type' => 'array', + 'items' => [ + 'description' => '队列名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待查询计算节点的状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点状态，可选值：'."\n" + .'- uninit：安装中。'."\n" + .'- initing：初始化中。'."\n" + .'- running：运行中。'."\n" + .'- releasing：释放中。'."\n" + .'- stopped：已停止。'."\n" + .'- exception：异常。'."\n" + .'- untracking：未加入集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'running', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '89A1AC0F-4A6C-4F3D-98F9-BEF9A823****', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Nodes' => [ + 'description' => '计算节点列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '节点列表信息。', + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-bp1gnu8br4ay7beb2w****', + ], + 'Status' => [ + 'description' => '计算节点状态，可选值：'."\n" + .'- uninit：安装中。'."\n" + .'- initing：初始化中。'."\n" + .'- running：运行中。'."\n" + .'- releasing：释放中。'."\n" + .'- stopped：已停止。'."\n" + .'- exception：异常。'."\n" + .'- untracking：未加入集群。', + 'type' => 'string', + 'example' => 'running', + ], + 'HtEnabled' => [ + 'description' => '是否开启超线程。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Hostname' => [ + 'description' => '计算节点主机名称。', + 'type' => 'string', + 'example' => 'edas.cn-shanghai.aliyuncs.com', + ], + 'InstanceType' => [ + 'description' => '计算节点实例规格。', + 'type' => 'string', + 'example' => 'ecs.c5.large', + ], + 'PublicIpAddress' => [ + 'description' => '计算节点的公网IP地址。', + 'type' => 'string', + 'example' => '172.16.**.**', + ], + 'SpotStrategy' => [ + 'description' => '计算节点的竞价策略。可能值：'."\n" + .'- NoSpot：正常按量付费实例。'."\n" + .'- SpotWithPriceLimit：设置上限价格的抢占式实例。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'VSwitchId' => [ + 'description' => '计算节点所属的虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1e47optm9g58zcu****', + ], + 'IpAddress' => [ + 'description' => '计算节点的VPC网络IP。', + 'type' => 'string', + 'example' => '172.16.**.**', + ], + 'ExpiredTime' => [ + 'description' => '计算节点的到期时间。', + 'type' => 'string', + 'example' => '2020-06-09T06:22:02.000Z', + ], + 'ZoneId' => [ + 'description' => '计算节点的可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'AddTime' => [ + 'description' => '计算节点的创建时间。', + 'type' => 'string', + 'example' => '2020-06-09T06:22:02.000Z', + ], + 'ImageId' => [ + 'description' => '计算节点的镜像ID。', + 'type' => 'string', + 'example' => 'centos_7_06_64_20G_alibase_20190711.vhd', + ], + 'Id' => [ + 'description' => '计算节点的实例ID。', + 'type' => 'string', + 'example' => 'i-bp15707mys2rsy0j****', + ], + 'TotalResources' => [ + 'description' => '计算节点的硬件配置信息。', + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'GPU卡数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'vCPU数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => '内存量，单位GiB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'StateInSched' => [ + 'description' => '计算节点在调度器中的状态。', + 'type' => 'string', + 'example' => 'active', + ], + 'QueueName' => [ + 'description' => '计算节点所属的队列名称。', + 'type' => 'string', + 'example' => 'autoque3', + ], + 'KeepAlive' => [ + 'description' => '计算节点是否开启删除保护。可能值：'."\n" + .'- true：开启。'."\n" + .'- false：关闭。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DeploymentSetId' => [ + 'description' => '部署集ID。', + 'type' => 'string', + 'example' => 'ds-8vbe4av4gededlqg****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"89A1AC0F-4A6C-4F3D-98F9-BEF9A823****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Nodes\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1gnu8br4ay7beb2w****\\",\\n \\"Status\\": \\"running\\",\\n \\"HtEnabled\\": true,\\n \\"Hostname\\": \\"edas.cn-shanghai.aliyuncs.com\\",\\n \\"InstanceType\\": \\"ecs.c5.large\\",\\n \\"PublicIpAddress\\": \\"172.16.**.**\\",\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"VSwitchId\\": \\"vsw-bp1e47optm9g58zcu****\\",\\n \\"IpAddress\\": \\"172.16.**.**\\",\\n \\"ExpiredTime\\": \\"2020-06-09T06:22:02.000Z\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"AddTime\\": \\"2020-06-09T06:22:02.000Z\\",\\n \\"ImageId\\": \\"centos_7_06_64_20G_alibase_20190711.vhd\\",\\n \\"Id\\": \\"i-bp15707mys2rsy0j****\\",\\n \\"TotalResources\\": {\\n \\"Gpu\\": 0,\\n \\"Cpu\\": 1,\\n \\"Memory\\": 1024\\n },\\n \\"StateInSched\\": \\"active\\",\\n \\"QueueName\\": \\"autoque3\\",\\n \\"KeepAlive\\": true,\\n \\"DeploymentSetId\\": \\"ds-8vbe4av4gededlqg****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询计算节点列表', + ], + 'GetQueue' => [ + 'summary' => '查询E-HPC集群指定队列的详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227337', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => '队列名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Queue' => [ + 'description' => '队列配置信息。', + 'type' => 'object', + 'properties' => [ + 'QueueName' => [ + 'title' => 'QueueName', + 'description' => '队列名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'comp', + ], + 'EnableScaleOut' => [ + 'title' => 'EnableScaleOut', + 'description' => '队列是否开启自动扩容。可能值：'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableScaleIn' => [ + 'title' => 'EnableScaleIn', + 'description' => '队列是否开启自动缩容，可能值：'."\n" + .'- true：开启'."\n" + .'- false：关闭', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MinCount' => [ + 'title' => 'MinCount', + 'description' => '队列保有的最小计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxCount' => [ + 'title' => 'MaxCount', + 'description' => '队列保有的最大计算节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'InitialCount' => [ + 'title' => 'InitialCount', + 'description' => '队列的初始节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InterConnect' => [ + 'title' => 'HPCInterConnect', + 'description' => '队列中计算节点间的网络类型，可能值：'."\n" + .'- vpc'."\n" + .'- eRDMA', + 'type' => 'string', + 'example' => 'erdma', + ], + 'VSwitchIds' => [ + 'title' => 'VSwitchIds', + 'description' => '队列中计算节点可用的虚拟交换机列表。N的取值范围1～5。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-t4nw7upbpzb3u071twiys', + ], + ], + 'ComputeNodes' => [ + 'title' => 'Resources', + 'description' => '队列中计算节点的硬件配置信息。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点的配置详情。', + '$ref' => '#/components/schemas/NodeTemplate', + ], + ], + 'AllocationStrategy' => [ + 'title' => 'AllocationStrategy', + 'description' => '队列自动扩容的策略。', + 'type' => 'string', + 'example' => 'PriorityInstanceType', + ], + 'RamRole' => [ + 'title' => 'RamRole', + 'description' => '队列中计算节点绑定的授权实例角色名称。', + 'type' => 'string', + 'example' => 'AliyunECSInstanceForEHPCRole', + ], + 'HostnamePrefix' => [ + 'title' => 'HostNamePrefix', + 'description' => '队列中计算节点的主机名前缀。', + 'type' => 'string', + 'example' => 'compute', + ], + 'HostnameSuffix' => [ + 'title' => 'HostNameSuffix', + 'description' => '队列中计算节点的主机名后缀。', + 'type' => 'string', + 'example' => 'demo', + ], + 'MaxCountPerCycle' => [ + 'title' => 'MaxCountPerCycle', + 'description' => '队列在每轮扩容周期中最小交付的节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99', + ], + 'KeepAliveNodes' => [ + 'description' => '队列中开启删除保护的节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '开启删除保护的节点主机名。', + 'type' => 'string', + 'example' => 'compute000', + ], + ], + 'ReservedNodePoolId' => [ + 'description' => '预设节点池ID。', + 'type' => 'string', + 'example' => 'rnp-756vlp7a', + ], + 'CreateTime' => [ + 'title' => '队列创建时间。'."\n", + 'description' => '队列创建时间。'."\n", + 'type' => 'string', + 'example' => '2025-01-01T12:05:00Z', + ], + 'UpdateTime' => [ + 'title' => '队列更新时间。', + 'description' => '队列更新时间。', + 'type' => 'string', + 'example' => '2025-01-01T12:05:00Z', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service 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-6C044FE7****\\",\\n \\"Queue\\": {\\n \\"QueueName\\": \\"comp\\",\\n \\"EnableScaleOut\\": true,\\n \\"EnableScaleIn\\": true,\\n \\"MinCount\\": 0,\\n \\"MaxCount\\": 1000,\\n \\"InitialCount\\": 0,\\n \\"InterConnect\\": \\"erdma\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-t4nw7upbpzb3u071twiys\\"\\n ],\\n \\"ComputeNodes\\": [\\n {\\n \\"InstanceType\\": \\"ecs.c7.4xlarge\\",\\n \\"ImageId\\": \\"aliyun_3_x64_20G_alibase_20221102.vhd\\",\\n \\"InstanceChargeType\\": \\"PostPaid\\",\\n \\"PeriodUnit\\": \\"Month\\",\\n \\"Period\\": 1,\\n \\"AutoRenew\\": false,\\n \\"AutoRenewPeriod\\": 1,\\n \\"SpotStrategy\\": \\"NoSpot\\",\\n \\"SpotPriceLimit\\": 0.97,\\n \\"Duration\\": 1,\\n \\"EnableHT\\": true,\\n \\"SystemDisk\\": {\\n \\"Category\\": \\"cloud_auto\\",\\n \\"Size\\": 40,\\n \\"Level\\": \\"PL0\\"\\n },\\n \\"DataDisks\\": [\\n {\\n \\"Category\\": \\"cloud_auto\\",\\n \\"Size\\": 40,\\n \\"Level\\": \\"PL0\\",\\n \\"DeleteWithInstance\\": false,\\n \\"MountDir\\": \\"/data1\\",\\n \\"Device\\": \\"/dev/xvdb\\",\\n \\"SnapshotId\\": \\"s-bp1ei2b44ripxuo46hym\\"\\n }\\n ]\\n }\\n ],\\n \\"AllocationStrategy\\": \\"PriorityInstanceType\\",\\n \\"RamRole\\": \\"AliyunECSInstanceForEHPCRole\\",\\n \\"HostnamePrefix\\": \\"compute\\",\\n \\"HostnameSuffix\\": \\"demo\\",\\n \\"MaxCountPerCycle\\": 99,\\n \\"KeepAliveNodes\\": [\\n \\"compute000\\"\\n ],\\n \\"ReservedNodePoolId\\": \\"rnp-756vlp7a\\",\\n \\"CreateTime\\": \\"2025-01-01T12:05:00Z\\",\\n \\"UpdateTime\\": \\"2025-01-01T12:05:00Z\\"\\n }\\n}","type":"json"}]', + 'title' => '查询队列详情', + ], + 'DeleteQueues' => [ + 'summary' => '删除E-HPC集群中指定队列。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228049', + 'abilityTreeNodes' => [ + 'FEATUREehpcAB36B2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待删除队列名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待删除队列名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。取值范围：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除队列', + 'description' => '## 接口说明'."\n" + .'删除队列前，你需要先删除队列中所有计算节点。', + ], + 'DeleteNodes' => [ + 'summary' => '批量删除E-HPC集群的计算节点。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228056', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群id。您可以调用[listclusters](~~87116~~)查询集群id。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待删除的计算节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-hp3347creaivnt******', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。取值范围：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskId' => [ + 'description' => '任务id。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"Success\\": true,\\n \\"TaskId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","type":"json"}]', + 'title' => '批量删除计算节点', + 'description' => '## 接口说明'."\n" + .'删除节点前，建议您导出节点上所有作业数据，以免因为删除节点而导致数据丢失。', + ], + 'CreateJob' => [ + 'summary' => '为指定集群创建一个作业。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227376', + 'abilityTreeNodes' => [ + 'FEATUREehpcH08VYA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobName', + 'in' => 'query', + 'schema' => [ + 'description' => '作业名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestJob', + ], + ], + [ + 'name' => 'JobSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '作业配置信息。', + 'type' => 'object', + 'properties' => [ + 'CommandLine' => [ + 'description' => '作业运行命令或脚本，如果是命令，需指定命令完整路径，如: /bin/ping；'."\n" + ."\n" + .'如果希望通过脚本运行作业，则对应脚本需要有可执行权限。集群侧默认以用户根目录作为脚本默认路径，即~/目录。如您的脚本不在该目录下，需在该参数中指定完整路径，如：/home/xxx/job.sh。请注意在这种方式下，如果脚本中指定了CPU、内存等资源需求，作业将以脚本中指定的资源为准，请不要在Resource参数中指定相关资源需求，否则作业可能运行失败。'."\n" + ."\n" + .'如果希望直接通过命令行命令运行作业，则需要指定命令的绝对路径，并在前面添加--，如：-- /bin/ping -c 10 localhost', + 'type' => 'string', + 'required' => true, + 'example' => '/home/xxx/test.job', + ], + 'RunasUser' => [ + 'description' => '提交作业所使用的用户，该用户属于集群侧用户', + 'type' => 'string', + 'required' => false, + 'example' => 'testuser', + ], + 'RunasUserPassword' => [ + 'description' => 'RunasUser参数所指定用户的密码', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'Priority' => [ + 'description' => '作业优先级', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'StdoutPath' => [ + 'description' => '作业标准输出文件，需要指定完整路径', + 'type' => 'string', + 'required' => false, + 'example' => '/home/xxx/job.out', + ], + 'StderrPath' => [ + 'description' => '作业标准错误输出文件，需要指定完整路径', + 'type' => 'string', + 'required' => false, + 'example' => '/home/xxx/job.err', + ], + 'JobQueue' => [ + 'description' => '作业所属队列。', + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + 'ArrayRequest' => [ + 'description' => '数组作业参数。'."\n" + ."\n" + .'格式为X-Y:Z， 最小值X是第一个索引，最大值Y是最后一个索引，Z表示步长，例如2-7:2，表示作业队列包含编号为2、4、6的3个子作业。', + 'type' => 'string', + 'required' => false, + 'example' => '1-5:2', + ], + 'Variables' => [ + 'description' => '作业的环境变量。json数组格式的字符串，每个数组成员为json格式对象，包含Name和Value两个成员，Name表示环境变量的名称，Value表示环境变量的值。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Name":"x", "Value":"y"}]', + ], + 'PostCmdLine' => [ + 'description' => '作业后处理命令。', + 'type' => 'string', + 'required' => false, + 'example' => '/bin/sleep 10', + ], + 'WallTime' => [ + 'description' => '作业最大运行时间，格式为`小时:分钟:秒`，例如`01:00:00`表示1小时。', + 'type' => 'string', + 'required' => false, + 'example' => '360:48:50', + ], + 'Resources' => [ + 'description' => '作业所需资源配置。', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '作业需要分配的计算节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'Cores' => [ + 'description' => '作业每个计算节点需要分配的CPU核数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'Memory' => [ + 'description' => '作业每个计算节点需要分配的内存大小，字符串格式，包含单位，mb(M字节)或gb（千兆字节）。', + 'type' => 'string', + 'required' => false, + 'example' => '4gb', + ], + 'Gpus' => [ + 'description' => '作业每个计算节点需要分配的GPU数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A0A38A38-1565-555E-B597-E48A2E******', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'Submitted batch job 10\\n', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + [ + 'errorCode' => 'AgentError.Job.SubmitFailure', + 'errorMessage' => 'Failed to submit jobs: %s', + ], + [ + 'errorCode' => 'AgentError.Job.DeleteFailure', + 'errorMessage' => 'Failed to delete job: %s', + ], + [ + 'errorCode' => 'AgentError.Job.InvalidContainerType', + 'errorMessage' => 'Unsupported container type: %s.', + ], + [ + 'errorCode' => 'AgentError.Job.ListFailure', + 'errorMessage' => 'Failed to list jobs: %s.', + ], + [ + 'errorCode' => 'AgentError.Job.RerunFailure', + 'errorMessage' => 'Failed to run the job again: %s.', + ], + [ + 'errorCode' => 'AgentError.Job.StopFailure', + 'errorMessage' => 'Failed to stop jobs: %s.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A0A38A38-1565-555E-B597-E48A2E******\\",\\n \\"JobId\\": \\"Submitted batch job 10\\\\\\\\n\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '创建作业', + 'description' => '请确保在使用该接口前，已充分了解E-HPC产品的收费方式和[价格](https://www.aliyun.com/price/product#/ecs/detail)。', + ], + 'ListJobs' => [ + 'summary' => '查询指定集群中的作业列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227488', + 'abilityTreeNodes' => [ + 'FEATUREehpcH08VYA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-csbua72***', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '列表的当前页码。'."\n" + .'- 起始值为1'."\n" + .'- 默认值为1', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '列表分页查询时每页行数。'."\n" + .'- 最大值：50'."\n" + .'- 默认值：10', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '10', + ], + ], + [ + 'name' => 'JobFilter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '作业过滤信息。', + 'type' => 'object', + 'properties' => [ + 'Users' => [ + 'description' => '执行作业的用户列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '执行作业的用户名。支持模糊查询。 '."\n" + ."\n" + .'可通过调用[ ListUsers ](url)获取该集群中的用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'testuser1', + ], + 'required' => false, + ], + 'Queues' => [ + 'description' => '执行作业的队列列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '执行作业的队列名称。支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + 'required' => false, + ], + 'Nodes' => [ + 'description' => '执行作业的计算节点列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '计算节点主机名。支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'compute000', + ], + 'required' => false, + ], + 'JobName' => [ + 'description' => '作业名称。支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'testjob', + ], + 'JobStatus' => [ + 'description' => '作业状态。取值范围：'."\n" + .'- all：所有状态。'."\n" + .'- finished：已完成。'."\n" + .'- notfinish：未完成。'."\n" + ."\n" + .'默认值：all。', + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'CreateTimeStart' => [ + 'description' => '作业开始时间。格式为 Unix 时间戳，表示从 1970-01-01T00:00:00Z 起所经过的秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1724122486', + ], + 'CreateTimeEnd' => [ + 'description' => '作业最后更新时间。格式为 Unix 时间戳，表示从 1970-01-01T00:00:00Z 起所经过的秒数。', + 'type' => 'string', + 'required' => false, + 'example' => '1724123085', + ], + 'SortBy' => [ + 'description' => '作业列表排序方式配置。', + 'type' => 'object', + 'properties' => [ + 'ExecuteOrder' => [ + 'description' => '按照作业执行时间进行排序。取值范围：'."\n" + .'- asc：升序。'."\n" + .'- desc：降序。'."\n" + ."\n" + .'默认值：desc。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + 'SubmitOrder' => [ + 'description' => '按照作业提交时间进行排序。取值范围：'."\n" + .'- asc：升序。'."\n" + .'- desc：降序。'."\n" + ."\n" + .'默认值：desc。', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + 'PendOrder' => [ + 'description' => '按照作业排队时间进行排序。取值范围：'."\n" + .'- asc：升序。'."\n" + .'- desc：降序。'."\n" + ."\n" + .'默认值：desc。', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + 'required' => false, + ], + 'Diagnosis' => [ + 'description' => '作业诊断分析列表。', + 'type' => 'array', + 'items' => [ + 'description' => '作业诊断分析详情。', + 'type' => 'object', + 'properties' => [ + 'Option' => [ + 'description' => '作业诊断分析指标项。', + 'type' => 'string', + 'required' => false, + 'example' => 'run_duration', + ], + 'Operator' => [ + 'description' => '作业诊断阈值比较符。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'greater_or_equal' => '大于等于', + 'less' => '小于', + 'less_or_equal' => '小于等于', + 'greater' => '大于', + ], + 'example' => 'greater', + ], + 'Threshold' => [ + 'description' => '作业诊断阈值。', + 'type' => 'string', + 'required' => false, + 'example' => '24', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EABFBD93-58BE-53F3-BBFE-8654BB2E****', + ], + 'PageNumber' => [ + 'description' => '当前页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => '分页查询时设置的本页条数。默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。可能值：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Jobs' => [ + 'description' => '作业列表。', + 'type' => 'array', + 'items' => [ + 'description' => '作业信息列表。', + 'type' => 'object', + 'properties' => [ + 'JobName' => [ + 'description' => '作业名称。', + 'type' => 'string', + 'example' => 'testjob', + ], + 'JobSpec' => [ + 'description' => '作业配置信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => '12', + ], + 'RunasUser' => [ + 'description' => '执行该作业的用户名。', + 'type' => 'string', + 'example' => 'testuser1', + ], + 'Comment' => [ + 'description' => '作业描述信息。', + 'type' => 'string', + 'example' => 'jobDescription', + ], + 'State' => [ + 'description' => '作业状态。可能值：（PBS集群/Slurm集群）'."\n" + .'- FINISHED/Completed：已完成。'."\n" + .'- RUNNING/Running：运行中。'."\n" + .'- QUEUED/Pending：排队等待。'."\n" + .'- FAILED/Failed：执行失败。', + 'type' => 'string', + 'example' => 'Running', + ], + 'StderrPath' => [ + 'description' => '错误输出路径。', + 'type' => 'string', + 'example' => './Temp', + ], + 'StdoutPath' => [ + 'description' => '标准输出路径。', + 'type' => 'string', + 'example' => './Temp', + ], + 'Priority' => [ + 'description' => '处理作业的优先级。取值范围：0~9，取值越大，优先级越高。', + 'type' => 'string', + 'example' => '0', + ], + 'ArrayRequest' => [ + 'description' => '队列作业格式。'."\n" + .'- 如果不是队列作业，输出为空。'."\n" + .'- 格式为 X-Y:Z， 最小值X是第一个索引，最大值Y是最后一个索引，Z表示步长，例如 2-7:2，表示作业队列包含编号为 2、4、6 的 3 个子作业。', + 'type' => 'string', + 'example' => '1-5:2', + ], + 'LastModifyTime' => [ + 'description' => '作业最后更新时间。', + 'type' => 'string', + 'example' => '1724123085', + ], + 'NodeList' => [ + 'description' => '运行作业的计算节点列表。', + 'type' => 'string', + 'example' => 'compute[002,005,003]', + ], + 'SubmitTime' => [ + 'description' => '作业提交时间。', + 'type' => 'string', + 'example' => '1724122486', + ], + 'JobQueue' => [ + 'description' => '执行作业的队列名。', + 'type' => 'string', + 'example' => 'comp', + ], + 'Variables' => [ + 'description' => '作业的变量列表。', + '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"}', + ], + 'Resources' => [ + 'description' => '作业运行所需资源信息。', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '运行作业的计算节点数量。', + 'type' => 'string', + 'example' => '3', + ], + 'Cores' => [ + 'description' => '运行作业的CPU核数。', + 'type' => 'string', + 'example' => '6', + ], + 'Memory' => [ + 'description' => '运行作业的内存大小。', + 'type' => 'string', + 'example' => '1536MB', + ], + 'Gpus' => [ + 'description' => '运行作业的GPU数量。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'ArrayJobId' => [ + 'description' => '数组作业ID。', + 'type' => 'string', + 'example' => '4', + ], + 'ArrayJobSubId' => [ + 'description' => '数组子作业ID。', + 'type' => 'string', + 'example' => '1', + ], + 'ResourcesActualOccupied' => [ + 'description' => '作业程序实际占用资源。', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '计算节点数。', + 'type' => 'string', + 'example' => '2', + ], + 'Cores' => [ + 'description' => 'CPU核数。', + 'type' => 'string', + 'example' => '4', + ], + 'Memory' => [ + 'description' => '内存数。', + 'type' => 'string', + 'example' => '982MB', + ], + 'Gpus' => [ + 'description' => 'CPU数。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'StartTime' => [ + 'description' => '作业开始时间。', + 'type' => 'string', + 'example' => '1724122486', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"EABFBD93-58BE-53F3-BBFE-8654BB2E****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Success\\": true,\\n \\"Jobs\\": [\\n {\\n \\"JobName\\": \\"testjob\\",\\n \\"JobSpec\\": {\\n \\"Id\\": \\"12\\",\\n \\"RunasUser\\": \\"testuser1\\",\\n \\"Comment\\": \\"jobDescription\\",\\n \\"State\\": \\"Running\\",\\n \\"StderrPath\\": \\"./Temp\\",\\n \\"StdoutPath\\": \\"./Temp\\",\\n \\"Priority\\": \\"0\\",\\n \\"ArrayRequest\\": \\"1-5:2\\",\\n \\"LastModifyTime\\": \\"1724123085\\",\\n \\"NodeList\\": \\"compute[002,005,003]\\",\\n \\"SubmitTime\\": \\"1724122486\\",\\n \\"JobQueue\\": \\"comp\\",\\n \\"Variables\\": \\"{\\\\\\"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 \\"Resources\\": {\\n \\"Nodes\\": \\"3\\",\\n \\"Cores\\": \\"6\\",\\n \\"Memory\\": \\"1536MB\\",\\n \\"Gpus\\": \\"0\\"\\n },\\n \\"ArrayJobId\\": \\"4\\",\\n \\"ArrayJobSubId\\": \\"1\\",\\n \\"ResourcesActualOccupied\\": {\\n \\"Nodes\\": \\"2\\",\\n \\"Cores\\": \\"4\\",\\n \\"Memory\\": \\"982MB\\",\\n \\"Gpus\\": \\"0\\"\\n },\\n \\"StartTime\\": \\"1724122486\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询作业列表', + ], + 'GetJobLog' => [ + 'summary' => '查询作业运行后的输出日志，包括标准输出日志和错误输出日志。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235286', + 'abilityTreeNodes' => [ + 'FEATUREehpc8EEMGZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1.manager', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => '日志类型。'."\n" + .'- stdout: 标准输出日志。'."\n" + .'- stderr: 错误输出日志。'."\n" + .'- all: 所有日志。'."\n" + ."\n" + .'默认值：all', + 'type' => 'string', + 'required' => false, + 'example' => 'stdout', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '单次请求读取的日志大小。'."\n" + ."\n" + .'单位：Byte'."\n" + ."\n" + .'默认值：10240', + 'type' => 'string', + 'required' => false, + 'example' => '20480', + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'description' => '日志读取的起始位置。'."\n" + ."\n" + .'单位：Byte'."\n" + ."\n" + .'默认值：0', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => '1.manager', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。取值范围：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'StdoutLog' => [ + 'description' => '标准输出日志内容，BASE64编码。', + 'type' => 'string', + 'example' => 'aG9zdG5hbWU=', + ], + 'StderrLog' => [ + 'description' => '错误输出日志内容，BASE64编码。', + 'type' => 'string', + 'example' => 'aG9zdG5hbWU=', + ], + 'StdoutLogSize' => [ + 'description' => '标准输出文件大小。', + 'type' => 'string', + 'example' => '4096', + ], + 'StderrLogSize' => [ + 'description' => '错误输出文件大小。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + ], + ], + '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.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B745C159-3155-4B94-95D0-4B73D4D2****\\",\\n \\"JobId\\": \\"1.manager\\",\\n \\"Success\\": \\"true\\",\\n \\"StdoutLog\\": \\"aG9zdG5hbWU=\\",\\n \\"StderrLog\\": \\"aG9zdG5hbWU=\\",\\n \\"StdoutLogSize\\": \\"4096\\",\\n \\"StderrLogSize\\": \\"0\\"\\n}","type":"json"}]', + 'title' => '查询作业输出日志', + 'description' => '## 接口说明'."\n" + .'目前仅支持标准版集群的Slurm和PBS Pro调度器。', + ], + 'GetJob' => [ + 'summary' => '获取指定作业的详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235267', + 'abilityTreeNodes' => [ + 'FEATUREehpcH08VYA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '作业ID。通过ListJobs接口返回。', + 'type' => 'string', + 'required' => true, + 'example' => '1.manager', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0****-1335-****-A1D7-6C044FE7****', + ], + 'JobInfo' => [ + 'description' => '作业详细信息。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => '1.manager', + ], + 'JobName' => [ + 'description' => '作业名称。', + 'type' => 'string', + 'example' => 'testJob'."\n", + ], + 'RunasUser' => [ + 'description' => '作业所属的用户，即提交作业时使用的用户。该用户为集群侧的用户。', + 'type' => 'string', + 'example' => 'testuser', + ], + 'State' => [ + 'description' => '作业状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'JobQueue' => [ + 'description' => '作业所属队列。', + 'type' => 'string', + 'example' => 'workq', + ], + 'CreateTime' => [ + 'description' => '作业提交时间。', + 'type' => 'string', + 'example' => '2024-08-16T10:52:48', + ], + 'LastModifyTime' => [ + 'description' => '作业状态最后修改时间。', + 'type' => 'string', + 'example' => '2024-08-16T10:52:48', + ], + 'ErrorLog' => [ + 'description' => '作业错误日志文件。', + 'type' => 'string', + 'example' => '/home/xxx/STDIN.e1', + ], + 'StartTime' => [ + 'description' => '作业启动时间。', + 'type' => 'string', + 'example' => '2024-08-16T10:52:48', + ], + 'Priority' => [ + 'description' => '作业优先级。', + 'type' => 'string', + 'example' => '0', + ], + 'CommandLine' => [ + 'description' => '作业执行命令。', + 'type' => 'string', + 'example' => '/home/huangsf/ehpc/job_meta.pbs', + ], + 'OutputLog' => [ + 'description' => '作业标准输出日志文件。', + 'type' => 'string', + 'example' => '/home/xxx/STDIN.o1', + ], + 'NodeList' => [ + 'description' => '作业执行节点列表。', + 'type' => 'string', + 'example' => 'compute000', + ], + 'ArrayRequest' => [ + 'description' => '作业队列参数。如果不是队列作业，输出为空。'."\n" + ."\n" + .'格式为X-Y:Z， 最小值X是第一个索引，最大值Y是最后一个索引，Z表示步长，例如2-7:2，表示作业队列包含编号为2、4、6的3个子作业。', + 'type' => 'string', + 'example' => '1-5:2', + ], + 'Resources' => [ + 'description' => '作业提交时申请的资源数量。', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '作业使用的节点数。', + 'type' => 'string', + 'example' => '1', + ], + 'Cores' => [ + 'description' => '作业在每个节点上使用的CPU核数。', + 'type' => 'string', + 'example' => '2', + ], + 'Memory' => [ + 'description' => '作业在每个节点上使用的内存大小。', + 'type' => 'string', + 'example' => '1gb', + ], + 'Gpus' => [ + 'description' => '作业在每个节点上使用的GPU数量。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'Variables' => [ + 'description' => '作业的变量列表。', + 'type' => 'array', + 'items' => [ + 'description' => '作业的环境变量。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '环境变量名称。', + 'type' => 'string', + 'example' => 'ProxyIP', + ], + 'Value' => [ + 'description' => '环境变量值。', + 'type' => 'string', + 'example' => '10.x.x.x', + ], + ], + ], + ], + 'ExtraInfo' => [ + 'description' => '其它信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'ResourcesUsed' => [ + 'description' => '作业实际使用的资源数量。', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => '作业使用的总节点数。', + 'type' => 'string', + 'example' => '2', + ], + 'Cores' => [ + 'description' => '作业在每个节点上使用的CPU核数。', + 'type' => 'string', + 'example' => '2', + ], + 'Memory' => [ + 'description' => '作业在每个节点上使用的内存大小。', + 'type' => 'string', + 'example' => '512mb', + ], + ], + ], + 'ArrayJobId' => [ + 'description' => '数组父作业ID，该返回值为非空字符串时，表示该作业是数组作业。', + 'type' => 'string', + 'example' => '1', + ], + 'ArrayJobSubId' => [ + 'description' => '数组子作业ID，ArrayJobId为非空字符串时有效。', + 'type' => 'string', + 'example' => '3', + ], + ], + ], + 'Success' => [ + 'description' => '请求结果，可能值：'."\n" + ."\n" + .'- true：请求成功。'."\n" + ."\n" + .'- false：请求失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed: %s', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0****-1335-****-A1D7-6C044FE7****\\",\\n \\"JobInfo\\": {\\n \\"JobId\\": \\"1.manager\\",\\n \\"JobName\\": \\"testJob\\\\n\\",\\n \\"RunasUser\\": \\"testuser\\",\\n \\"State\\": \\"Running\\",\\n \\"JobQueue\\": \\"workq\\",\\n \\"CreateTime\\": \\"2024-08-16T10:52:48\\",\\n \\"LastModifyTime\\": \\"2024-08-16T10:52:48\\",\\n \\"ErrorLog\\": \\"/home/xxx/STDIN.e1\\",\\n \\"StartTime\\": \\"2024-08-16T10:52:48\\",\\n \\"Priority\\": \\"0\\",\\n \\"CommandLine\\": \\"/home/huangsf/ehpc/job_meta.pbs\\",\\n \\"OutputLog\\": \\"/home/xxx/STDIN.o1\\",\\n \\"NodeList\\": \\"compute000\\",\\n \\"ArrayRequest\\": \\"1-5:2\\",\\n \\"Resources\\": {\\n \\"Nodes\\": \\"1\\",\\n \\"Cores\\": \\"2\\",\\n \\"Memory\\": \\"1gb\\",\\n \\"Gpus\\": \\"1\\"\\n },\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"ProxyIP\\",\\n \\"Value\\": \\"10.x.x.x\\"\\n }\\n ],\\n \\"ExtraInfo\\": \\"{}\\",\\n \\"ResourcesUsed\\": {\\n \\"Nodes\\": \\"2\\",\\n \\"Cores\\": \\"2\\",\\n \\"Memory\\": \\"512mb\\"\\n },\\n \\"ArrayJobId\\": \\"1\\",\\n \\"ArrayJobSubId\\": \\"3\\"\\n },\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '查询作业详情', + ], + 'StopJobs' => [ + 'summary' => '批量停止E-HPC集群中处于“未完成”状态的作业。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227790', + 'abilityTreeNodes' => [ + 'FEATUREehpcH08VYA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待停止的作业ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '作业ID。'."\n" + .'> 待停止的作业状态必须为 RUNNING 或 QUEUED。', + 'type' => 'string', + 'required' => false, + 'example' => '14', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F8868A00-6757-5542-BDD6-E1040D94****', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。可能值：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8868A00-6757-5542-BDD6-E1040D94****\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '批量停止作业', + ], + 'ListCommonLogs' => [ + 'summary' => '查询指定集群某一段时间内的日志列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227331', + 'abilityTreeNodes' => [ + 'FEATUREehpc8EEMGZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间点。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1703821542', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间点。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1703821666', + ], + ], + [ + 'name' => 'ActionName', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '操作名数组。', + 'type' => 'array', + 'items' => [ + 'description' => '操作名，作为查询过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateCluster', + ], + 'required' => false, + ], + ], + [ + 'name' => 'OperatorUid', + 'in' => 'query', + 'schema' => [ + 'description' => '操作账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '137***', + ], + ], + [ + 'name' => 'LogRequestId', + 'in' => 'query', + 'schema' => [ + 'description' => '操作的请求ID，作为查询过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + [ + 'name' => 'ActionStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '操作状态，作为查询过滤条件。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Finished' => '结束', + 'Failed' => '失败', + 'InProgress' => '运行中', + ], + 'example' => 'Finished', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => '日志类型，作为查询过滤条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'Operation', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'description' => '操作涉及的资源名，作为查询过滤条件。（不推荐）', + 'type' => 'string', + 'required' => false, + 'example' => 'i-abc***', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'起始值：1'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。取值范围：1~100'."\n" + ."\n" + .'默认值：20', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'IsReverse', + 'in' => 'query', + 'schema' => [ + 'description' => '是否逆序显示。'."\n" + ."\n" + .'默认值：true', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '464E9919-D04F-4D1D-B375-15989492****', + ], + 'Uid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '137***', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'Logs' => [ + 'description' => '操作日志简要信息数组。', + 'type' => 'array', + 'items' => [ + 'description' => '操作日志简要信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '操作日志的请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Time' => [ + 'description' => '日志发生时间。', + 'type' => 'string', + 'example' => '2024-08-22 14:21:54', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-9T3xPNezoS', + ], + 'OperatorUid' => [ + 'description' => '操作账号ID。', + 'type' => 'string', + 'example' => '137***', + ], + 'Action' => [ + 'description' => '操作日志对应的操作名。', + 'type' => 'string', + 'example' => 'CreaterCluster', + ], + 'Status' => [ + 'description' => '日志状态。可能值：'."\n" + ."\n" + .'- InProgress：运行中'."\n" + .'- Finished：结束'."\n" + .'- Failed：失败', + 'type' => 'string', + 'example' => 'Finished', + ], + 'LogType' => [ + 'description' => '日志类型', + 'type' => 'string', + 'example' => 'Operation', + ], + 'Target' => [ + 'description' => '操作资源。', + 'type' => 'string', + 'example' => 'i-abc***', + ], + 'Message' => [ + 'description' => '日志输出简要信息。', + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"464E9919-D04F-4D1D-B375-15989492****\\",\\n \\"Uid\\": \\"137***\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 15,\\n \\"Logs\\": [\\n {\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"Time\\": \\"2024-08-22 14:21:54\\",\\n \\"ClusterId\\": \\"ehpc-hz-9T3xPNezoS\\",\\n \\"OperatorUid\\": \\"137***\\",\\n \\"Action\\": \\"CreaterCluster\\",\\n \\"Status\\": \\"Finished\\",\\n \\"LogType\\": \\"Operation\\",\\n \\"Target\\": \\"i-abc***\\",\\n \\"Message\\": \\"ok\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群日志列表', + ], + 'GetCommonLogDetail' => [ + 'summary' => '根据具体操作的请求ID查询日志，通过将操作日志拆分成 Action-Stage-Method 三层日志结构，能够详细罗列出各操作涉及到的详细步骤日志。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREehpc8EEMGZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间点。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1703821542', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间点。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1703821666', + ], + ], + [ + 'name' => 'LogRequestId', + 'in' => 'query', + 'schema' => [ + 'description' => '具体操作的请求ID。', + 'type' => 'string', + 'required' => true, + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n", + ], + ], + [ + 'name' => 'HiddenProcess', + 'in' => 'query', + 'schema' => [ + 'description' => '是否隐藏详细日志过程。'."\n" + .'- true： 隐藏具体日志过程，只展示每一个日志步骤的结果日志'."\n" + .'- false：不隐藏具体日志过程，展示每一个日志步骤的开始/结果日志'."\n" + ."\n" + .'默认为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '464E9919-D04F-4D1D-B375-15989492****'."\n", + ], + 'Uid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '137***', + ], + 'OperatorUid' => [ + 'description' => '操作账号ID。', + 'type' => 'string', + 'example' => '239***', + ], + 'Action' => [ + 'description' => '操作名。', + 'type' => 'string', + 'example' => 'CreateCluster', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'ehpc-hz-abc***', + ], + 'LogType' => [ + 'description' => '日志类型。', + 'type' => 'string', + 'example' => 'operation', + ], + 'LogDetail' => [ + 'description' => '详细日志信息数组。', + 'type' => 'array', + 'items' => [ + 'description' => '详细日志信息。', + 'type' => 'object', + 'properties' => [ + 'StageName' => [ + 'description' => '日志阶段名。', + 'type' => 'string', + 'example' => 'ConfigNetwork', + ], + 'Stages' => [ + 'description' => '日志阶段对象数组。', + 'type' => 'array', + 'items' => [ + 'description' => '日志阶段对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '详细日志条目的请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Time' => [ + 'description' => '详细日志条目的产生时间。', + 'type' => 'string', + 'example' => '2024-08-22 14:21:54'."\n", + ], + 'Method' => [ + 'description' => '详细日志条目的方法名。', + 'type' => 'string', + 'example' => 'CreateSecurityGroup', + ], + 'Status' => [ + 'description' => '详细日志条目的状态。可能值：'."\n" + ."\n" + .'- InProgress：运行中'."\n" + .'- Finished：结束'."\n" + .'- Failed：失败', + 'type' => 'string', + 'example' => 'Finished', + ], + 'LogLevel' => [ + 'description' => '详细日志条目的日志等级。', + 'type' => 'string', + 'enumValueTitles' => [ + 'ERROR' => '错误', + 'INFO' => '信息', + 'WARN' => '警告', + ], + 'example' => 'INFO', + ], + 'Target' => [ + 'description' => '详细日志条目的操作资源。', + 'type' => 'string', + 'example' => 'sg-bcd***', + ], + 'Message' => [ + 'description' => '详细日志条目的输出信息。', + 'type' => 'string', + 'example' => 'Successfully created security group sg-bcd***', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"464E9919-D04F-4D1D-B375-15989492****\\\\n\\",\\n \\"Uid\\": \\"137***\\",\\n \\"OperatorUid\\": \\"239***\\",\\n \\"Action\\": \\"CreateCluster\\",\\n \\"ClusterId\\": \\"ehpc-hz-abc***\\",\\n \\"LogType\\": \\"operation\\",\\n \\"LogDetail\\": [\\n {\\n \\"StageName\\": \\"ConfigNetwork\\",\\n \\"Stages\\": [\\n {\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\",\\n \\"Time\\": \\"2024-08-22 14:21:54\\\\n\\",\\n \\"Method\\": \\"CreateSecurityGroup\\",\\n \\"Status\\": \\"Finished\\",\\n \\"LogLevel\\": \\"INFO\\",\\n \\"Target\\": \\"sg-bcd***\\",\\n \\"Message\\": \\"Successfully created security group sg-bcd***\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群详细日志信息', + ], + 'AttachNodes' => [ + 'summary' => '将不属于E-HPC的ECS添加到E-HPC集群，作为E-HPC集群计算节点进行管理和操作。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '269549', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-xxxxxxx', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'title' => '队列名', + 'description' => '队列名，实例将被添加到该队列。', + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + ], + [ + 'name' => 'ComputeNode', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '计算节点信息', + 'description' => '计算节点信息。', + 'type' => 'object', + 'properties' => [ + 'InstanceIds' => [ + 'title' => '实例ID数组', + 'description' => '实例ID数组。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-xxxxxxxx', + ], + 'required' => true, + ], + 'ImageId' => [ + 'title' => '镜像ID。纳管后将使用该镜像替换原有系统盘镜像。', + 'description' => '镜像ID。接口将使用该镜像替换原有系统盘镜像。', + 'type' => 'string', + 'required' => true, + 'example' => 'm-bp1h765oyqyxxxxxxxxx', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2263XXXX-XXXX-XXXX-XXXX-XXXX2448XXXX', + ], + 'Success' => [ + 'description' => '请求结果。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'Invalid parameters: %s.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2263XXXX-XXXX-XXXX-XXXX-XXXX2448XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '添加游离节点', + 'description' => '将ECS实例添加到指定的E-HPC集群之前，实例需满足以下条件：'."\n" + .' - 不能添加已经属于某个E-HPC集群的实例；'."\n" + .' - 待添加的实例必须和集群在同一个VPC；'."\n" + .' - 待添加的实例必须处于停机状态；'."\n" + ."\n" + .'添加实例有以下限制：'."\n" + .'- 支持指定多个实例ID批量添加，但批量添加的节点必须是相同实例规格；'."\n" + .'- 实例加入集群时，将使用入参指定的镜像[重置系统盘](https://help.aliyun.com/zh/ecs/user-guide/re-initialize-a-system-disk)；'."\n" + .'- 原实例如果有数据盘，添加后不会自动创建和挂载；'."\n" + .'- 不会修改当前实例主机名，因此调用者需确保待添加的实例主机名不能与集群已有节点的主机名重复；', + ], + 'ListRegions' => [ + 'summary' => '查询产品支持的地域列表。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREehpcOQU2XV', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SpecCode', + 'in' => 'query', + 'schema' => [ + 'description' => '商品名称，默认值 Next。可选值如下：'."\n" + .'- Next：E-HPC Cluster（原E-HPC NEXT）商品'."\n" + .'- Instant：E-HPC Instant商品', + 'type' => 'string', + 'required' => false, + 'example' => 'Next', + 'enum' => [ + 'Next', + 'Instant', + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '返回值语言，默认值 zh-CN，可选值如下：'."\n" + ."\n" + .'- zh-CN（默认值）：中文。'."\n" + ."\n" + .'- en-US：英文。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + 'enum' => [ + 'zh-CN', + 'en-US', + ], + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：1~100。'."\n" + ."\n" + .'默认值：20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0axxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '本次请求条件下的数据总量。 '."\n" + .'此参数为可选参数，默认可不返回。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'MaxResults' => [ + 'description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：1~100。'."\n" + ."\n" + .'默认值：20。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'NextToken' => [ + 'description' => '下一个查询开始Token。', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0axxxx', + ], + 'Regions' => [ + 'description' => '可用地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '可用地域详情。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域 Id。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'LocalName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => '华东1（杭州）', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"TotalCount\\": 16,\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0axxxx\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LocalName\\": \\"华东1（杭州）\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询可以使用E-HPC的地域列表', + ], + 'CreateReservedNodePool' => [ + 'summary' => '创建预设节点池。预设节点池会预占用VSwitch下的批量可用IP，一一映射到根据规则生成的主机名上，并维护该映射表对应的节点池资源。当后续使用预设节点池来扩容/缩容节点时，会实际占用/释放对应预设节点池的资源。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '258584', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '预设节点池名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'nodepool', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '预设节点池描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Count', + 'in' => 'query', + 'schema' => [ + 'description' => '预设节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + ], + [ + 'name' => 'HostPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => '预设节点主机前缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud', + ], + ], + [ + 'name' => 'HostPostfix', + 'in' => 'query', + 'schema' => [ + 'description' => '预设节点主机后缀。', + 'type' => 'string', + 'required' => false, + 'example' => 'ed', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ReservedNodePoolId' => [ + 'description' => '预设节点池ID。', + 'type' => 'string', + 'example' => 'rnp-cdx****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'InvalidVswitch', + 'errorMessage' => 'The vSwitch parameter is invalid, or the number of available IP addresses is insufficient.', + ], + [ + 'errorCode' => 'FailToGenId', + 'errorMessage' => 'Generating cluster ID failed.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + [ + 'errorCode' => 'VswitchOccupied', + 'errorMessage' => 'The vSwitch resource is occupied by other reserved nodepool.', + ], + ], + 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 \\"ReservedNodePoolId\\": \\"rnp-cdx****\\"\\n}","type":"json"}]', + 'title' => '创建预设节点池', + ], + 'DeleteReservedNodePool' => [ + 'summary' => '删除指定的预设节点池。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '259198', + 'abilityTreeNodes' => [ + 'FEATUREehpcQU2WXS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '预设节点池ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rnp-cdx****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + '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.', + ], + [ + 'errorCode' => 'RervedNodePoolNotFound', + 'errorMessage' => 'The reserved nodepool is not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database service error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","type":"json"}]', + 'title' => '删除预设节点池', + ], + ], + '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', + ], + ], +]; |