diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/ehpc/2024-07-30/api-docs.php | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/ehpc/2024-07-30/api-docs.php')
| -rw-r--r-- | data/en_us/ehpc/2024-07-30/api-docs.php | 10922 |
1 files changed, 10922 insertions, 0 deletions
diff --git a/data/en_us/ehpc/2024-07-30/api-docs.php b/data/en_us/ehpc/2024-07-30/api-docs.php new file mode 100644 index 0000000..f3ce15c --- /dev/null +++ b/data/en_us/ehpc/2024-07-30/api-docs.php @@ -0,0 +1,10922 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'EHPC', + 'version' => '2024-07-30', + ], + 'directories' => [ + [ + 'id' => 196224, + 'title' => 'Cluster', + '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' => 'User', + 'type' => 'directory', + 'children' => [ + 'CreateUsers', + 'UpdateUser', + 'ListUsers', + 'DeleteUsers', + ], + ], + [ + 'id' => 196254, + 'title' => 'Nodes and Queues', + 'type' => 'directory', + 'children' => [ + 'CreateQueue', + 'CreateNodes', + 'UpdateQueue', + 'UpdateNodes', + 'ListQueues', + 'ListNodes', + 'GetQueue', + 'DeleteQueues', + 'DeleteNodes', + ], + ], + [ + 'id' => 196454, + 'title' => 'Operation', + 'type' => 'directory', + 'children' => [ + 'CreateJob', + 'ListJobs', + 'GetJobLog', + 'GetJob', + 'StopJobs', + ], + ], + [ + 'id' => 196273, + 'title' => 'Monitoring and Logging', + 'type' => 'directory', + 'children' => [ + 'ListCommonLogs', + 'GetCommonLogDetail', + ], + ], + [ + 'id' => 365937, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AttachNodes', + 'ListRegions', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'CreateReservedNodePool', + 'DeleteReservedNodePool', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AddonNodeTemplate' => [ + 'title' => 'A short description of struct', + 'description' => 'The common descriptions of Elastic Compute Service (ECS) resources, such as the billing method, instance type, image, system disk, and data disk.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'title' => 'InstanceType', + 'description' => 'The ECS instance type.'."\n" + ."\n" + .'* To select an appropriate instance type, you can see [Instance families](https://help.aliyun.com/zh/ecs/user-guide/overview-of-instance-families?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) or call the [DescribeInstanceTypes](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeinstancetypes?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) operation to learn the performance data about instance types.'."\n" + .'* To query the inventory of instance types in specified region or zone, you can call the [DescribeAvailableResource](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeavailableresource?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) operation.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs.c7.4xlarge', + 'backendName' => 'InstanceType', + ], + 'InstanceId' => [ + 'title' => 'InstanceId', + 'description' => 'The instance ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'i-bp1bzqq4rj1eemun****', + 'backendName' => 'InstanceId', + ], + 'PrivateIpAddress' => [ + 'title' => 'PrivateIpAddress', + 'description' => 'The IP address of the virtual private cloud (VPC) in which the ECS instance is deployed.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '172.16.**.**', + 'backendName' => 'PrivateIpAddress', + ], + 'ImageId' => [ + 'title' => 'ImageId', + 'description' => 'The ID of the image to be used for instance booting. You can call the [DescribeImages](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeimages?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) operation to query the available image resources.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyun_3_x64_20G_alibase_20221102.vhd', + 'backendName' => 'ImageId', + ], + 'OsName' => [ + 'title' => 'OsName', + 'description' => 'OsName'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => '', + 'backendName' => 'OsName', + ], + 'OsNameEN' => [ + 'title' => 'OsNameEN', + 'description' => 'OsNameEN'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'CentOS 7.6 64 bit', + 'backendName' => 'OsNameEN', + ], + 'InstanceChargeType' => [ + 'title' => 'InstanceChargeType', + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* Prepaid: subscription'."\n" + .'* PostPaid: pay-as-you-go'."\n" + ."\n" + .'Default value: PostPaid.'."\n" + ."\n" + .'If you set this parameter to PrePaid, you must make sure that your account supports payment by balance or credit. Otherwise, the InvalidPayMethod error message will be returned.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'PostPaid', + 'backendName' => 'InstanceChargeType', + ], + 'PeriodUnit' => [ + 'title' => 'PeriodUnit', + 'description' => 'The unit of the subscription period. Valid values:'."\n" + ."\n" + .'* Week'."\n" + .'* Month (default)'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Month', + 'backendName' => 'PeriodUnit', + ], + 'Period' => [ + 'title' => 'Period', + 'description' => 'The subscription period of the instance. The unit is specified by the PeriodUnit parameter. This parameter takes effect and is required only when InstanceChargeType is set to PrePaid. If the DedicatedHostId parameter is specified, the subscription duration of the instance must be no longer than that of the dedicated host. Valid values:'."\n" + ."\n" + .'* Valid values when PeriodUnit is set to Week: 1, 2, 3, and 4'."\n" + .'* Valid values when PeriodUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'Period', + ], + 'AutoRenew' => [ + 'title' => 'AutoRenew', + 'description' => 'Specifies whether to enable auto-renewal for the reserved instance. This parameter takes effect only when InstanceChargeType is set to PrePaid. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'AutoRenew', + ], + 'AutoRenewPeriod' => [ + 'title' => 'AutoRenewPeriod', + 'description' => 'The auto-renewal period. Valid values:'."\n" + ."\n" + .'* Valid values when PeriodUnit is set to Week: 1, 2, and 3'."\n" + .'* Valid values when PeriodUnit is set to Month: 1, 2, 3, 6, 12, 24, 36, 48, and 60'."\n" + ."\n" + .'Default value: 1.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'AutoRenewPeriod', + ], + 'SpotStrategy' => [ + 'title' => 'SpotStrategy', + 'description' => 'The bidding policy for the pay-as-you-go instance. This parameter is valid only when InstanceChargeType is set to PostPaid. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instances are created as preemptible instances for which the market price at the time of purchase is automatically used as the bidding price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'NoSpot', + 'backendName' => 'SpotStrategy', + ], + 'SpotPriceLimit' => [ + 'title' => 'SpotPriceLimit', + 'description' => 'The maximum hourly price of the preemptible instance. This parameter takes effect only when SpotStrategy is set to SpotWithPriceLimit. A maximum of three decimal places can be specified.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.97', + 'backendName' => 'SpotPriceLimit', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => 'The protection period for the preemptible instance. Unit: hours. Default value: 1. Valid values:'."\n" + ."\n" + .'* 1: After a preemptible instance is created, Alibaba Cloud ensures that the instance is not automatically released within one hour. After the one-hour protection period ends, the system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance.'."\n" + .'* 0: After a preemptible instance is created, Alibaba Cloud does not ensure that the instance runs for one hour. The system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance.'."\n" + ."\n" + .'Alibaba Cloud sends an ECS system event to notify you five minutes before the instance is released. Preemptible instances are billed by second. We recommend that you specify an appropriate protection period based on your business requirements.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'Duration', + ], + 'EnableHT' => [ + 'title' => 'EnableHT', + 'description' => 'Specifies whether to enable hyper-threading for the node. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'EnableHT', + ], + 'SystemDisk' => [ + 'title' => 'SystemDisk', + 'description' => 'The system disk configurations of the node.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => 'Category', + 'description' => 'The category of the system disk. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: utra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: enterprise SSD (ESSD)'."\n" + .'* cloud: basic disk'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'cloud_essd', + 'backendName' => 'Category', + ], + 'Size' => [ + 'title' => 'Size', + 'description' => 'The disk size. Unit: GiB. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: 40 to 32,768'."\n" + ."\n" + .'* cloud_ssd: 40 to 32,768'."\n" + ."\n" + .'* Valid values when Category is set to cloud_essd depends on the value of the DataDisk.N.PerformanceLevel parameter. Specifically:'."\n" + ."\n" + .' * PL0: 40 to 65,536'."\n" + .' * PL1: 40 to 65,536'."\n" + .' * PL2: 461 to 65,536'."\n" + .' * PL3: 1,261 to 65,536'."\n" + ."\n" + .'* cloud: 40 to 500'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + 'backendName' => 'Size', + ], + 'Level' => [ + 'title' => 'Level', + 'description' => 'The performance level of the ESSD that is used as the system disk. Valid values:'."\n" + ."\n" + .'* PL0: A single ESSD can deliver up to 10000 random read/write IOPS.'."\n" + .'* PL1 (default): A single ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: A single ESSD can deliver up to 100000 random read/write IOPS.'."\n" + .'* PL3: A single ESSD can deliver up to 1000000 random read/write IOPS. For more information about ESSD performance levels, see [ESSDs](https://help.aliyun.com/zh/ecs/user-guide/essds?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX).'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'PL0', + 'backendName' => 'Level', + ], + ], + 'backendName' => 'SystemDisk', + ], + 'DataDisks' => [ + 'title' => 'DataDisk', + 'description' => 'The data disks.'."\n" + ."\n" + .'> You can specify up to 16 data disks.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the data disk.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => 'Category', + 'description' => 'The disk category. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: utra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: ESSD'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'cloud_essd', + 'backendName' => 'Category', + ], + 'Size' => [ + 'title' => 'Size', + 'description' => 'The disk size. Valid values of N: 1 to 16. Unit: GiB. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: 40 to 32,768'."\n" + ."\n" + .'* cloud_ssd: 40 to 32,768'."\n" + ."\n" + .'* Valid values when Category is set to cloud_essd depends on the value of the DataDisk.N.PerformanceLevel parameter. Specifically:'."\n" + ."\n" + .' * PL0: 40 to 65,536'."\n" + .' * PL1: 40 to 65,536'."\n" + .' * PL2: 461 to 65,536'."\n" + .' * PL3: 1,261 to 65,536'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + 'backendName' => 'Size', + ], + 'Level' => [ + 'title' => 'Level', + 'description' => 'The performance level of the ESSD to be used as the data disk. Valid values:'."\n" + ."\n" + .'* PL0: A single ESSD can deliver up to 10000 random read/write IOPS.'."\n" + .'* PL1 (default): A single ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: A single ESSD can deliver up to 100000 random read/write IOPS.'."\n" + .'* PL3: A single ESSD can deliver up to 1000000 random read/write IOPS. For more information about ESSD performance levels, see [ESSDs](https://help.aliyun.com/zh/ecs/user-guide/essds?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX).'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'PL0', + 'backendName' => 'Level', + ], + 'DeleteWithInstance' => [ + 'title' => 'DeleteWithInstance', + 'description' => 'Specifies whether to release data disk N when the instance is released. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: true.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'DeleteWithInstance', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'DataDisks', + ], + ], + ], + 'NodeTemplate' => [ + 'title' => '', + 'description' => 'Common information about Elastic Compute Service (ECS) resources, including their billing methods, types, images, system disks, and data disks.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'InstanceType' => [ + 'title' => 'InstanceTypes', + 'description' => 'The ECS instance type.'."\n" + ."\n" + .'* To select an appropriate instance type, you can see [Instance families](https://help.aliyun.com/zh/ecs/user-guide/overview-of-instance-families?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) or call the [DescribeInstanceTypes](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeinstancetypes?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) operation to learn the performance data about instance types.'."\n" + .'* To query the inventory of instance types in specified region or zone, you can call the [DescribeAvailableResource](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeavailableresource?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) operation.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c7.4xlarge', + 'backendName' => 'InstanceType', + ], + 'ImageId' => [ + 'title' => 'ImageId', + 'description' => 'The ID of the image to be used for instance booting. You can call the [DescribeImages](https://help.aliyun.com/zh/ecs/developer-reference/api-ecs-2014-05-26-describeimages?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX) operation to query the available image resources.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun_3_x64_20G_alibase_20221102.vhd', + 'backendName' => 'ImageId', + ], + 'InstanceChargeType' => [ + 'title' => 'InstanceChargeType', + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* PrePaid: subscription'."\n" + .'* PostPaid: pay-as-you-go'."\n" + ."\n" + .'Default value: PostPaid.'."\n" + ."\n" + .'If you set this parameter to PrePaid, you must make sure that your account supports payment by balance or credit. Otherwise, the InvalidPayMethod error message will be returned.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'PostPaid', + 'backendName' => 'InstanceChargeType', + ], + 'PeriodUnit' => [ + 'title' => 'PeriodUnit', + 'description' => 'The unit of the subscription period. Valid values:'."\n" + ."\n" + .'* Week'."\n" + .'* Month (default)'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'Month', + 'backendName' => 'PeriodUnit', + ], + 'Period' => [ + 'title' => 'Period', + 'description' => 'The subscription period of the instance. The unit is specified by the PeriodUnit parameter. This parameter takes effect and is required only when InstanceChargeType is set to PrePaid. If the DedicatedHostId parameter is specified, the subscription duration of the instance must be no longer than that of the dedicated host. Valid values:'."\n" + ."\n" + .'* Valid values when PeriodUnit is set to Week: 1, 2, 3, and 4'."\n" + .'* Valid values when PeriodUnit is set to Month: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36, 48, and 60'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'Period', + ], + 'AutoRenew' => [ + 'title' => 'AutoRenew', + 'description' => 'Specifies whether to enable auto-renewal. This parameter takes effect only when InstanceChargeType is set to PrePaid. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'AutoRenew', + ], + 'AutoRenewPeriod' => [ + 'title' => 'AutoRenewPeriod', + 'description' => 'The auto-renewal period. Valid values:'."\n" + ."\n" + .'* Valid values when PeriodUnit is set to Week: 1, 2, and 3'."\n" + .'* Valid values when PeriodUnit is set to Month: 1, 2, 3, 6, 12, 24, 36, 48, and 60'."\n" + ."\n" + .'Default value: 1.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'AutoRenewPeriod', + ], + 'SpotStrategy' => [ + 'title' => 'SpotStrategy', + 'description' => 'The bidding policy for the pay-as-you-go instance. This parameter is valid only when InstanceChargeType is set to PostPaid. Valid values:'."\n" + ."\n" + .'* NoSpot: The instance is created as a pay-as-you-go instance.'."\n" + .'* SpotWithPriceLimit: The instance is created as a preemptible instance with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The instance is created as a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.'."\n" + ."\n" + .'Default value: NoSpot.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'NoSpot', + 'backendName' => 'SpotStrategy', + ], + 'SpotPriceLimit' => [ + 'title' => 'SpotPriceLimit', + 'description' => 'The maximum hourly price of the preemptible instance. This parameter takes effect only when SpotStrategy is set to SpotWithPriceLimit. A maximum of three decimal places can be specified.'."\n", + 'visibility' => 'Public', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.97', + 'backendName' => 'SpotPriceLimit', + ], + 'Duration' => [ + 'title' => 'Duration', + 'description' => 'The protection period for the preemptible instance. Unit: hours. Default value: 1. Valid values:'."\n" + ."\n" + .'* 1: After a preemptible instance is created, Alibaba Cloud ensures that the instance is not automatically released within one hour. After the one-hour protection period ends, the system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance.'."\n" + .'* 0: After a preemptible instance is created, Alibaba Cloud does not ensure that the instance runs for one hour. The system compares the bid price with the market price and checks the resource inventory to determine whether to retain or release the instance.'."\n" + ."\n" + .'Alibaba Cloud sends an ECS system event to notify you five minutes before the instance is released. The preemptible instance is billed by second. We recommend that you specify an appropriate protection period based on your business requirements.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'backendName' => 'Duration', + ], + 'EnableHT' => [ + 'title' => 'EnableHT', + 'description' => 'Specifies whether to enable hyper-threading for the node. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'EnableHT', + ], + 'SystemDisk' => [ + 'title' => 'SystemDisk', + 'description' => 'The system disk configurations of the node.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => 'Category', + 'description' => 'The category of the system disk. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: utra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: Enterprise SSD (ESSD)'."\n" + .'* cloud: basic disk'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'cloud_essd', + 'backendName' => 'Category', + ], + 'Size' => [ + 'title' => 'Size', + 'description' => 'The disk size. Unit: GiB. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: 40 to 32,768'."\n" + ."\n" + .'* cloud_ssd: 40 to 32,768'."\n" + ."\n" + .'* Valid values when Category is set to cloud_essd depends on the value of the DataDisk.N.PerformanceLevel parameter. Specifically:'."\n" + ."\n" + .' * PL0: 40 to 65,536'."\n" + .' * PL1: 40 to 65,536'."\n" + .' * PL2: 461 to 65,536'."\n" + .' * PL3: 1,261 to 65,536'."\n" + ."\n" + .'* cloud: 40 to 500'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + 'backendName' => 'Size', + ], + 'Level' => [ + 'title' => 'Level', + 'description' => 'The performance level of the ESSD that is used as the system disk. Valid values:'."\n" + ."\n" + .'* PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1 (default): A single ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS. For more information about ESSD performance levels, see [ESSDs](https://help.aliyun.com/zh/ecs/user-guide/essds?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX).'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'PL0', + 'backendName' => 'Level', + ], + ], + 'backendName' => 'SystemDisk', + ], + 'DataDisks' => [ + 'title' => 'DataDisk', + 'description' => 'The data disks.'."\n" + ."\n" + .'> You can specify up to 16 data disks.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the data disk.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => 'Category', + 'description' => 'The disk category. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: utra disk'."\n" + .'* cloud_ssd: standard SSD'."\n" + .'* cloud_essd: ESSD'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'cloud_essd', + 'backendName' => 'Category', + ], + 'Size' => [ + 'title' => 'Size', + 'description' => 'The disk size. Valid values of N: 1 to 16. Unit: GiB. Valid values:'."\n" + ."\n" + .'* cloud_efficiency: 40 to 32,768'."\n" + ."\n" + .'* cloud_ssd: 40 to 32,768'."\n" + ."\n" + .'* Valid values when Category is set to cloud_essd depends on the value of the DataDisk.N.PerformanceLevel parameter. Specifically:'."\n" + ."\n" + .' * PL0: 40 to 65,536'."\n" + .' * PL1: 40 to 65,536'."\n" + .' * PL2: 461 to 65,536'."\n" + .' * PL3: 1,261 to 65,536'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + 'backendName' => 'Size', + ], + 'Level' => [ + 'title' => 'Level', + 'description' => 'The performance level of the ESSD that is used as a data disk. Valid values:'."\n" + ."\n" + .'* PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.'."\n" + .'* PL1 (default): A single ESSD can deliver up to 50,000 random read/write IOPS.'."\n" + .'* PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.'."\n" + .'* PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS. For more information about ESSD performance levels, see [ESSDs](https://help.aliyun.com/zh/ecs/user-guide/essds?spm=api-workbench.API%20Document.0.0.7e5caef0GBcMYX).'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'PL0', + 'backendName' => 'Level', + ], + 'DeleteWithInstance' => [ + 'title' => 'DeleteWithInstance', + 'description' => 'Specifies whether to release data disk N when the instance is released. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: true.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'false', + 'backendName' => 'DeleteWithInstance', + ], + 'MountDir' => [ + 'title' => 'MountDir', + 'description' => 'MountDir'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '/data1', + 'backendName' => 'MountDir', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'DataDisks', + ], + ], + ], + 'QueueTemplate' => [ + 'title' => 'A description of struct', + 'description' => 'The queue configuration template.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'QueueName' => [ + 'title' => 'QueueName', + 'description' => 'The queue name. The name must be 1 to 15 characters in length and can contain letters, digits, and periods (.).'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => true, + 'example' => 'comp', + 'backendName' => 'Name', + ], + 'EnableScaleOut' => [ + 'title' => 'EnableScaleOut', + 'description' => 'Specifies whether to enable auto scale-out for the queue. Valid values:'."\n" + ."\n" + .'* true: enables auto scale-out.'."\n" + .'* false: disables auto scale-out.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'EnableScaleOut', + ], + 'EnableScaleIn' => [ + 'title' => 'EnableScaleIn', + 'description' => 'Specifies whether to enable auto scale-in for the queue. Valid values:'."\n" + ."\n" + .'* true: enables auto scale-in.'."\n" + .'* false: disables auto scale-in.'."\n", + 'visibility' => 'Public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'EnableScaleIn', + ], + 'MinCount' => [ + 'title' => 'MinCount', + 'description' => 'The minimum number of compute nodes that the queue must contain.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'backendName' => 'MinCount', + ], + 'MaxCount' => [ + 'title' => 'MaxCount', + 'description' => 'The maximum number of compute nodes that the queue can contain.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + 'backendName' => 'MaxCount', + ], + 'InitialCount' => [ + 'title' => 'InitialCount', + 'description' => 'The initial number of compute nodes in the queue.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'backendName' => 'InitialCount', + ], + 'InterConnect' => [ + 'title' => 'HPCInterConnect', + 'description' => 'The type of the network between compute nodes in the queue. Valid values:'."\n" + ."\n" + .'* vpc'."\n" + .'* eRDMA'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'erdma', + 'backendName' => 'HPCInterConnect', + ], + 'VSwitchIds' => [ + 'title' => 'VSwitchIds', + 'description' => 'The available vSwitches for compute nodes in the queue. Valid values of N: 1 to 5.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch ID.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'VSwitchId', + 'extendType' => 'true', + ], + 'backendName' => 'VSwitchIds', + 'itemName' => 'VSwitchId', + ], + 'ComputeNodes' => [ + 'title' => 'Resources', + 'description' => 'The hardware configurations of the compute nodes in the queue. Valid values of N: 0 to 10.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The hardware configuration of the compute node.'."\n", + 'visibility' => 'Public', + 'extendType' => 'true', + '$ref' => '#/components/schemas/NodeTemplate', + ], + 'backendName' => 'ComputeNodes', + ], + 'AllocationStrategy' => [ + 'title' => 'AllocationStrategy', + 'description' => 'The auto scaling policy for the queue.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'PriorityInstanceType', + 'backendName' => 'AllocationStrategy', + ], + 'RamRole' => [ + 'title' => 'RamRole', + 'description' => 'The role that is assumed by compute nodes in the queue.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'AliyunECSInstanceForEHPCRole', + 'backendName' => 'RamRole', + ], + 'HostnamePrefix' => [ + 'title' => 'HostNamePrefix', + 'description' => 'The hostname prefix of the compute nodes in the queue.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'compute', + 'backendName' => 'HostnamePrefix', + ], + 'HostnameSuffix' => [ + 'title' => 'HostNameSuffix', + 'description' => 'The hostname suffix of the compute nodes in the queue.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'demo', + 'backendName' => 'HostnameSuffix', + ], + 'KeepAliveNodes' => [ + 'title' => 'KeepAliveNodes', + 'description' => 'The nodes for which deletion protection is enabled in the queue.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The hostname of the node for which deletion protection is enabled.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'compute000', + 'extendType' => 'true', + ], + 'backendName' => 'KeepAliveNodes', + 'itemName' => 'KeepAliveNode', + ], + 'MaxCountPerCycle' => [ + 'title' => 'MaxCountPerCycle', + 'description' => 'The maximum number of compute nodes that can be added to the queue in each scale-out.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99', + 'backendName' => 'MaxCountPerCycle', + ], + ], + ], + 'SharedStorageTemplate' => [ + 'title' => '', + 'description' => 'The configurations of shared storage.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'MountDirectory' => [ + 'title' => '', + 'description' => 'The local mount directory of the attached file system.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '/home', + 'backendName' => 'MountDirectory', + ], + 'FileSystemId' => [ + 'title' => '', + 'description' => 'The ID of the mounted file system.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '008b63****', + 'backendName' => 'FileSystemId', + ], + 'NASDirectory' => [ + 'title' => '', + 'description' => 'The remote mount directory of the mounted file system.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '/', + 'backendName' => 'NASDirectory', + ], + 'MountTargetDomain' => [ + 'title' => '', + 'description' => 'The address of the mount point of the file system.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '008b****-sihc.cn-hangzhou.extreme.nas.aliyuncs.com', + 'backendName' => 'MountTargetDomain', + ], + 'ProtocolType' => [ + 'title' => '', + 'description' => 'The protocol type of the mounted file system. Valid values:'."\n" + ."\n" + .'* NFS'."\n" + .'* SMB'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'NFS', + 'backendName' => 'ProtocolType', + ], + 'MountOptions' => [ + 'title' => '', + 'description' => 'The storage mount options of the mounted file system.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '-t nfs -o vers=3,nolock,noresvport', + 'backendName' => 'MountOptions', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateCluster' => [ + 'summary' => 'Creates a pay-as-you-go or subscription Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster name. The name must be 1 to 128 characters in length and can contain letters, digits, hyphens (-), and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slurm22.05.8-cluster-20240718', + ], + ], + [ + 'name' => 'ClusterDescription', + 'in' => 'query', + 'schema' => [ + 'title' => '集群描述信息。长度为2~256个英文或中文字符，不能以http://和https://开头。', + 'description' => 'The cluster description. The description must be 1 to 128 characters in length and can contain letters, digits, hyphens (-), and underscores (\\_).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slurm22.05.8-cluster-20240718'."\n", + ], + ], + [ + 'name' => 'ClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster type. Valid values:'."\n" + ."\n" + .'* Standard'."\n" + .'* Serverless'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Standard' => 'Standard', + 'Serverless' => 'Serverless', + ], + 'example' => 'Standard', + ], + ], + [ + 'name' => 'ClusterVpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the virtual private cloud (VPC) in which the cluster resides.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-m5efjevmclc0xdmys****', + ], + ], + [ + 'name' => 'ClusterVSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch that you want the cluster to use. The vSwitch must reside in the VPC that is specified by the `ClusterVpcId` parameter.'."\n" + ."\n" + .'You can call the [DescribeVpcs](~~448581~~) operation to query information about the created VPCs and vSwitches.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-f8za5p0mwzgdu3wgx****', + ], + ], + [ + 'name' => 'IsEnterpriseSecurityGroup', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to use an advanced security group. Valid values:'."\n" + ."\n" + .'* true: automatically creates and uses an advanced security group.'."\n" + .'* false: automatically creates and uses a basic security group.'."\n" + ."\n" + .'For more information, see [Basic security groups and advanced security groups](~~605897~~).'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the security group to which the cluster belongs.'."\n" + ."\n" + .'You can call the [DescribeSecurityGroups](~~25556~~) operation to query available security groups in the current region.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp13n61xsydodfyg****', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client version. By default, the latest version is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2.1.0', + ], + ], + [ + 'name' => 'ClusterCustomConfiguration', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The post-processing script of the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Script' => [ + 'description' => 'The URL that is used to download the post-processing script.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://*****', + ], + 'Args' => [ + 'description' => 'The runtime parameters of the script after the cluster is created.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'E-HPC cn-hangzhou', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ClusterCredentials', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The access credentials of the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'KeyPairName' => [ + 'description' => 'The name of the key pair. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain digits, letters, colons (:), underscores (\\_), and hyphens (-).'."\n" + ."\n" + .'> For more information, see [Create a key pair](~~51793~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ali0824', + ], + 'Password' => [ + 'description' => 'The password for the root user to log on to the node. The password must be 8 to 20 characters in length, and must contain at least 3 of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported: `() ~ ! @ # $ % ^ & * - = + { } [ ] : ; \' < > , . ? /`'."\n" + ."\n" + .'> We recommend that you use HTTPS to call the API operation to prevent password leakage.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '**********', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'MaxCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of compute nodes that the cluster can manage. Valid values: 0 to 5,000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'MaxCoreCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum number of vCPUs that can be used by compute nodes in the cluster. Valid values: 0 to 100,000.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'DeletionProtection', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable deletion protection for the cluster. Deletion protection decides whether the cluster can be deleted in the console or by calling the [DeleteCluster](~~424406~~) operation. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the resource group to which the cluster belongs.'."\n" + ."\n" + .'You can call the [ListResourceGroups](~~158855~~) operation to obtain the IDs of the resource groups.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxazb4******', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tags of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag of the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ClusterId', + ], + 'Value' => [ + 'description' => 'The tag value. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-******', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Manager', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The configurations of the cluster management node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Scheduler' => [ + 'description' => 'The configurations of the scheduler service.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The scheduler type. Valid values:'."\n" + ."\n" + .'* SLURM'."\n" + .'* PBS'."\n" + .'* OPENGRIDSCHEDULER'."\n" + .'* LSF_PLUGIN'."\n" + .'* PBS_PLUGIN'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'PBS' => 'PBS', + 'SLURM' => 'SLURM', + 'PBS_PLUGIN' => 'PBS_PLUGIN', + 'OPENGRIDSCHEDULER' => 'OPENGRIDSCHEDULER', + 'LSF_PLUGIN' => 'LSF_PLUGIN', + ], + 'example' => 'SLURM', + ], + 'Version' => [ + 'description' => 'The scheduler version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '22.05.8', + ], + ], + 'required' => false, + ], + 'DirectoryService' => [ + 'description' => 'The configurations of the domain account service.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the domain account.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* NIS'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NIS' => 'NIS', + ], + 'example' => 'NIS', + ], + 'Version' => [ + 'description' => 'The version of the domain account service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2.31', + ], + ], + 'required' => false, + ], + 'DNS' => [ + 'description' => 'The configurations of the domain name resolution service.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The domain name resolution type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* NIS'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NIS' => 'NIS', + ], + 'example' => 'NIS', + ], + 'Version' => [ + 'description' => 'The version of the domain name resolution service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2.31', + ], + ], + 'required' => false, + ], + 'ManagerNode' => [ + 'description' => 'The hardware configurations of the management node.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/NodeTemplate', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Queues', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The queues in the cluster. The number of queues can be 0 to 8.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queue configurations.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/QueueTemplate', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SharedStorages', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The shared storage resources of the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The detailed configurations of a shared storage resource.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/SharedStorageTemplate', + ], + 'required' => false, + ], + ], + [ + 'name' => 'AdditionalPackages', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of software that you want to install in the cluster. Valid values of N: 0 to 10.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a piece of software that you want to install in the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the software that you want to install in the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mpich', + ], + 'Version' => [ + 'description' => 'The version of the software that you want to install in the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '4.0.3', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Addons', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The configurations of the custom addons in the cluster. Only one addon is supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the custom addon in the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The addon name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => 'The addon version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'ServicesSpec' => [ + 'description' => 'The service configurations of the addon.'."\n", + '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' => 'The resource configurations of the addon.'."\n", + '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' => 'The deployment mode of the cluster. Valid values:'."\n" + ."\n" + .'* Integrated'."\n" + .'* Hybrid'."\n" + .'* Custom'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Hybrid' => 'Hybrid', + 'Custom' => 'Custom', + 'Integrated' => 'Integrated', + ], + 'example' => 'Integrated', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The request result. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C0******', + ], + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr******', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + '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' => 'CreateCluster', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'Before you call this operation, make sure that you are familiar with the billing and pricing of E-HPC. For more information, see [Overview](~~2842985~~).'."\n", + ], + 'UpdateCluster' => [ + 'summary' => 'Modify the basic information of a specified cluster.', + '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' => 'The client version. By default, the latest version is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The post-processing script of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slurm22.05.8-serverless-cluster-20240805', + ], + ], + [ + 'name' => 'ClusterDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL that is used to download the post-processing script.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slurm22.05.8-serverless-cluster-20240805'."\n", + ], + ], + [ + 'name' => 'MaxCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The arguments that are used to run the post-processing script.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'MaxCoreCount', + 'in' => 'query', + 'schema' => [ + 'description' => 'The interval at which the cluster is automatically scaled out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'DeletionProtection', + 'in' => 'query', + 'schema' => [ + 'description' => 'The idle duration of the compute nodes allowed by the cluster.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable auto scale-out for the cluster. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2.1.0', + ], + ], + [ + 'name' => 'ClusterCustomConfiguration', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Specifies whether to enable auto scale-in for the cluster. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'object', + 'properties' => [ + 'Script' => [ + 'description' => 'The monitoring details of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://*****'."\n", + ], + 'Args' => [ + 'description' => 'Specifies whether to enable the monitoring component of compute nodes. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'E-HPC cn-hangzhou'."\n", + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'GrowInterval', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scheduler specifications of the cluster.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'IdleInterval', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the topology awareness feature. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'EnableScaleOut', + 'in' => 'query', + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'EnableScaleIn', + 'in' => 'query', + 'schema' => [ + 'description' => 'The request result. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MonitorSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The monitoring details of the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableComputeLoadMonitor' => [ + 'description' => 'Specifies whether to enable the monitoring component of compute nodes. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SchedulerSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The scheduler specifications of the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableTopologyAwareness' => [ + 'description' => 'Specifies whether to enable the topology awareness feature. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Request result, possible values: '."\n" + .'- true: request succeeded '."\n" + .'- false: request failed', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Request 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' => 'UpdateCluster', + 'translator' => 'machine', + ], + 'InstallSoftwares' => [ + 'summary' => 'Install software for the specified cluster.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AdditionalPackages', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the software systems that you want to install.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'List of software to be installed', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The software name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gromacs', + ], + 'Version' => [ + 'description' => 'The software version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024.1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + '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' => 'InstallSoftwares', + 'description' => '## Interface Description'."\n" + .'When calling this interface, please note the following:'."\n" + .'- The cluster status must be `Running`. '."\n" + .'- If the cluster series is `Serverless`, ensure that there is at least one login node or compute node in the cluster; otherwise, software cannot be added to the target cluster.', + 'translator' => 'machine', + ], + 'UninstallSoftwares' => [ + 'summary' => 'Uninstalls software systems from an Enterprise High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AdditionalPackages', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the software systems that you want to uninstall.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the software system that you want to uninstall.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The software name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gromacs', + ], + 'Version' => [ + 'description' => 'The software version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024.1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + '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' => 'UninstallSoftwares', + 'description' => '## Interface Description'."\n" + .'When calling this interface, please note:'."\n" + .'The cluster status must be `Running`.', + 'translator' => 'machine', + ], + 'InstallAddon' => [ + 'summary' => 'Installs an addon.', + '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' => 'The addon name.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'Login', + ], + ], + [ + 'name' => 'AddonVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The addon version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'ServicesSpec', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service configurations of the addon.'."\n", + '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' => 'The resource configurations of the addon.'."\n", + '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' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'AddonId' => [ + 'description' => 'The addon ID.'."\n", + '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' => 'InstallAddon', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'Take note of the following items when you call this operation:'."\n" + ."\n" + .'* The cluster must be in the `Running` state.'."\n" + ."\n" + .'* Clusters fall into two types:'."\n" + ."\n" + .' * Regular clusters on Alibaba Cloud Public Cloud'."\n" + .' * Managed clusters on Alibaba Cloud Public Cloud'."\n", + ], + 'UnInstallAddon' => [ + 'summary' => 'Uninstalls an addon.', + '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' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AddonId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The addon ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Login-1.0-W2g****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The 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' => 'UnInstallAddon', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'Take note of the following items when you call this operation:'."\n" + ."\n" + .'* The cluster must be in the `Running` state.'."\n" + ."\n" + .'* Clusters fall into the following types:'."\n" + ."\n" + .' * Regular clusters on Alibaba Cloud Public Cloud'."\n" + .' * Managed clusters on Alibaba Cloud Public Cloud'."\n", + ], + 'AttachSharedStorages' => [ + 'summary' => 'Attaches shared storage to an Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'SharedStorages', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the shared storage resources that you want to attach to the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the shared storage resource that you want to attach to the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'MountDirectory' => [ + 'description' => 'The local mount directory of the file system that you want to attach.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '/test', + ], + 'FileSystemId' => [ + 'description' => 'The ID of the file system to be attached.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0bd504b0**', + ], + 'StorageDirectory' => [ + 'description' => 'The storage directory of the file system. You can mount any directory in the file system to the specified cluster directory.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '/testehpc', + ], + 'MountTarget' => [ + 'description' => 'The address of the mount point of the file system to be attached.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0bd504b***-ngq26.cn-hangzhou.nas.aliyuncs.com', + ], + 'ProtocolType' => [ + 'description' => 'The protocol type of the file system to be attached. Valid values:'."\n" + ."\n" + .'* NFS'."\n" + .'* SMB'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NFS', + ], + 'MountOptions' => [ + 'description' => 'The attaching options of the file system to be attached. Valid values:'."\n" + ."\n" + .'* \\-t nfs -o vers=3,nolock,proto=tcp,noresvport'."\n" + .'* \\-t nfs -o vers=4.0,noresvport'."\n" + ."\n" + .'Default value:-t nfs -o vers=3,nolock,proto=tcp,noresvport'."\n" + ."\n" + .'> The v3 version is recommended for higher performance if multiple Elastic Compute Service (ECS) instances do not edit the same file at the same time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '-t nfs -o vers=3,nolock,proto=tcp,noresvport', + ], + 'Location' => [ + 'description' => 'The storage location of the file system to be attached. Valid values:'."\n" + ."\n" + .'* OnPremise: The file system is deployed on a hybrid cloud.'."\n" + .'* PublicCloud: The file system is deployed on a public cloud.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PublicCloud', + ], + 'VolumeType' => [ + 'description' => 'The type of the file system to be attached. Valid values:'."\n" + ."\n" + .'* nas'."\n" + .'* cpfs'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'nas', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F9B7BEF8-E42E-5090-9880-55FB7872****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n", + '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' => 'AttachSharedStorages', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'When you call this operation, take note of the following items:'."\n" + ."\n" + .'* The file system that you want to attach must be created in advance in the same virtual private cloud (VPC) as the destination cluster. For more information, see [Create a file system](~~27530~~) and [Manage mount targets](~~27531~~).'."\n" + .'* E-HPC clusters support Apsara File Storage NAS file systems.'."\n", + ], + 'DetachSharedStorages' => [ + 'summary' => 'Unmounts shared storage from the mount directory of a cluster.', + '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' => 'The information about mounted shared storage resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the mounted shared storage resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'MountDirectory' => [ + 'description' => 'The local mount directory of the mounted file system.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '/test', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + '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' => 'DetachSharedStorages', + ], + 'ListSoftwares' => [ + 'summary' => 'Queries the software that can be installed in an Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The page number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + 'default' => '10', + ], + ], + [ + 'name' => 'OsInfos', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The operating system (OS) information.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OsTag' => [ + 'description' => 'The image tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CentOS_7.9_64', + ], + 'Architecture' => [ + 'description' => 'The OS architecture. Valid values:'."\n" + ."\n" + .'* x86\\_64'."\n" + .'* arm64'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'x86_64', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application category.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NWP', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The software name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'gromacs', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'AdditionalPackages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AdditionalPackageInfos' => [ + 'description' => 'The information about the software that can be installed in the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The software name.'."\n", + 'type' => 'string', + 'example' => 'gromacs', + ], + 'Category' => [ + 'description' => 'The application category.'."\n", + 'type' => 'string', + 'example' => 'NWP', + ], + 'Icon' => [ + 'description' => 'The URL of the software icon.'."\n", + 'type' => 'string', + 'example' => 'https://gw.alicdn.com/imgextra/i2/O1CN01FIkxZ81LmE0fvrAyR_!!6000000001341-55-tps-6349-1603.svg', + ], + 'Description' => [ + 'description' => 'The software description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Versions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'VersionInfos' => [ + 'description' => 'The information about the software versions that can be installed in the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the software.'."\n", + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => 'The software version.'."\n", + 'type' => 'string', + 'example' => '2024.1', + ], + 'Latest' => [ + 'description' => 'Indicates whether the version is the latest.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'SupportOs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SupportOsInfos' => [ + 'description' => 'The information about the supported OSs.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OsTag' => [ + 'description' => 'The image tag.'."\n", + 'type' => 'string', + 'example' => 'Alibaba Cloud Linux 3.2104 LTS 64 bit ARM Edition', + ], + 'Architecture' => [ + 'description' => 'The OS architecture. Valid values:'."\n" + ."\n" + .'* x86\\_64'."\n" + .'* arm64'."\n", + 'type' => 'string', + 'example' => 'x86_64', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'ListSoftwares', + ], + 'ListSharedStorages' => [ + 'summary' => 'Queries the shared storage that is attached to a cluster.', + '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' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'FileSystemType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the attached file system. Valid values:'."\n" + ."\n" + .'* nas'."\n" + .'* cpfs'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'nas', + ], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the attached file system.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0bd504b0**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F6757FA4-8FED-4602-B7F5-3550C084****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'SharedStorages' => [ + 'description' => 'The information about the attached shared storage.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the shared storage.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => 'The ID of the attached file system.'."\n", + 'type' => 'string', + 'example' => '08c7f4b***', + ], + 'FileSystemType' => [ + 'description' => 'The type of the attached file system. Valid values:'."\n" + ."\n" + .'* nas'."\n" + .'* cpfs'."\n", + 'type' => 'string', + 'example' => 'nas', + ], + 'MountInfo' => [ + 'description' => 'The mount information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The mount configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'MountDirectory' => [ + 'description' => 'The local mount directory of the attached file system.'."\n", + 'type' => 'string', + 'example' => '/test', + ], + 'StorageDirectory' => [ + 'description' => 'The storage directory of the attached file system.'."\n", + 'type' => 'string', + 'example' => '/testehpc', + ], + 'MountOptions' => [ + 'description' => 'The mount options for the attached file system. Valid values:'."\n" + ."\n" + .'* \\-t nfs -o vers=3,nolock,proto=tcp,noresvport'."\n" + .'* \\-t nfs -o vers=4.0,noresvport'."\n", + 'type' => 'string', + 'example' => '-t nfs -o vers=4.0,noresvport', + ], + 'MountTarget' => [ + 'description' => 'The mount target of the attached file system.'."\n", + 'type' => 'string', + 'example' => '0bd504b***-ngq26.cn-hangzhou.nas.aliyuncs.com', + ], + 'ProtocolType' => [ + 'description' => 'The protocol used by the mount target of the attached file system. Valid values:'."\n" + ."\n" + .'* nfs3'."\n" + .'* nfs4'."\n" + .'* cpfs'."\n", + 'type' => 'string', + 'example' => 'nfs3', + ], + ], + ], + ], + 'FileSystemProtocol' => [ + 'description' => 'The protocol used by the attached file system. Valid values:'."\n" + ."\n" + .'* nfs3'."\n" + .'* nfs4'."\n" + .'* cpfs'."\n", + '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' => 'ListSharedStorages', + ], + 'ListInstalledSoftwares' => [ + 'summary' => 'Queries the installed software of a cluster.', + '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' => 'The page number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'AdditionalPackages' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'AdditionalPackageInfos' => [ + 'description' => 'The list of installed software.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The software name.'."\n", + 'type' => 'string', + 'example' => 'gromacs', + ], + 'Category' => [ + 'description' => 'The category into which the software falls.'."\n", + 'type' => 'string', + 'example' => 'NWP', + ], + 'Icon' => [ + 'description' => 'The URL of the software icon.'."\n", + 'type' => 'string', + 'example' => 'https://gw.alicdn.com/imgextra/i2/O1CN01FIkxZ81LmE0fvrAyR_!!6000000001341-55-tps-6349-1603.svg', + ], + 'Description' => [ + 'description' => 'The software description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Version' => [ + 'description' => 'The software version.'."\n", + 'type' => 'string', + 'example' => '2024.1', + ], + 'Status' => [ + 'description' => 'The installation status of the software.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Installed'."\n" + .'* Uninstalled'."\n" + .'* Installing'."\n" + .'* Exception'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Installed' => 'Installed', + 'Uninstalled' => 'Uninstalled', + 'Installing' => 'Installing', + 'Exception' => 'Exception', + ], + 'example' => 'Installed', + ], + 'CreateTime' => [ + 'description' => 'The time when the software was installed.'."\n", + 'type' => 'string', + 'example' => '2024-03-05 18:24:08', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ListInstalledSoftwares', + ], + 'ListClusters' => [ + 'summary' => 'Queries all clusters of a user in each region.', + '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' => 'The cluster IDs. You can specify up to 20 IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-cn-wulanchabu-llsu******', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ClusterNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The cluster names. You can specify up to 20 names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'slurm22.05.8-cluster-20240802'."\n", + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: 10 to 100. Default value: 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Clusters' => [ + 'description' => 'The list of clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-VMKe******', + ], + 'ClusterName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'slurm22.05.8-cluster-20240227', + ], + 'ClusterDescription' => [ + 'description' => 'The cluster description.'."\n", + 'type' => 'string', + 'example' => 'Demo', + ], + 'ClusterCreateTime' => [ + 'description' => 'The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. For more information, see [ISO 8601](~~25696~~).'."\n", + 'type' => 'string', + 'example' => '2024-08-06T12:43:01.000Z', + ], + 'ClusterModifyTime' => [ + 'description' => 'The time when the cluster was modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. For more information, see [ISO 8601](~~25696~~).'."\n", + 'type' => 'string', + 'example' => '2024-08-06T12:43:01.000Z', + ], + 'ClusterCategory' => [ + 'description' => 'The cluster type. Valid values:'."\n" + ."\n" + .'* Standard'."\n" + .'* Serverless'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'ClusterStatus' => [ + 'description' => 'The cluster state. Valid values:'."\n" + ."\n" + .'* uninit: The cluster is being installed.'."\n" + .'* creating: The cluster is being created.'."\n" + .'* initing: The cluster is being initialized.'."\n" + .'* running: The cluster is running.'."\n" + .'* Releasing: The cluster is being released.'."\n" + .'* stopping: The cluster is being stopped.'."\n" + .'* stopped: The cluster is stopped.'."\n" + .'* exception: The cluster has run into an exception.'."\n" + .'* pending: The cluster is waiting to be configured.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'ClusterVpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) used by the cluster.'."\n", + 'type' => 'string', + 'example' => 'vpc-m5efjevmclc0xdmys****'."\n", + ], + 'ClusterVSwitchId' => [ + 'description' => 'The ID of the vSwitch used by the cluster.'."\n", + 'type' => 'string', + 'example' => 'vsw-f8za5p0mwzgdu3wgx****'."\n", + ], + 'SecurityGroupId' => [ + 'description' => 'The ID of the security group used by the cluster.'."\n", + 'type' => 'string', + 'example' => 'sg-bp13n61xsydodfyg****'."\n", + ], + 'ClusterCustomConfiguration' => [ + 'description' => 'The post-processing script used by the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Script' => [ + 'description' => 'The link to the post-processing script.'."\n", + 'type' => 'string', + 'example' => 'https://xxxxx', + ], + 'Args' => [ + 'description' => 'The parameters of the post-processing script.'."\n", + 'type' => 'string', + 'example' => 'demo', + ], + ], + ], + 'MaxCount' => [ + 'description' => 'The maximum number of compute nodes that can be managed by the cluster.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '500', + ], + 'MaxCoreCount' => [ + 'description' => 'The maximum total number of vCPUs used by the compute nodes that can be managed by the cluster.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'DeletionProtection' => [ + 'description' => 'Indicates whether deletion protection is enabled for the cluster. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmxazb4ph****', + ], + 'Manager' => [ + 'description' => 'The configurations of the cluster management node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Scheduler' => [ + 'description' => 'The configurations of the scheduler service.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The scheduler type.'."\n", + 'type' => 'string', + 'example' => 'SLURM', + ], + 'Version' => [ + 'description' => 'The scheduler version.'."\n", + 'type' => 'string', + 'example' => '22.05.8'."\n", + ], + ], + ], + 'DirectoryService' => [ + 'description' => 'The configurations of the directory service.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the domain account.'."\n", + 'type' => 'string', + 'example' => 'NIS', + ], + 'Version' => [ + 'description' => 'The version of the domain account service.'."\n", + 'type' => 'string', + 'example' => '2.31'."\n", + ], + ], + ], + 'DNS' => [ + 'description' => 'The configurations of the domain name resolution service.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The resolution type.'."\n", + 'type' => 'string', + 'example' => 'NIS', + ], + 'Version' => [ + 'description' => 'The version of the domain name resolution service.'."\n", + 'type' => 'string', + 'example' => '2.31', + ], + ], + ], + ], + ], + 'EhpcVersion' => [ + 'description' => 'The Elastic High Performance Computing (E-HPC) version.'."\n", + 'type' => 'string', + 'example' => '2.0.0', + ], + 'Nodes' => [ + 'description' => 'The node statistics of the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'RunningCounts' => [ + 'description' => 'The number of running compute nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AbnormalCounts' => [ + 'description' => 'The number of malfunctioning compute nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatingCounts' => [ + 'description' => 'The number of compute nodes that are being created.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'Users' => [ + 'description' => 'The user attribute information of the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'SudoCounts' => [ + 'description' => 'The number of administrators.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'NormalCounts' => [ + 'description' => 'The number of ordinary users.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'AdditionalPackages' => [ + 'description' => 'The information about installed software in the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the software.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The software name.'."\n", + 'type' => 'string', + 'example' => 'gromacs', + ], + 'Version' => [ + 'description' => 'The software version.'."\n", + 'type' => 'string', + 'example' => '2024.1', + ], + ], + ], + ], + 'Addons' => [ + 'description' => 'The information about the addons in the cluster.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the addon.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The addon name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => 'The addon version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'Label' => [ + 'description' => 'The addon label.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'AddonId' => [ + 'description' => 'The addon ID.'."\n", + 'type' => 'string', + 'example' => 'Login-1.0-W2g****'."\n", + ], + 'Description' => [ + 'description' => 'The addon description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Status' => [ + 'description' => 'The addon state.'."\n", + 'type' => 'string', + 'example' => 'Running'."\n", + ], + 'ServicesSpec' => [ + 'description' => 'The information about the addon services.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the service.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => 'The service name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Web Portal'."\n", + ], + 'ServiceAccessType' => [ + 'description' => 'The service access type.'."\n", + 'type' => 'string', + 'example' => 'URL', + ], + 'ServiceAccessUrl' => [ + 'description' => 'The service access URL.'."\n", + 'type' => 'string', + 'example' => 'https://47.96.xx.xx:12008'."\n", + ], + ], + ], + ], + 'ResourcesSpec' => [ + 'description' => 'The resource configurations of the addon.'."\n", + 'type' => 'object', + 'properties' => [ + 'EipInstanceId' => [ + 'description' => 'The Elastic IP Address (EIP) ID.'."\n", + 'type' => 'string', + 'example' => 'eip-bp1vi9124tbx1g3kr****'."\n", + ], + 'EcsInstanceId' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'i-bp1bg85d2q6laic8****', + ], + ], + ], + ], + ], + ], + 'ClusterUsedCoreTime' => [ + 'description' => 'The vCPU-hour usage of the cluster.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '1000', + ], + 'ClusterMode' => [ + 'description' => 'The deployment type of the cluster. Valid values:'."\n" + ."\n" + .'* Integrated: public cloud'."\n" + .'* Hybrid: hybrid cloud'."\n" + .'* Custom: a custom cluster'."\n", + 'type' => 'string', + 'example' => 'Integrated', + ], + 'ClusterCredentials' => [ + 'description' => 'The logon credential type of the cluster. Valid values:'."\n" + ."\n" + .'* password: requires passwords for logons.'."\n" + .'* keypair: requires key pairs for logons.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The credential type.'."\n", + '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' => 'ListClusters', + ], + 'ListAvailableImages' => [ + 'summary' => 'Queries images that are available for Elastic High Performance Computing (E-HPC) clusters.', + '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' => 'The image source. Valid values:'."\n" + ."\n" + .'* system: system image.'."\n" + .'* self: custom image.'."\n" + .'* others: shared image.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'self', + ], + ], + [ + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance type.'."\n" + ."\n" + .'> By default, if you do not specify an instance type, the list of images that are supported by all instance types are queried. For more information, see [Instance families](~~25378~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c7.large', + ], + ], + [ + 'name' => 'IsPublic', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return published community images. Valid values:'."\n" + ."\n" + .'* true: returns published community images. If you set the value of this parameter to `true`, the `ImageOwnerAlias` parameter must be set to `others`.'."\n" + .'* false: returns non-community images. The value of the `ImageOwnerAlias` parameter prevails.'."\n" + ."\n" + .'Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'HPCInterConnect', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type of the images that you want to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + ], + [ + 'name' => 'EnableHT', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return images in which hyper-threading is enabled.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Scheduler', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The scheduler information about the images that you want to query.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The scheduler type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SLURM', + ], + 'Version' => [ + 'description' => 'The scheduler version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '22.05.8', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DirectoryService', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the domain account service.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the domain account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NIS', + ], + 'Version' => [ + 'description' => 'The version of the domain account service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: 1 to 50. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'title' => 'Id of the request', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'Id of the request', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => 'Id of the request', + 'description' => 'The page number of the returned page.'."\n" + ."\n" + .'* Pages start from page 1.'."\n" + .'* Default value: 1.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Images' => [ + 'description' => 'The information about the images.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the image.'."\n", + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'centos_7_06_64_20G_alibase_2019071****', + ], + 'OSNameEn' => [ + 'description' => 'The OS name in English.'."\n", + 'type' => 'string', + 'example' => 'CentOS 7.9 64 bit', + ], + 'ImageOwnerAlias' => [ + 'description' => 'The image source. Valid values:'."\n" + ."\n" + .'* system: system image.'."\n" + .'* self: custom image.'."\n" + .'* others: shared image.'."\n", + 'type' => 'string', + 'example' => 'self', + ], + 'Description' => [ + 'description' => 'The image description.'."\n", + 'type' => 'string', + 'example' => 'ExampleDescription', + ], + 'Size' => [ + 'description' => 'The image size. Unit: GiB'."\n", + 'type' => 'string', + 'example' => '40', + ], + 'Platform' => [ + 'description' => 'The OS. Valid values:'."\n" + ."\n" + .'* CentOS'."\n" + .'* windows'."\n", + 'type' => 'string', + 'example' => 'windows', + ], + 'OSName' => [ + 'description' => 'The OS name in Chinese.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Architecture' => [ + 'description' => 'The OS architecture of the image. Valid values:'."\n" + ."\n" + .'* x86\\_64'."\n" + .'* arm64'."\n", + 'type' => 'string', + 'example' => 'x86_64', + ], + 'BootMode' => [ + 'description' => 'The boot mode of the image. Valid values:'."\n" + ."\n" + .'* BIOS: Basic Input/Output System (BIOS).'."\n" + .'* UEFI: Unified Extensible Firmware Interface (UEFI).'."\n" + ."\n" + .'> When you change the OS boot mode of an instance, you must make sure that the boot mode matches the boot mode of the associated image. Otherwise, the instance fails to be booted.'."\n", + 'type' => 'string', + 'example' => 'BIOS', + ], + 'ImageName' => [ + 'description' => 'The image name.'."\n", + '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' => 'ListAvailableImages', + ], + 'ListAvailableFileSystems' => [ + 'summary' => 'Queries the file systems that can be attached in a region.', + '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' => 'The page number of the page to return. Page starts from page 1. Default value: 1'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: 1 to 50. Default value: 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BF4E8AB1-02A3-5ECF-87CC-3AB7BE98**', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '65', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'FileSystemList' => [ + 'description' => 'The file systems.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the file system.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileSystemId' => [ + 'description' => 'The ID of the file system.'."\n", + 'type' => 'string', + 'example' => '2fa0248***', + ], + 'FileSystemType' => [ + 'description' => 'The type of the file system. Valid values:'."\n" + ."\n" + .'* standard: general-purpose network-attached storage (NAS) file system'."\n" + .'* extreme: extreme NAS file system'."\n", + 'type' => 'string', + 'example' => 'cpfs', + ], + 'Status' => [ + 'description' => 'The state of the file system. Valid values:'."\n" + ."\n" + .'* Pending: The file system is processing a task.'."\n" + .'* Running: The file system is available. You can perform subsequent operations, such as creating a mount target, only when the file system is in the Running state.'."\n" + .'* Stopped: The file system is unavailable.'."\n" + .'* Extending: The file system is being scaled out.'."\n" + .'* Stopping: The file system is being stopped.'."\n" + .'* Deleting: The file system is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'ProtocolType' => [ + 'description' => 'The protocol type of the file system. Valid values:'."\n" + ."\n" + .'* nfs'."\n" + .'* smb'."\n" + .'* cpfs'."\n", + 'type' => 'string', + 'example' => 'cpfs', + ], + 'CreateTime' => [ + 'description' => 'The time when the file system was created.'."\n", + 'type' => 'string', + 'example' => '2024-7-29 15:43:53', + ], + 'MountTargetList' => [ + 'description' => 'The mount targets of the file system.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the mount target.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-8vbvb34rtyh6xb3zrehs1****', + ], + 'MountTargetDomain' => [ + 'description' => 'The address of the mount target.'."\n", + 'type' => 'string', + 'example' => 'c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com', + ], + 'Status' => [ + 'description' => 'The state of the mount target. Valid values:'."\n" + ."\n" + .'* Active: The mount target is available.'."\n" + .'* Inactive: The mount target is unavailable.'."\n" + .'* Pending: The mount target is being mounted.'."\n" + .'* Deleting: The mount target is being deleted.'."\n", + 'type' => 'string', + 'example' => 'Active', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-2ze0c41hwu7lc29ris***', + ], + 'NetworkType' => [ + 'description' => 'The network type. Valid values: Valid values:'."\n" + ."\n" + .'* vpc'."\n", + 'type' => 'string', + 'example' => 'vpc', + ], + ], + ], + ], + 'StorageType' => [ + 'description' => 'The storage type of the file system.'."\n" + ."\n" + .'* Valid values if FileSystemType is set to standard: Capacity and Performance.'."\n" + .'* Valid values if FileSystemType is set to extreme: standard and advance.'."\n", + 'type' => 'string', + 'example' => 'Performance', + ], + 'VpcId' => [ + 'description' => 'The VPC ID.'."\n", + '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' => 'ListAvailableFileSystems', + ], + 'ListAddons' => [ + 'summary' => 'Queries installed addons of an Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AddonIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The addon IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The addon ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Login-1.0-W4g****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return. Default value: 1'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => 'The page number of the returned page. Default value: 1'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Addons' => [ + 'title' => 'Addons', + 'description' => 'The information about the addons.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the addon.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The addon name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => 'The addon version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'AddonId' => [ + 'description' => 'The addon ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Login-1.0-W4g****'."\n", + ], + 'Label' => [ + 'description' => 'The addon label.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Description' => [ + 'description' => 'The addon description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'InstallTime' => [ + 'description' => 'The time when the addon was installed.'."\n", + 'type' => 'string', + 'example' => '2024-08-22 18:11:17', + ], + 'Status' => [ + 'description' => 'The addon state.'."\n", + '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' => 'ListAddons', + ], + 'ListAddonTemplates' => [ + 'summary' => 'Queries supported addon templates.', + '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' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return. Pages start from page 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'AddonNames', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The addon names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The addon name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Login', + ], + 'required' => false, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'ClusterCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster type. Valid values:'."\n" + ."\n" + .'* Standard'."\n" + .'* Serverless'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Addons' => [ + 'title' => 'Addons', + 'description' => 'The information about the addon templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the addon template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The addon name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => 'The addon version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'Label' => [ + 'description' => 'The addon label'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Description' => [ + 'description' => 'The addon description.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'ListAddonTemplates', + ], + 'GetCluster' => [ + 'summary' => 'Queries information about an Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ClusterId' => [ + 'title' => 'E-HPC集群ID', + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'ClusterName' => [ + 'title' => 'E-HPC集群名称', + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'slurm22.05.8-cluster-20240614', + ], + 'ClusterCategory' => [ + 'title' => '', + 'description' => 'The cluster type. Valid values:'."\n" + ."\n" + .'* Standard'."\n" + .'* Serverless'."\n", + 'type' => 'string', + 'example' => 'Standard', + ], + 'MaxCount' => [ + 'description' => 'The maximum number of compute nodes that the cluster can manage.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'MaxCoreCount' => [ + 'description' => 'The maximum total number of vCPUs that can be used by all compute nodes managed by the cluster.'."\n", + 'type' => 'string', + 'example' => '10000', + ], + 'DeleteProtection' => [ + 'description' => 'Indicates whether deletion protection is enabled for the cluster. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmxazb4ph****', + ], + 'ClusterCreateTime' => [ + 'description' => 'The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. For more information, see [ISO 8601](~~25696~~).'."\n", + 'type' => 'string', + 'example' => '2024-08-06T12:43:01.000Z'."\n", + ], + 'ClusterModifyTime' => [ + 'description' => 'The time when the cluster was last modified. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. For more information, see [ISO 8601](~~25696~~).'."\n", + 'type' => 'string', + 'example' => '2024-08-06T12:43:01.000Z'."\n", + ], + 'ClusterVpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC) used by the cluster.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6u3lk1pjy28eg*****', + ], + 'ClusterVSwitchId' => [ + 'description' => 'The ID of the vSwitch used by the cluster.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1p2uugqsjppno******', + ], + 'SecurityGroupId' => [ + 'description' => 'The security group ID.'."\n", + 'type' => 'string', + 'example' => 'sg-f8z9vb2zaezpkr69a21k', + ], + 'EhpcVersion' => [ + 'description' => 'The E-HPC version.'."\n", + 'type' => 'string', + 'example' => '2.0.0', + ], + 'ClientVersion' => [ + 'description' => 'The E-HPC Util version.'."\n", + 'type' => 'string', + 'example' => '2.0.31', + ], + 'ClusterStatus' => [ + 'description' => 'The cluster state. Valid values:'."\n" + ."\n" + .'* uninit: The cluster is being installed.'."\n" + .'* creating: The cluster is being created.'."\n" + .'* initing: The cluster is being initialized.'."\n" + .'* running: The cluster is running.'."\n" + .'* exception: The cluster has run into an exception.'."\n" + .'* raleasing: The cluster is being released.'."\n" + .'* stopping: The cluster is being stopped.'."\n" + .'* stopped: The cluster is stopped.'."\n" + .'* pending: The cluster is waiting to be configured.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'ClusterMode' => [ + 'description' => 'The deployment type of the cluster. Valid values:'."\n" + ."\n" + .'* Integrated: The cluster is deployed on a public cloud.'."\n" + .'* Hybrid: The cluster is deployed on a hybrid cloud.'."\n" + .'* Custom: The cluster is a custom cluster.'."\n", + 'type' => 'string', + 'example' => 'Integrated', + ], + 'Manager' => [ + 'description' => 'The management node configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Scheduler' => [ + 'description' => 'The information about the scheduler.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The scheduler type. Valid values:'."\n" + ."\n" + .'* SLURM'."\n" + .'* PBS'."\n" + .'* OPENGRIDSCHEDULER'."\n" + .'* LSF_PLUGIN'."\n" + .'* PBS_PLUGIN'."\n", + 'type' => 'string', + 'example' => 'SLURM', + ], + 'Version' => [ + 'description' => 'The scheduler version.'."\n", + 'type' => 'string', + 'example' => '22.05.8', + ], + 'Status' => [ + 'description' => 'The scheduler state. Valid values:'."\n" + ."\n" + .'* uninit: The scheduler is being installed.'."\n" + .'* initing: The scheduler is being initialized.'."\n" + .'* running: The scheduler is running.'."\n" + .'* exception: The scheduler has run into an exception.'."\n" + .'* releasing: The scheduler is being released.'."\n" + .'* stopped: The scheduler is stopped.'."\n" + .'* pending: The scheduler is waiting to be configured.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + ], + ], + 'DirectoryService' => [ + 'description' => 'The information about the domain account service.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the domain account.'."\n", + 'type' => 'string', + 'example' => 'nis', + ], + 'Version' => [ + 'description' => 'The version of the domain account service.'."\n", + 'type' => 'string', + 'example' => '2.31', + ], + 'Status' => [ + 'description' => 'The state of the domain account service. Valid values:'."\n" + ."\n" + .'* uninit: The service is being installed.'."\n" + .'* initing: The service is being initialized.'."\n" + .'* running: The service is running.'."\n" + .'* exception: The service has run into an exception.'."\n" + .'* releasing: The service is being released.'."\n" + .'* stopped: The service is stopped.'."\n" + .'* pending: The service is waiting to be configured.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + ], + ], + 'DNS' => [ + 'description' => 'The configurations of the domain name resolution service.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The resolution type.'."\n", + 'type' => 'string', + 'example' => 'nis', + ], + 'Version' => [ + 'description' => 'The version of the resolution service.'."\n", + 'type' => 'string', + 'example' => '2.31', + ], + 'Status' => [ + 'description' => 'The state of the domain name resolution service. Valid values:'."\n" + ."\n" + .'* uninit: The service is being installed.'."\n" + .'* initing: The service is being initialized.'."\n" + .'* running: The service is running.'."\n" + .'* exception: The service has run into an exception.'."\n" + .'* releasing: The service is being released.'."\n" + .'* stopped: The service is stopped.'."\n" + .'* pending: The service is waiting to be configured.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + ], + ], + 'ManagerNode' => [ + 'description' => 'The configurations of the management node.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The instance ID of the management node.'."\n", + 'type' => 'string', + 'example' => 'i-bp1a170jgea1vl******', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the management node.'."\n", + 'type' => 'string', + 'example' => 'ecs.g6.4xlarge', + ], + 'InstanceChargeType' => [ + 'description' => 'The instance billing method of the management node. Valid values:'."\n" + ."\n" + .'* PostPaid: pay-as-you-go'."\n" + .'* PrePaid: subscription'."\n", + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'ExpiredTime' => [ + 'description' => 'The expiration time of the management node.'."\n", + 'type' => 'string', + 'example' => '2099-12-31T15:59Z', + ], + 'ImageId' => [ + 'title' => '集群管理节点使用的镜像ID。', + 'type' => 'string', + 'example' => 'aliyun_2_1903_x64_20G_alibase_20200324.vhd', + ], + 'PeriodUnit' => [ + 'title' => '集群管理节点包年包月计费方式的时长单位。', + 'type' => 'string', + 'example' => 'Month', + ], + 'Period' => [ + 'title' => '集群管理节点包年包月付费类型是否开启自动续费。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AutoRenew' => [ + 'title' => '集群管理节点包你那包月付费类型是否开启自动续费。', + 'type' => 'boolean', + 'default' => 'false', + ], + 'AutoRenewPeriod' => [ + 'title' => '集群管理节点包年包月付费类型单词自动续费的续费时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'Month', + ], + 'SpotStrategy' => [ + 'title' => '集群管理节点按量付费的竞价策略。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'SpotPriceLimit' => [ + 'title' => '集群管理节点抢占式实例的每小时最高价格。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Duration' => [ + 'title' => '集群管理节点抢占式实例的保有时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'EnableHt' => [ + 'title' => '集群管理节点是否开启HT。', + 'type' => 'boolean', + ], + 'SystemDisk' => [ + 'title' => '集群管理节点的系统盘配置。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => '集群管理节点系统盘的云盘种类。', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'Size' => [ + 'title' => '集群管理节点系统盘的大小，单位是GiB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + ], + 'Level' => [ + 'title' => '集群管理节点ESSD系统盘的性能等级。', + 'type' => 'string', + 'example' => 'PL0', + ], + ], + ], + ], + ], + ], + ], + 'ClusterCustomConfiguration' => [ + 'description' => 'The post-processing script of the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'Script' => [ + 'description' => 'The URL that is used to download the post-processing script.'."\n", + 'type' => 'string', + 'example' => 'http://*****'."\n", + ], + 'Args' => [ + 'description' => 'The arguments that are used to run the script after the scrip is installed.'."\n", + 'type' => 'string', + 'example' => 'E-HPC cn-hangzhou'."\n", + ], + ], + ], + 'GrowInterval' => [ + 'description' => 'The interval at which the cluster is automatically scaled out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'IdleInterval' => [ + 'description' => 'The idle duration of the compute nodes allowed by the cluster.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'EnableScaleOut' => [ + 'description' => 'Indicates whether automatic scale-out is enabled for the cluster. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableScaleIn' => [ + 'description' => 'Indicates whether automatic scale-in is enabled for the cluster. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'MonitorSpec' => [ + 'description' => 'The monitoring details of the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableComputeLoadMonitor' => [ + 'description' => 'Indicates whether the monitoring component of compute nodes is enabled for the cluster. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'SchedulerSpec' => [ + 'description' => 'The scheduler specifications of the cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'EnableTopologyAwareness' => [ + 'description' => 'Indicates whether the topology awareness feature is enabled for the cluster. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + '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' => 'GetCluster', + 'translator' => 'machine', + ], + 'GetAddon' => [ + 'summary' => 'Queries the details of an installed addon.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'AddonId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The addon ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Login-1.0-W4g****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BBC2F93D-003A-49C4-850C-B826EECF****', + ], + 'Addon' => [ + 'title' => 'Addon', + 'description' => 'The information about the addon.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The addon name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => 'The addon version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'AddonId' => [ + 'description' => 'The addon ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Login-1.0-W2g****', + ], + 'Label' => [ + 'description' => 'The addon label.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Description' => [ + 'description' => 'The addon description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Icon' => [ + 'description' => 'The addon icon.'."\n", + 'type' => 'string', + 'example' => '/assets/icons/your_icon.svg'."\n", + ], + 'InstallTime' => [ + 'description' => 'The time when the addon was installed.'."\n", + 'type' => 'string', + 'example' => '2024-08-22 18:11:17'."\n", + ], + 'Status' => [ + 'description' => 'The addon status.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'ServicesSpec' => [ + 'description' => 'The service configurations of the addon.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The service configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => 'The service name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Web Portal', + ], + 'ServiceAccessType' => [ + 'description' => 'The service access type.'."\n", + 'type' => 'string', + 'example' => 'URL', + ], + 'ServiceAccessUrl' => [ + 'description' => 'The service access URL.'."\n", + 'type' => 'string', + 'example' => 'https://47.96.xx.xx:12008', + ], + 'InputParams' => [ + 'description' => 'The parameter configurations of the service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter details.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The parameter name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MYSQL_HOME'."\n", + ], + 'Label' => [ + 'description' => 'The parameter label.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Value' => [ + 'description' => 'The parameter value.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'usr/local/mysql'."\n", + ], + 'Type' => [ + 'description' => 'The parameter type.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'String'."\n", + ], + 'HelpText' => [ + 'description' => 'The help information of the parameter.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'NetworkACL' => [ + 'description' => 'The security group configurations of the service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The security group rules.'."\n", + 'type' => 'object', + 'properties' => [ + 'IpProtocol' => [ + 'description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'TCP: forwards TCP packets.'."\n" + ."\n" + .'UDP: forwards UDP packets.'."\n" + ."\n" + .'Any: forwards all packets.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TCP', + ], + 'Port' => [ + 'description' => 'The port number.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '3306'."\n", + ], + 'SourceCidrIp' => [ + 'description' => 'The source CIDR block.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '172.16.0.0/12'."\n", + ], + ], + ], + ], + ], + ], + ], + 'ResourcesSpec' => [ + 'description' => 'The resource configurations of the addon.'."\n", + 'type' => 'object', + 'properties' => [ + 'EipResource' => [ + 'description' => 'The Elastic IP Address (EIP) configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'AutoCreate' => [ + 'description' => 'Indicates whether the EIP is automatically created.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'EipInstanceId' => [ + 'description' => 'The EIP ID.'."\n", + 'type' => 'string', + 'example' => 'eip-bp1vi9124tbx1g3kr****', + ], + 'EipAddress' => [ + 'description' => 'The EIP.'."\n", + 'type' => 'string', + 'example' => '39.108.xx.xx', + ], + 'InstanceChargeType' => [ + 'description' => 'The billing method of the EIP.'."\n" + ."\n" + .'* PostPaid: pay-as-you-go.'."\n" + .'* PrePaid: subscription.'."\n" + ."\n" + .'Default value: PostPaid.'."\n", + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'InternetChargeType' => [ + 'description' => 'The metering method of the EIP. Valid values:'."\n" + ."\n" + .'* PayByBandwidth: pay by bandwidth.'."\n" + .'* PayByTraffic: pay by data transfer.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'example' => 'PayByTraffic', + ], + 'Bandwidth' => [ + 'description' => 'The maximum bandwidth of the EIP. Unit: Mbit/s.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + 'EcsResources' => [ + 'description' => 'The Elastic Compute Service (ECS) resource configurations of the addon.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the ECS node.'."\n", + '$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' => 'GetAddon', + ], + 'DescribeAddonTemplate' => [ + 'summary' => 'Queries the details of an addon template.', + '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' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page returned. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'AddonName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The addon name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + ], + [ + 'name' => 'AddonVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The addon version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Addon' => [ + 'title' => 'Addon', + 'description' => 'The details of the addon template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The addon name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Login', + ], + 'Version' => [ + 'description' => 'The addon version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.0', + ], + 'Label' => [ + 'description' => 'The addon label.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Description' => [ + 'description' => 'The addon description.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Icon' => [ + 'description' => 'The addon icon.'."\n", + 'type' => 'string', + 'example' => '/assets/icons/your_icon.svg', + ], + 'LastUpdate' => [ + 'description' => 'The date when the addon template was last updated.'."\n", + 'type' => 'string', + 'example' => '2024-08-22 18:11:17', + ], + 'ServicesSpec' => [ + 'description' => 'The addon configurations.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The service configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'ServiceName' => [ + 'description' => 'The service name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Web Portal', + ], + 'ServiceAccessType' => [ + 'description' => 'The service access type.'."\n", + 'type' => 'string', + 'example' => 'URL', + ], + 'ServiceAccessUrl' => [ + 'description' => 'The service access URL.'."\n", + 'type' => 'string', + 'example' => 'https://47.96.xx.xx:12008', + ], + 'InputParams' => [ + 'description' => 'The parameter configurations of the service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter details.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The parameter name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'MYSQL_HOME', + ], + 'Label' => [ + 'description' => 'The parameter label.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Value' => [ + 'description' => 'The parameter value.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'usr/local/mysql', + ], + 'Type' => [ + 'description' => 'The parameter type.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'String', + ], + 'HelpText' => [ + 'description' => 'The help information of the parameter.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'NetworkACL' => [ + 'description' => 'The security group configurations of the service.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The security group rules.'."\n", + 'type' => 'object', + 'properties' => [ + 'IpProtocol' => [ + 'description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* **TCP**: forwards TCP packets.'."\n" + .'* **UDP**: forwards UDP packets.'."\n" + .'* **Any**: forwards all packets.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TCP', + ], + 'Port' => [ + 'description' => 'The port number.'."\n", + 'type' => 'number', + 'format' => 'float', + 'required' => true, + 'example' => '3306', + ], + 'SourceCidrIp' => [ + 'description' => 'The source CIDR block.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '172.16.0.0/12', + ], + ], + ], + ], + ], + ], + ], + 'ResourcesSpec' => [ + 'description' => 'The resource configurations of the addon.'."\n", + 'type' => 'object', + 'properties' => [ + 'EipResource' => [ + 'description' => 'The Elastic IP Address (EIP) configurations of the service.'."\n", + 'type' => 'object', + 'properties' => [ + 'AutoCreate' => [ + 'description' => 'Indicates whether the EIP is automatically created.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'EipInstanceId' => [ + 'description' => 'The EIP ID.'."\n", + 'type' => 'string', + 'example' => 'eip-bp1jwtsuoiif2qf90****', + ], + 'InstanceChargeType' => [ + 'description' => 'The billing method of the EIP. Valid values:'."\n" + ."\n" + .'* PostPaid: pay-as-you-go.'."\n" + .'* PrePaid: subscription.'."\n" + ."\n" + .'Default value: PostPaid'."\n", + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'InternetChargeType' => [ + 'description' => 'The metering method of the EIP. Valid values:'."\n" + ."\n" + .'* PayByBandwidth: pay by bandwidth.'."\n" + .'* PayByTraffic: pay by data transfer.'."\n" + ."\n" + .'Valid values of N: 1 to 10.'."\n", + 'type' => 'string', + 'example' => 'PayByTraffic', + ], + 'Bandwidth' => [ + 'description' => 'The maximum bandwidth of the EIP. Unit: Mbit/s.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + 'EcsResources' => [ + 'description' => 'The Elastic Compute Service (ECS) resource configurations of the addon.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the ECS instance.'."\n", + '$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' => 'DescribeAddonTemplate', + ], + 'DeleteCluster' => [ + 'summary' => 'Releases an Enterprise High Performance Computing (E-HPC) cluster.', + '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' => 'The ID of the E-HPC cluster to be released.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-QKKVqO****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'The request result. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F1AB6D8D-E185-4D94-859C-7CE7B8B7****', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + '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' => 'DeleteCluster', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'Make sure that data of the cluster to be deleted is backed up before you call this operation.'."\n" + ."\n" + .'> After a cluster is released, you cannot restore the data stored in the cluster. Exercise caution when you release a cluster.'."\n", + ], + 'CreateUsers' => [ + 'summary' => 'Adds users to an Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The users that you want to add.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the user.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserName' => [ + 'description' => 'The username. The username must be 1 to 30 characters in length. It must start with a letter and can contain digits, letters, and periods (.).'."\n" + ."\n" + .'You can add up to 20 users in a call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testuser', + ], + 'Group' => [ + 'description' => 'The permission group to which the user belongs. Valid values:'."\n" + ."\n" + .'users: ordinary permissions, which are suitable for ordinary users that need only to submit and debug jobs. wheel: sudo permissions, which are suitable for administrators who need to manage clusters. In addition to submitting and debugging jobs, you can also run sudo commands to install software and restart nodes. You can add up to 20 users in a call.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'users', + ], + 'Password' => [ + 'description' => 'The password of the user. The password must be 6 to 30 characters in length and must contain three of the following character types:'."\n" + ."\n" + .'* Uppercase letters'."\n" + .'* Lowercase letters'."\n" + .'* Digits'."\n" + .'* Special characters ()~!@#$%^&\\*-\\_+=|{}\\[]:;\'/<>,.?/'."\n" + ."\n" + .'You can add up to 20 users in a call.'."\n" + ."\n" + .'Specify one of the Password and AuthKey parameters. The Password parameter takes effect only when the cluster authentication method is set to Password. Password authentication is recommended.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1@a2****', + ], + 'AuthKey' => [ + 'description' => 'The public key of the user.'."\n" + ."\n" + .'You can add up to 20 users in a call.'."\n" + ."\n" + .'Specify one of the Password and AuthKey parameters. The AuthKey parameter takes effect only when the cluster authentication method is set to Key. Key authentication is not recommended.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Abc****', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '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' => 'CreateUsers', + ], + 'UpdateUser' => [ + 'summary' => 'Updates the information of a user in an Elastic High Performance Computing (E-HPC) cluster, including the user group and password.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testuser', + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user group attribute of the user that you want to update. Valid values:'."\n" + ."\n" + .'* users: ordinary permissions, which are suitable for ordinary users that need only to submit and debug jobs.'."\n" + .'* wheel: sudo permissions, which are suitable for administrators who need to manage clusters. In addition to submitting and debugging jobs, you can also run sudo commands to install software and restart nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'users', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password attribute of the user that you want to update. The password must be 6 to 30 characters in length and must contain three of the following four character types:'."\n" + ."\n" + .'* Uppercase letters'."\n" + .'* Lowercase letters'."\n" + .'* Digits'."\n" + .'* Special characters ()~!@#$%^&\\*-\\_+=|{}\\[]:;\'/<>,.?/'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Success' => [ + 'description' => 'The request result. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + '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' => 'UpdateUser', + ], + 'ListUsers' => [ + 'summary' => 'Queries the users of a cluster.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n" + ."\n" + .'Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: 1 to 50.'."\n" + ."\n" + .'Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'Users' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'UserInfo' => [ + 'description' => 'The information about the users.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the user.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserName' => [ + 'description' => 'The username.'."\n", + 'type' => 'string', + 'example' => 'testuser', + ], + 'AddTime' => [ + 'description' => 'The time when the user was first added.'."\n", + 'type' => 'string', + 'example' => '2014-08-22T17:46:47', + ], + 'Group' => [ + 'description' => 'The name of the permission group. Valid values:'."\n" + ."\n" + .'users: ordinary permissions, which are suitable for regular users that need only to submit and debug jobs.'."\n" + ."\n" + .'wheel: sudo permissions, which are suitable for administrators who need to manage clusters. In addition to submitting and debugging jobs, you can also run sudo commands to install software and restart nodes.'."\n", + 'type' => 'string', + 'example' => 'users', + ], + 'UserId' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1001', + ], + 'GroupId' => [ + 'description' => 'The permission group ID.'."\n", + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + ], + [ + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AgentError.Account.DomainNotExist', + 'errorMessage' => 'The specified domain does not exist: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.GetentPasswdFailure', + 'errorMessage' => 'Failed to get the user list: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.GetUserListFailure', + 'errorMessage' => 'Get user list fail: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + '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' => 'ListUsers', + ], + 'DeleteUsers' => [ + 'summary' => 'Deletes users from a cluster.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'User', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The users that you want to delete.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the user that you want to delete.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserName' => [ + 'description' => 'The name of user N that you want to delete.'."\n" + ."\n" + .'Valid values of N: 1 to 100.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testuser', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidClusterStatus', + 'errorMessage' => 'The operation failed due to invalid cluster status.', + ], + ], + [ + [ + 'errorCode' => 'ClusterNotFound', + 'errorMessage' => 'The specified cluster does not exist.', + ], + [ + 'errorCode' => 'ManagerNotFound', + 'errorMessage' => 'The manager nodes do not exist or their status is abnormal.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AgentError', + 'errorMessage' => 'The agent service request failed.', + ], + [ + 'errorCode' => 'AgentError.Account.DomainNotExist', + 'errorMessage' => 'The specified domain does not exist: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.GetentPasswdFailure', + 'errorMessage' => 'Failed to get the user list: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserNotExist', + 'errorMessage' => 'The specified user is not found in the domain: %s.', + ], + [ + 'errorCode' => 'AgentError.Account.UserDeleteFailure', + 'errorMessage' => 'Failed to delete user from domain: %s.', + ], + [ + 'errorCode' => 'AgentResponseTimeout', + 'errorMessage' => 'Agent response timeout: %s', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'You are not authorized by RAM for this request.', + ], + ], + 409 => [ + [ + 'errorCode' => 'PartFailure', + 'errorMessage' => 'Part of the batch operation failed.', + ], + ], + 500 => [ + [ + 'errorCode' => 'UnknownError', + 'errorMessage' => 'An unknown error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE****\\"\\n}","type":"json"}]', + 'title' => 'DeleteUsers', + ], + 'CreateQueue' => [ + 'summary' => 'Creates a queue for an Enterprise High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Queue', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The configurations of the queue to be created.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/QueueTemplate', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Name' => [ + 'description' => 'The name of the created queue.'."\n", + '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' => 'CreateQueue', + ], + 'CreateNodes' => [ + 'summary' => 'Creates compute nodes for an Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the queue for which you want to create compute nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + 'name' => 'Count', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of compute nodes that you want to add. Valid values: 1 to 99. The MinCount value must be smaller than the Count value.'."\n" + ."\n" + .'* If the number of available Elastic Compute Service (ECS) instances is smaller than the MinCount value, the nodes fail to be added.'."\n" + .'* If the number of available ECS instances is larger than the MinCount value but smaller than the Count value, nodes are added based on the MinCount value.'."\n" + .'* If the number of available ECS instances is larger than the Count value, nodes are added based on the Count value.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'MinCount', + 'in' => 'query', + 'schema' => [ + 'title' => '添加的计算节点最小数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + [ + 'name' => 'ComputeNode', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The hardware configurations of the compute nodes.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/NodeTemplate', + ], + ], + [ + 'name' => 'HPCInterConnect', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the network between compute nodes. Valid values:'."\n" + ."\n" + .'* vpc'."\n" + .'* eRDMA'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the vSwitch to be used by the added nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1lfcjbfb099rrjn****', + ], + ], + [ + 'name' => 'RamRole', + 'in' => 'query', + 'schema' => [ + 'description' => 'The Resource Access Management (RAM) role to be assumed by the added nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunServiceRoleForOOSBandwidthScheduler', + ], + ], + [ + 'name' => 'HostnamePrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The hostname prefix of the added compute nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + ], + [ + 'name' => 'HostnameSuffix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The hostname suffix of the added compute nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'demo', + ], + ], + [ + 'name' => 'KeepAlive', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable deletion protection for the added compute nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DeploymentSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Deployment set ID. You can obtain the deployment set ID through [DescribeDeploymentSets](~~91313~~). Currently, only deployment sets with a low network latency strategy are supported.', + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp1frxuzdg87zh4pzq****', + ], + ], + [ + 'name' => 'ReservedNodePoolId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Preset node pool ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'rnp-756vlp7a', + ], + ], + [ + 'name' => 'Hostnames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceIds' => [ + 'description' => 'The IDs of the compute nodes to be created.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the compute node to be created.'."\n", + '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' => 'CreateNodes', + 'description' => '## [](#)'."\n", + 'translator' => 'machine', + ], + 'UpdateQueue' => [ + 'summary' => 'Modifies the configurations of a queue in an Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Queue', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the queue to be updated.'."\n", + 'type' => 'object', + 'properties' => [ + 'QueueName' => [ + 'title' => 'QueueName', + 'description' => 'The queue name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'comp', + ], + 'EnableScaleOut' => [ + 'title' => 'EnableScaleOut', + 'description' => 'Specifies whether to enable auto scale-out for the queue. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'EnableScaleIn' => [ + 'title' => 'EnableScaleIn', + 'description' => 'Specifies whether to enable auto scale-in for the queue. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'MinCount' => [ + 'title' => 'MinCount', + 'description' => 'The minimum number of compute nodes that the queue must contain.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'MaxCount' => [ + 'title' => 'MaxCount', + 'description' => 'The maximum number of compute nodes that the queue can contain.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + 'InitialCount' => [ + 'title' => 'InitialCount', + 'description' => 'The initial number of compute nodes in the queue.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'InterConnect' => [ + 'title' => 'HPCInterConnect', + 'description' => 'The type of the network for interconnecting compute nodes in the queue.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'erdma', + ], + 'VSwitchIds' => [ + 'title' => 'VSwitchIds', + 'description' => 'The vSwitches available for use by compute nodes in the queue.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VSwitchId', + ], + 'required' => false, + ], + 'ComputeNodes' => [ + 'title' => 'Resources', + 'description' => 'The hardware configurations of the compute nodes in the queue. Valid values of N: 1 to 10.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the compute node.'."\n", + 'required' => false, + '$ref' => '#/components/schemas/NodeTemplate', + ], + 'required' => false, + ], + 'AllocationStrategy' => [ + 'title' => 'AllocationStrategy', + 'description' => 'The policy based on which instance types are selected for compute nodes during auto scale-outs. Valid values:'."\n" + ."\n" + .'* PriorityInstanceType'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PriorityInstanceType', + ], + 'RamRole' => [ + 'title' => 'RamRole', + 'description' => 'The Resource Access Management (RAM) role that is assumed by compute nodes in the queue.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunECSInstanceForEHPCRole', + ], + 'HostnamePrefix' => [ + 'title' => 'HostNamePrefix', + 'description' => 'The hostname prefix of the added compute nodes.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + 'HostnameSuffix' => [ + 'title' => 'HostNameSuffix', + 'description' => 'The hostname suffix of the compute nodes in the queue.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hpc', + ], + 'MaxCountPerCycle' => [ + 'title' => 'MaxCountPerCycle', + 'description' => 'The minimum number of compute nodes that are added to the queue during an automatic scale-out.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '99', + ], + 'KeepAliveNodes' => [ + 'description' => 'List of excluded compute nodes in the queue.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hostname of the excluded compute node.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'compute000', + ], + 'required' => false, + ], + 'ReservedNodePoolId' => [ + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + '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' => 'UpdateQueue', + ], + 'UpdateNodes' => [ + 'summary' => 'Updates the configurations of compute nodes in an Enterprise High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Instances', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about the compute nodes that you want to update.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the compute node.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'The instance ID of the compute node.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1bzqq1ddeemuddn****', + ], + 'KeepAlive' => [ + 'description' => 'Specifies whether to enable deletion protection for the compute node.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Success' => [ + 'description' => 'The request result. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + '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' => 'UpdateNodes', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'Before you delete a compute node, we recommend that you export all job data from the node to prevent data loss.'."\n", + ], + 'ListQueues' => [ + 'summary' => 'Queries queues in an Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The names of the queues that you want to query. You can specify up to eight names.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queue name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The results returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'C6E5005C-00B0-4F27-98BB-95AB88016C22', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-FYUr32****', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Queues' => [ + 'description' => 'The information about the queues.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the queue.'."\n", + 'type' => 'object', + 'properties' => [ + 'QueueName' => [ + 'description' => 'The queue name.'."\n", + 'type' => 'string', + 'example' => 'comp', + ], + 'EnableScaleOut' => [ + 'description' => 'Indicates whether auto scale-out is enabled for the queue. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableScaleIn' => [ + 'description' => 'Indicates whether auto scale-in is enabled for the queue. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'MinCount' => [ + 'description' => 'The minimum number of compute nodes that the queue must contain.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxCount' => [ + 'description' => 'The maximum number of compute nodes that the queue can contain.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'MaxCountPerCycle' => [ + 'description' => 'The minimum number of compute nodes that are added to the queue in each auto scale-out.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ComputeNodes' => [ + 'description' => 'The hardware configurations of the compute nodes that are added in auto scale-outs. Up to five nodes are displayed.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hardware configurations of the compute nodes.'."\n", + '$ref' => '#/components/schemas/NodeTemplate', + ], + ], + 'VSwitchIds' => [ + 'description' => 'The vSwitches that can be used for added nodes during auto scale-outs. Up to three vSwitches are displayed.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp12pmqe9gh0pi7i1f2ed', + ], + ], + 'Nodes' => [ + 'description' => 'The statistics about the compute nodes in the queue.'."\n", + 'type' => 'object', + 'properties' => [ + 'RunningCounts' => [ + 'description' => 'The number of running compute nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExceptionCounts' => [ + 'description' => 'The number of malfunctioning compute nodes.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreatingCounts' => [ + 'description' => 'The number of compute nodes that are not ready.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + ], + ], + 'CreateTime' => [ + 'description' => 'The time when the queue was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. For more information, see [ISO 8601](~~25696~~).'."\n", + 'type' => 'string', + 'example' => '2023-11-10T02:04:00Z', + ], + 'UpdateTime' => [ + 'description' => 'The time when the queue was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC. For more information, see [ISO 8601](~~25696~~).'."\n", + 'type' => 'string', + 'example' => '2024-04-25T02:02:32', + ], + 'TotalCores' => [ + 'description' => 'The total number of vCPUs that are used by all compute nodes in the queue.'."\n", + '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' => 'ListQueues', + ], + 'ListNodes' => [ + 'summary' => 'Queries the nodes of an Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID. You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Hostnames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The hostnames of the compute nodes that you want to query.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hostname.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'compute000', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IP addresses of the compute nodes that you want to query.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The Virtual Private Cloud (VPC) IP address of the compute node.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '172.16.**.**', + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Sequence', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the results are sorted in ascending or descending order. Valid values:'."\n" + ."\n" + .'* Forward: ascending'."\n" + .'* Backward: descending'."\n" + ."\n" + .'Default value: Forward.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Forward', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting method of the node list. Valid values:'."\n" + ."\n" + .'* AddedTime: sorts the nodes by the time that they were added.'."\n" + .'* HostName: sorts the nodes by their hostnames.'."\n" + ."\n" + .'Default value: addedtime.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AddedTime', + ], + ], + [ + 'name' => 'QueueNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The queues to which the nodes belong.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queue name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The states of the compute nodes to be queried.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The state of the compute node. Valid values:'."\n" + ."\n" + .'* uninit: The node is being installed.'."\n" + .'* initing: The node is being initialized.'."\n" + .'* running: The node is running.'."\n" + .'* releasing: The node is being released.'."\n" + .'* stopped: The node is stopped.'."\n" + .'* exception: The node has run into an exception.'."\n" + .'* untracking: The node is not added to the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'running', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '89A1AC0F-4A6C-4F3D-98F9-BEF9A823****', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Nodes' => [ + 'description' => 'The information about the nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'VpcId' => [ + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-bp1gnu8br4ay7beb2w****', + ], + 'Status' => [ + 'description' => 'The node state. Valid values:'."\n" + ."\n" + .'* uninit: The node is being installed.'."\n" + .'* initing: The node is being initialized.'."\n" + .'* running: The node is running.'."\n" + .'* releasing: The node is being released.'."\n" + .'* stopped: The node is stopped.'."\n" + .'* exception: The node has run into an exception.'."\n" + .'* untracking: The node is not added to the cluster.'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'HtEnabled' => [ + 'description' => 'Indicates whether hyper-threading is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Hostname' => [ + 'description' => 'The hostname of the node.'."\n", + 'type' => 'string', + 'example' => 'edas.cn-shanghai.aliyuncs.com', + ], + 'InstanceType' => [ + 'description' => 'The instance type of the node.'."\n", + 'type' => 'string', + 'example' => 'ecs.c5.large', + ], + 'PublicIpAddress' => [ + 'description' => 'The public IP address of the node.'."\n", + 'type' => 'string', + 'example' => '172.16.**.**', + ], + 'SpotStrategy' => [ + 'description' => 'The bidding policy of the node. Valid values:'."\n" + ."\n" + .'* NoSpot: The instances of the compute node are pay-as-you-go instances.'."\n" + .'* SpotWithPriceLimit: The instances are created as preemptible instances with a user-defined maximum hourly price.'."\n" + .'* SpotAsPriceGo: The node is a preemptible instance for which the market price at the time of purchase is automatically used as the bidding price.'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID of the node.'."\n", + 'type' => 'string', + 'example' => 'vsw-bp1e47optm9g58zcu****', + ], + 'IpAddress' => [ + 'description' => 'The VPC IP address of the node.'."\n", + 'type' => 'string', + 'example' => '172.16.**.**', + ], + 'ExpiredTime' => [ + 'description' => 'The time when the node expires.'."\n", + 'type' => 'string', + 'example' => '2020-06-09T06:22:02.000Z', + ], + 'ZoneId' => [ + 'description' => 'The zone ID of the node.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'AddTime' => [ + 'description' => 'The time when the node was created.'."\n", + 'type' => 'string', + 'example' => '2020-06-09T06:22:02.000Z', + ], + 'ImageId' => [ + 'description' => 'The image ID of the node.'."\n", + 'type' => 'string', + 'example' => 'centos_7_06_64_20G_alibase_20190711.vhd', + ], + 'Id' => [ + 'description' => 'The instance ID of the node.'."\n", + 'type' => 'string', + 'example' => 'i-bp15707mys2rsy0j****', + ], + 'TotalResources' => [ + 'description' => 'The hardware configurations of the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Gpu' => [ + 'description' => 'The number of GPUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Memory' => [ + 'description' => 'The amount of memory. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + ], + ], + 'StateInSched' => [ + 'description' => 'The node state in the scheduler.'."\n", + 'type' => 'string', + 'example' => 'active', + ], + 'QueueName' => [ + 'description' => 'The name of the queue to which the node belongs.'."\n", + 'type' => 'string', + 'example' => 'autoque3', + ], + 'KeepAlive' => [ + 'description' => 'Indicates whether deletion protection is enabled for the node. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DeploymentSetId' => [ + 'description' => 'The deployment set ID.'."\n", + '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' => 'ListNodes', + ], + 'GetQueue' => [ + 'summary' => 'Queries the details of a queue in an Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The queue name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Queue' => [ + 'description' => 'The queue configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'QueueName' => [ + 'title' => 'QueueName', + 'description' => 'The queue name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'comp', + ], + 'EnableScaleOut' => [ + 'title' => 'EnableScaleOut', + 'description' => 'Indicates whether auto scale-out is enabled for the queue. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableScaleIn' => [ + 'title' => 'EnableScaleIn', + 'description' => 'Indicates whether auto scale-in is enabled for the queue. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'MinCount' => [ + 'title' => 'MinCount', + 'description' => 'The minimum number of compute nodes that the queue must contain.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MaxCount' => [ + 'title' => 'MaxCount', + 'description' => 'The maximum number of compute nodes that the queue can contain.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1000', + ], + 'InitialCount' => [ + 'title' => 'InitialCount', + 'description' => 'The initial number of nodes in the queue.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'InterConnect' => [ + 'title' => 'HPCInterConnect', + 'description' => 'The type of the network between compute nodes in the queue. Valid values:'."\n" + ."\n" + .'* vpc'."\n" + .'* eRDMA'."\n", + 'type' => 'string', + 'example' => 'erdma', + ], + 'VSwitchIds' => [ + 'title' => 'VSwitchIds', + 'description' => 'The available vSwitches for compute nodes in the queue. Valid values of N: 1 to 5.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-t4nw7upbpzb3u071twiys', + ], + ], + 'ComputeNodes' => [ + 'title' => 'Resources', + 'description' => 'The hardware configurations of the compute nodes in the queue.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configurations of the compute node.'."\n", + '$ref' => '#/components/schemas/NodeTemplate', + ], + ], + 'AllocationStrategy' => [ + 'title' => 'AllocationStrategy', + 'description' => 'The auto scale-out policy of the queue.'."\n", + 'type' => 'string', + 'example' => 'PriorityInstanceType', + ], + 'RamRole' => [ + 'title' => 'RamRole', + 'description' => 'The Resource Access Management (RAM) role that is assumed by compute nodes in the queue.'."\n", + 'type' => 'string', + 'example' => 'AliyunECSInstanceForEHPCRole', + ], + 'HostnamePrefix' => [ + 'title' => 'HostNamePrefix', + 'description' => 'The hostname prefix of the compute nodes in the queue.'."\n", + 'type' => 'string', + 'example' => 'compute', + ], + 'HostnameSuffix' => [ + 'title' => 'HostNameSuffix', + 'description' => 'The hostname suffix of the compute nodes in the queue.'."\n", + 'type' => 'string', + 'example' => 'demo', + ], + 'MaxCountPerCycle' => [ + 'title' => 'MaxCountPerCycle', + 'description' => 'The minimum number of nodes that are delivered to the queue in each scale-out cycle.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99', + ], + 'KeepAliveNodes' => [ + 'description' => 'The nodes for which deletion protection is enabled in the queue.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hostname of the node for which deletion protection is enabled.'."\n", + 'type' => 'string', + 'example' => 'compute000', + ], + ], + 'ReservedNodePoolId' => [ + 'description' => 'Preset node pool ID.', + 'type' => 'string', + 'example' => 'rnp-756vlp7a', + ], + 'CreateTime' => [ + 'title' => '队列创建时间。'."\n", + 'type' => 'string', + 'example' => '2025-01-01T12:05:00Z', + ], + 'UpdateTime' => [ + 'title' => '队列更新时间。', + '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' => 'GetQueue', + 'translator' => 'machine', + ], + 'DeleteQueues' => [ + 'summary' => 'Deletes queues from an Enterprise High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'QueueNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The queues that you want to delete.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queue that you want to delete.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 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' => 'DeleteQueues', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'Before you delete a queue, you must delete all compute nodes in the queue.'."\n", + ], + 'DeleteNodes' => [ + 'summary' => 'Deletes compute nodes from an Enterprise High Performance Computing (E-HPC) cluster at a time.', + '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' => 'The cluster ID. You can call the [listclusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'InstanceIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The instance IDs of the compute nodes that you want to delete.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance ID of the compute node that you want to delete.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-hp3347creaivnt******', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + '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' => 'DeleteNodes', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'Before you delete a compute node, we recommend that you export all job data from the node to prevent data loss.'."\n", + ], + 'CreateJob' => [ + 'summary' => 'Creates a job for a cluster.', + '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' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestJob', + ], + ], + [ + 'name' => 'JobSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The job configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'CommandLine' => [ + 'description' => 'The command or script that is used to run the job. If you want to use a command, you must specify the full path of the command, for example, /bin/ping.'."\n" + ."\n" + .'If you want to use a script, you must make sure that you have the execution permissions on it. By default, the user root directory ~/ is used as the default script path on the cluster side. If your script is not in that directory, you must specify the full path in this parameter, such as /home/xxx/job.sh Note that in this mode, if requirements on resources such as CPU and memory are specified in the script, the job will be run based on the resource requirements specified in the script. In this case, do not specify resource requirements in the Resource parameter. Otherwise, the job may fail to run.'."\n" + ."\n" + .'If you want to run the job directly by using the CLI, you must specify the absolute path of the command and add two hyphens and a space (-- ) before the path, such as -- /bin/ping -c 10 localhost.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '/home/xxx/test.job', + ], + 'RunasUser' => [ + 'description' => 'The cluster-side user as which you want to submit the job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testuser', + ], + 'RunasUserPassword' => [ + 'description' => 'The password of the user specified by the RunasUser parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'Priority' => [ + 'description' => 'The job priority.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'StdoutPath' => [ + 'description' => 'The path of the standard output file of the job. You need to specify the full path.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/home/xxx/job.out', + ], + 'StderrPath' => [ + 'description' => 'The path of the standard error output file of the job. You need to specify the full path.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/home/xxx/job.err', + ], + 'JobQueue' => [ + 'description' => 'The queue to which the job belongs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + 'ArrayRequest' => [ + 'description' => 'The jobs in the queue.'."\n" + ."\n" + .'Format: X-Y:Z. X is the minimum index value. Y is the maximum index value. Z is the step size. For example, 2-7:2 indicates that three jobs need to be run and their index values are 2, 4, and 6.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1-5:2', + ], + 'Variables' => [ + 'description' => 'The environment variables of the job. The value is a string in the JSON array format. Each array member is a JSON object that contains two members: Name and Value. Name indicates the name of the environment variable, and Value indicates the value of the environment variable.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"Name":"x", "Value":"y"}]', + ], + 'PostCmdLine' => [ + 'description' => 'The post-processing command of the job.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '/bin/sleep 10', + ], + 'WallTime' => [ + 'description' => 'The maximum duration for which the job can be run. Format: `hour: minute: second`. For example, `01:00:00` indicates 1 hour.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '360:48:50', + ], + 'Resources' => [ + 'description' => 'The resource configurations of the job.'."\n", + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'The number of compute nodes to be allocated to the job.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'Cores' => [ + 'description' => 'The number of vCPUs to be allocated to each compute node.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'Memory' => [ + 'description' => 'The memory size to be allocated to each compute node. The memory size is in string format. Unit: MB or GB.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '4gb', + ], + 'Gpus' => [ + 'description' => 'The number of GPUs to be allocated to each compute node.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A0A38A38-1565-555E-B597-E48A2E******', + ], + 'JobId' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'example' => 'Submitted batch job 10\\n', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + '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' => 'CreateJob', + 'description' => 'Before you call this operation, make sure that you understand the billing and [pricing](https://www.aliyun.com/price/product#/ecs/detail) of E-HPC.'."\n", + ], + 'ListJobs' => [ + 'summary' => 'Queries the jobs in a cluster.', + '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' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-csbua72***', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n" + ."\n" + .'* Pages start from page 1.'."\n" + .'* Default value: 1'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'* Maximum value: 50.'."\n" + .'* Default value: 10'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '10', + ], + ], + [ + 'name' => 'JobFilter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The job filter information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Users' => [ + 'description' => 'The users that run the jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The user that runs the job. Fuzzy match is supported.'."\n" + ."\n" + .'You can call the [ListUsers](url) to obtain the user.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testuser1', + ], + 'required' => false, + ], + 'Queues' => [ + 'description' => 'The queues to which the jobs belong.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queue name. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + 'required' => false, + ], + 'Nodes' => [ + 'description' => 'The compute nodes that run the jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The hostname of the compute node. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'compute000', + ], + 'required' => false, + ], + 'JobName' => [ + 'description' => 'The job name. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testjob', + ], + 'JobStatus' => [ + 'description' => 'The job status. Valid values:'."\n" + ."\n" + .'* all: returns all jobs.'."\n" + .'* finished: returns completed jobs.'."\n" + .'* notfinish: returns uncompleted jobs.'."\n" + ."\n" + .'Default value: all.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'all', + ], + 'CreateTimeStart' => [ + 'description' => 'The time when the job started. The value is a UNIX timestamp representing the number of seconds that have elapsed since 1970-01-01T00:00:00Z.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1724122486', + ], + 'CreateTimeEnd' => [ + 'description' => 'The time when the job was last updated. The value is a UNIX timestamp representing the number of seconds that have elapsed since 1970-01-01T00:00:00Z.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1724123085', + ], + 'SortBy' => [ + 'description' => 'The result sorting configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExecuteOrder' => [ + 'description' => 'The order in which jobs are sorted based on their execution time. Valid values:'."\n" + ."\n" + .'* asc: in ascending order.'."\n" + .'* desc: in descending order.'."\n" + ."\n" + .'Default value: desc.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + 'SubmitOrder' => [ + 'description' => 'The order in which jobs are sorted based on their submitting time. Valid values:'."\n" + ."\n" + .'* asc: in ascending order.'."\n" + .'* desc: in descending order.'."\n" + ."\n" + .'Default value: desc.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + 'PendOrder' => [ + 'description' => 'The order in which jobs are sorted based on their queuing time. Valid values:'."\n" + ."\n" + .'* asc: in ascending order.'."\n" + .'* desc: in descending order.'."\n" + ."\n" + .'Default value: desc.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + 'required' => false, + ], + 'Diagnosis' => [ + 'description' => 'Job diagnosis and analysis list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Job diagnosis and analysis details.', + 'type' => 'object', + 'properties' => [ + 'Option' => [ + 'description' => 'Job diagnosis and analysis metrics', + 'type' => 'string', + 'required' => false, + 'example' => 'run_duration', + ], + 'Operator' => [ + 'description' => 'Job diagnosis threshold comparator.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'greater_or_equal' => '大于等于', + 'less' => '小于', + 'less_or_equal' => '小于等于', + 'greater' => '大于', + ], + 'example' => 'greater', + ], + 'Threshold' => [ + 'description' => 'Job diagnosis threshold.', + 'type' => 'string', + 'required' => false, + 'example' => '24', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'EABFBD93-58BE-53F3-BBFE-8654BB2E****', + ], + 'PageNumber' => [ + 'description' => 'The page number. Default value: 1'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => 'The number of entries per page. Default value: 10'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Jobs' => [ + 'description' => 'The jobs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the job.'."\n", + 'type' => 'object', + 'properties' => [ + 'JobName' => [ + 'description' => 'The job name.'."\n", + 'type' => 'string', + 'example' => 'testjob', + ], + 'JobSpec' => [ + 'description' => 'The job configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'example' => '12', + ], + 'RunasUser' => [ + 'description' => 'The user that ran the job.'."\n", + 'type' => 'string', + 'example' => 'testuser1', + ], + 'Comment' => [ + 'description' => 'The job description.'."\n", + 'type' => 'string', + 'example' => 'jobDescription', + ], + 'State' => [ + 'description' => 'The job state. Valid values: (PBS cluster and Slurm cluster)'."\n" + ."\n" + .'* FINISHED/Completed'."\n" + .'* RUNNING/Running'."\n" + .'* QUEUED/Pending'."\n" + .'* FAILED/Failed'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'StderrPath' => [ + 'description' => 'The error output path.'."\n", + 'type' => 'string', + 'example' => './Temp', + ], + 'StdoutPath' => [ + 'description' => 'The standard output path.'."\n", + 'type' => 'string', + 'example' => './Temp', + ], + 'Priority' => [ + 'description' => 'The job priority. Valid values: 0 to 9. A larger value indicates a higher priority.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'ArrayRequest' => [ + 'description' => 'The queue format of the job.'."\n" + ."\n" + .'* If the job is not in a queue, the output is empty.'."\n" + .'* The format is X-Y:Z. X indicates the first index, Y indicates the final index, and Z indicates the step size. For example, 2-7:2 indicates three sub-jobs numbered 2, 4, and 6.'."\n", + 'type' => 'string', + 'example' => '1-5:2', + ], + 'LastModifyTime' => [ + 'description' => 'The time when the job was last updated.'."\n", + 'type' => 'string', + 'example' => '1724123085', + ], + 'NodeList' => [ + 'description' => 'The compute nodes that were used to run the job.'."\n", + 'type' => 'string', + 'example' => 'compute[002,005,003]', + ], + 'SubmitTime' => [ + 'description' => 'The time when the job was submitted.'."\n", + 'type' => 'string', + 'example' => '1724122486', + ], + 'JobQueue' => [ + 'description' => 'The queue name.'."\n", + 'type' => 'string', + 'example' => 'comp', + ], + 'Variables' => [ + 'description' => 'The variables of the job.'."\n", + 'type' => 'string', + 'example' => '{"PBS_O_SHELL":"/bin/bash", "PBS_O_HOST":"manager", "PBS_O_SYSTEM":"Linux", "PBS_O_LANG":"en_US.UTF-8", "PBS_O_QUEUE":"workq"}', + ], + 'Resources' => [ + 'description' => 'The information about the resources required to run the job.'."\n", + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'The number of compute nodes that were used to run the job.'."\n", + 'type' => 'string', + 'example' => '3', + ], + 'Cores' => [ + 'description' => 'The number of vCPUs that were used to run the job.'."\n", + 'type' => 'string', + 'example' => '6', + ], + 'Memory' => [ + 'description' => 'The size of memory that was used to run the job.'."\n", + 'type' => 'string', + 'example' => '1536MB', + ], + 'Gpus' => [ + 'description' => 'The number of GPUs that were used to run the job.'."\n", + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'ArrayJobId' => [ + 'description' => 'The array job ID.'."\n", + 'type' => 'string', + 'example' => '4', + ], + 'ArrayJobSubId' => [ + 'description' => 'The ID of the job in the array.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ResourcesActualOccupied' => [ + 'description' => 'Actual resource usage of the job program', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'Number of compute nodes.', + 'type' => 'string', + 'example' => '2', + ], + 'Cores' => [ + 'description' => 'Number of CPU cores.', + 'type' => 'string', + 'example' => '4', + ], + 'Memory' => [ + 'description' => 'Number of memory.', + 'type' => 'string', + 'example' => '982MB', + ], + 'Gpus' => [ + 'description' => 'Number of CPUs', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'StartTime' => [ + 'description' => 'Job start time.', + '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' => 'ListJobs', + 'translator' => 'machine', + ], + 'GetJobLog' => [ + 'summary' => 'Queries the output logs of a job, including standard output logs and error output logs.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-jeJki6****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.manager', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The log type. Valid values:'."\n" + ."\n" + .'* stdout: standard output logs.'."\n" + .'* stderr: error output logs.'."\n" + .'* all: all logs.'."\n" + ."\n" + .'Default value: all.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'stdout', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum size of logs that you can read in a single request.'."\n" + ."\n" + .'Unit: bytes.'."\n" + ."\n" + .'Default value: 10240.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '20480', + ], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => [ + 'description' => 'The position where logs start to be read.'."\n" + ."\n" + .'Unit: bytes.'."\n" + ."\n" + .'Default value: 0.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'B745C159-3155-4B94-95D0-4B73D4D2****', + ], + 'JobId' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'example' => '1.manager', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'StdoutLog' => [ + 'description' => 'The standard output log that is encoded in Base64.'."\n", + 'type' => 'string', + 'example' => 'aG9zdG5hbWU=', + ], + 'StderrLog' => [ + 'description' => 'The error output log that is encoded in Base64.'."\n", + 'type' => 'string', + 'example' => 'aG9zdG5hbWU=', + ], + 'StdoutLogSize' => [ + 'description' => 'The size of the standard output file.'."\n", + 'type' => 'string', + 'example' => '4096', + ], + 'StderrLogSize' => [ + 'description' => 'The size of the error output file.'."\n", + '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' => 'GetJobLog', + 'description' => '## [](#)Usage notes'."\n" + ."\n" + .'Currently, only Slurm and PBS Pro schedulers for Standard Edition clusters are supported.'."\n", + ], + 'GetJob' => [ + 'summary' => 'Obtains the details of a job.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The job ID. You can call the ListJobs operation to query the job ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1.manager', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '04F0****-1335-****-A1D7-6C044FE7****', + ], + 'JobInfo' => [ + 'description' => 'The job details.'."\n", + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => 'The job ID.'."\n", + 'type' => 'string', + 'example' => '1.manager', + ], + 'JobName' => [ + 'description' => 'The job name.'."\n", + 'type' => 'string', + 'example' => 'testJob'."\n", + ], + 'RunasUser' => [ + 'description' => 'The user to which the job belongs or that is used to submit the job. This user is a cluster-side user.'."\n", + 'type' => 'string', + 'example' => 'testuser', + ], + 'State' => [ + 'description' => 'The job state.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'JobQueue' => [ + 'description' => 'The queue to which the job belongs.'."\n", + 'type' => 'string', + 'example' => 'workq', + ], + 'CreateTime' => [ + 'description' => 'The time when the job was submitted.'."\n", + 'type' => 'string', + 'example' => '2024-08-16T10:52:48', + ], + 'LastModifyTime' => [ + 'description' => 'The time when the job was last modified.'."\n", + 'type' => 'string', + 'example' => '2024-08-16T10:52:48', + ], + 'ErrorLog' => [ + 'description' => 'The error log file of the job.'."\n", + 'type' => 'string', + 'example' => '/home/xxx/STDIN.e1', + ], + 'StartTime' => [ + 'description' => 'The time when the job was started.'."\n", + 'type' => 'string', + 'example' => '2024-08-16T10:52:48', + ], + 'Priority' => [ + 'description' => 'The priority of the job.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'CommandLine' => [ + 'description' => 'The command that is used to run the job.'."\n", + 'type' => 'string', + 'example' => '/home/huangsf/ehpc/job_meta.pbs', + ], + 'OutputLog' => [ + 'description' => 'The standard output log file of the job.'."\n", + 'type' => 'string', + 'example' => '/home/xxx/STDIN.o1', + ], + 'NodeList' => [ + 'description' => 'The compute nodes that are used to run the job.'."\n", + 'type' => 'string', + 'example' => 'compute000', + ], + 'ArrayRequest' => [ + 'description' => 'The job queue. If the job is not in a queue, the output is empty.'."\n" + ."\n" + .'The format is X-Y:Z. X indicates the first index, Y indicates the final index, and Z indicates the step size. For example, 2-7:2 indicates three sub-jobs numbered 2, 4, and 6.'."\n", + 'type' => 'string', + 'example' => '1-5:2', + ], + 'Resources' => [ + 'description' => 'The resources that were requested when the job was submitted.'."\n", + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'The number of nodes that are used to run the job.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Cores' => [ + 'description' => 'The number of vCPUs used by the job on each node.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Memory' => [ + 'description' => 'The memory size used by the job on each node.'."\n", + 'type' => 'string', + 'example' => '1gb', + ], + 'Gpus' => [ + 'description' => 'The number of GPUs used by the job on each node.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'Variables' => [ + 'description' => 'The variables of the job.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The environment variables.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the environment variable.'."\n", + 'type' => 'string', + 'example' => 'ProxyIP', + ], + 'Value' => [ + 'description' => 'The value of the environment variable.'."\n", + 'type' => 'string', + 'example' => '10.x.x.x', + ], + ], + ], + ], + 'ExtraInfo' => [ + 'description' => 'Additional information.'."\n", + 'type' => 'string', + 'example' => '{}', + ], + 'ResourcesUsed' => [ + 'description' => 'The resources that are actually used by the job.'."\n", + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'The number of nodes that are used to run the job.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Cores' => [ + 'description' => 'The number of vCPUs used by the job on each node.'."\n", + 'type' => 'string', + 'example' => '2', + ], + 'Memory' => [ + 'description' => 'The memory size used by the job on each node.'."\n", + 'type' => 'string', + 'example' => '512mb', + ], + ], + ], + 'ArrayJobId' => [ + 'description' => 'The parent job ID. If the return value is a non-empty string, the job is an array job.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ArrayJobSubId' => [ + 'description' => 'The sub-job ID. This parameter is valid when the ArrayJobId parameter is a non-empty string.'."\n", + 'type' => 'string', + 'example' => '3', + ], + ], + ], + 'Success' => [ + 'description' => 'The request result. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + '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' => 'GetJob', + ], + 'StopJobs' => [ + 'summary' => 'Stops uncompleted jobs in a batch in an Elastic High Performance Computing (E-HPC) cluster.', + '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' => 'The cluster ID.'."\n" + ."\n" + .'You can call the [ListClusters](~~87116~~) operation to query the cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'JobIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of the jobs that you want to stop.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The job ID.'."\n" + ."\n" + .'> The job to be stopped must be in the RUNNING or QUEUED state.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '14', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F8868A00-6757-5542-BDD6-E1040D94****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true: The request was successful.'."\n" + .'* false: The request failed.'."\n", + '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' => 'StopJobs', + ], + 'ListCommonLogs' => [ + 'summary' => 'Queries the logs of a cluster that are generated within a time range.', + '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' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the time range. The time is a timestamp. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1703821542', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the time range. The time is a timestamp. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1703821666', + ], + ], + [ + 'name' => 'ActionName', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The action types.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The action type. Logs of the specific action type are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CreateCluster', + ], + 'required' => false, + ], + ], + [ + 'name' => 'OperatorUid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account ID of the operator.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '137***', + ], + ], + [ + 'name' => 'LogRequestId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The request ID of the action. Logs associated with the specific request ID are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + [ + 'name' => 'ActionStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The action status. Logs associated with the specific action status are returned.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Finished: The action is completed.'."\n" + .'* Failed: The action failed.'."\n" + .'* InProgress: The action is being performed.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Finished' => '', + 'Failed' => '', + 'InProgress' => '', + ], + 'example' => 'Finished', + ], + ], + [ + 'name' => 'LogType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The log type. Logs of the specific type are returned.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Operation', + ], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the resource involved in the action. Logs associated with the specific resource are returned. This parameter is not recommended.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-abc***', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the page to return.'."\n" + ."\n" + .'Pages start from page 1.'."\n" + ."\n" + .'Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values: 1 to 100.'."\n" + ."\n" + .'Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'IsReverse', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to display results in reverse order.'."\n" + ."\n" + .'Default value: true'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '464E9919-D04F-4D1D-B375-15989492****', + ], + 'Uid' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '137***', + ], + 'PageNumber' => [ + 'description' => 'The page number of the returned page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'Logs' => [ + 'description' => 'The brief information of operation logs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The brief information of the log.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID associated with the action that generated the log.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Time' => [ + 'description' => 'The time when the log was generated.'."\n", + 'type' => 'string', + 'example' => '2024-08-22 14:21:54', + ], + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-9T3xPNezoS', + ], + 'OperatorUid' => [ + 'description' => 'The account ID of the operator.'."\n", + 'type' => 'string', + 'example' => '137***', + ], + 'Action' => [ + 'description' => 'The name of the action corresponding to the log.'."\n", + 'type' => 'string', + 'example' => 'CreaterCluster', + ], + 'Status' => [ + 'description' => 'The action state in the log. Valid values:'."\n" + ."\n" + .'* InProgress: The action is being performed.'."\n" + .'* Finished: The action is completed.'."\n" + .'* Failed: The action failed.'."\n", + 'type' => 'string', + 'example' => 'Finished', + ], + 'LogType' => [ + 'description' => 'The log type.'."\n", + 'type' => 'string', + 'example' => 'Operation', + ], + 'Target' => [ + 'description' => 'The involved resource.'."\n", + 'type' => 'string', + 'example' => 'i-abc***', + ], + 'Message' => [ + 'description' => 'The message of the log.'."\n", + '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' => 'ListCommonLogs', + ], + 'GetCommonLogDetail' => [ + 'summary' => 'Query logs based on a request ID. Logs for specific actions can be queried thanks to an Action-Stage-Method three-layer log splitting structure.', + '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' => 'The start time of the time range within which the logs that you want to query were generated. The time is a timestamp. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1703821542', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the time range within which the logs that you want to query were generated. The time is a timestamp. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1703821666', + ], + ], + [ + 'name' => 'LogRequestId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n", + ], + ], + [ + 'name' => 'HiddenProcess', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to hide the process of each step. Valid values:'."\n" + ."\n" + .'* true: hides the process and returns only the result log of each step.'."\n" + .'* false: does not hide the process and displays the start and result logs of each step.'."\n" + ."\n" + .'Default value: true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '464E9919-D04F-4D1D-B375-15989492****'."\n", + ], + 'Uid' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '137***', + ], + 'OperatorUid' => [ + 'description' => 'The account ID of the operator.'."\n", + 'type' => 'string', + 'example' => '239***', + ], + 'Action' => [ + 'description' => 'The action name.'."\n", + 'type' => 'string', + 'example' => 'CreateCluster', + ], + 'ClusterId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'ehpc-hz-abc***', + ], + 'LogType' => [ + 'description' => 'The log type.'."\n", + 'type' => 'string', + 'example' => 'operation', + ], + 'LogDetail' => [ + 'description' => 'The information about the logs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the log.'."\n", + 'type' => 'object', + 'properties' => [ + 'StageName' => [ + 'description' => 'The stage name of the log.'."\n", + 'type' => 'string', + 'example' => 'ConfigNetwork', + ], + 'Stages' => [ + 'description' => 'The information about the log stages.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the log stage.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID associated with the log.'."\n", + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + 'Time' => [ + 'description' => 'The time when the log was generated.'."\n", + 'type' => 'string', + 'example' => '2024-08-22 14:21:54'."\n", + ], + 'Method' => [ + 'description' => 'The method involved in the log.'."\n", + 'type' => 'string', + 'example' => 'CreateSecurityGroup', + ], + 'Status' => [ + 'description' => 'The action state involved in the log. Valid values:'."\n" + ."\n" + .'* InProgress: The action is being performed.'."\n" + .'* Finished: The action is completed.'."\n" + .'* Failed: The action failed.'."\n", + 'type' => 'string', + 'example' => 'Finished', + ], + 'LogLevel' => [ + 'description' => 'The log level.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ERROR'."\n" + .'* INFO'."\n" + .'* WARN'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'ERROR' => '', + 'INFO' => '', + 'WARN' => '', + ], + 'example' => 'INFO', + ], + 'Target' => [ + 'description' => 'The resource involved in the log.'."\n", + 'type' => 'string', + 'example' => 'sg-bcd***', + ], + 'Message' => [ + 'description' => 'The output message of the log.'."\n", + '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' => 'GetCommonLogDetail', + ], + 'AttachNodes' => [ + 'summary' => 'Adds Elastic Compute Service (ECS) instances as compute nodes to Elastic High Performance Computing (E-HPC) clusters.', + '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' => 'The ID of the cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ehpc-hz-xxxxxxx', + ], + ], + [ + 'name' => 'QueueName', + 'in' => 'query', + 'schema' => [ + 'title' => '队列名', + 'description' => 'The name of the queue to which the instance is to be added.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'comp', + ], + ], + [ + 'name' => 'ComputeNode', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '计算节点信息', + 'description' => 'The list of compute nodes.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceIds' => [ + 'title' => '实例ID数组', + 'description' => 'The IDs of ECS instances.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i-xxxxxxxx', + ], + 'required' => true, + ], + 'ImageId' => [ + 'title' => '镜像ID。纳管后将使用该镜像替换原有系统盘镜像。', + 'description' => 'The image ID. This image will be used to replace the original system disk image.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'm-bp1h765oyqyxxxxxxxxx', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2263XXXX-XXXX-XXXX-XXXX-XXXX2448XXXX', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + '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' => 'AttachNodes', + 'description' => 'The ECS instances must meet the following requirements:'."\n" + ."\n" + .'* The ECS instances do not belong to any E-HPC cluster.'."\n" + .'* The ECS instances reside in the same virtual private cloud (VPC) as the cluster.'."\n" + .'* The ECS instances are in the Stopped state.'."\n" + ."\n" + .'Take of the following limits:'."\n" + ."\n" + .'* You can specify multiple instance IDs to add them at a time. However, the instances must be of the same type.'."\n" + .'* When an instance is added to the cluster, [the system disk is reset](https://help.aliyun.com/zh/ecs/user-guide/re-initialize-a-system-disk) by using the image specified by the input parameters.'."\n" + .'* If the instance has data disks, they are not automatically created and mounted after the instance is added.'."\n" + .'* The hostname of the instance remains the same. Therefore, you must ensure that the hostname of the instance to be added is different from the hostname of an existing node in the cluster.'."\n", + ], + 'ListRegions' => [ + 'summary' => 'Queries the list of product support regions.', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Next', + 'enum' => [ + 'Next', + 'Instant', + ], + ], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + 'enum' => [ + 'zh-CN', + 'en-US', + ], + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'TotalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'MaxResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'NextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'caeba0bbb2be03f84eb48b699f0axxxx', + ], + 'Regions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'LocalName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'ListRegions', + ], + 'CreateReservedNodePool' => [ + 'summary' => 'Creates a reserved node pool. A reserved node pool preempts IP addresses provided in a vSwitch and maps them one by one to host names that are generated based on rules. Resources are also maintained based on the mapping table. When you use a reserved node pool to scale out or scale in nodes, the resources in the node pool are occupied or released accordingly.', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368', + ], + 'ReservedNodePoolId' => [ + 'description' => '', + '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' => 'CreateReservedNodePool', + ], + 'DeleteReservedNodePool' => [ + 'summary' => 'Deletes a reserved node pool.', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ehpc-hz-FYUr32****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => 'DeleteReservedNodePool', + ], + ], + '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', + ], + ], +]; |