diff options
Diffstat (limited to 'data/zh_cn/ehpc/2024-07-30')
| -rw-r--r-- | data/zh_cn/ehpc/2024-07-30/api-docs.php | 10728 |
1 files changed, 10728 insertions, 0 deletions
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', + ], + ], +]; |