summaryrefslogtreecommitdiff
path: root/data/en_us/ehpcinstant/2023-07-01
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/ehpcinstant/2023-07-01')
-rw-r--r--data/en_us/ehpcinstant/2023-07-01/api-docs.php7135
1 files changed, 7135 insertions, 0 deletions
diff --git a/data/en_us/ehpcinstant/2023-07-01/api-docs.php b/data/en_us/ehpcinstant/2023-07-01/api-docs.php
new file mode 100644
index 0000000..410a03f
--- /dev/null
+++ b/data/en_us/ehpcinstant/2023-07-01/api-docs.php
@@ -0,0 +1,7135 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'EhpcInstant',
+ 'version' => '2023-07-01',
+ ],
+ 'directories' => [
+ [
+ 'id' => 380391,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateActionPlan',
+ 'UpdateActionPlan',
+ 'ListActionPlans',
+ 'ListActionPlanActivities',
+ 'GetActionPlan',
+ 'DeleteActionPlan',
+ ],
+ ],
+ [
+ 'id' => 380398,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'AddImage',
+ 'GetImage',
+ 'ListImages',
+ 'RemoveImage',
+ 'GetAppVersions',
+ 'SynchronizeApp',
+ ],
+ ],
+ [
+ 'id' => 380405,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateJob',
+ 'GetJob',
+ 'ListJobs',
+ 'DeleteJobs',
+ 'ListJobExecutors',
+ 'ListExecutors',
+ 'ListExecutorEvents',
+ 'DeleteJobRecords',
+ 'DescribeJobResults',
+ ],
+ ],
+ [
+ 'id' => 380415,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeJobMetricData',
+ 'DescribeJobMetricLast',
+ ],
+ ],
+ [
+ 'id' => 380418,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'TagResources',
+ 'ListTagResources',
+ 'UnTagResources',
+ ],
+ ],
+ [
+ 'id' => 380422,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreatePool',
+ 'UpdatePool',
+ 'GetPool',
+ 'ListPools',
+ 'DeletePool',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'CreateActionPlan' => [
+ 'summary' => 'Create a E-HPC execution plan.',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpc11IJC9',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ActionPlanName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '执行计划的名称。',
+ 'description' => 'The name of the execution plan.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TestActionPlan',
+ ],
+ ],
+ [
+ 'name' => 'AppId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '应用ID。',
+ 'description' => 'The ID of the application.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ci-vm-rYfypJKwlN9Y',
+ ],
+ ],
+ [
+ 'name' => 'Script',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '运行作业脚本。需Base64编码。',
+ 'description' => 'The running-job script. Base64 encoding is required.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==',
+ ],
+ ],
+ [
+ 'name' => 'PrologScript',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '前处理脚本。需Base64编码。',
+ 'description' => 'The pre-processing script. Base64 encoding is required.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==',
+ ],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '执行目标资源类型:vCPU容量或者执行节点数。取值范围如下:'."\n"
+ ."\n"
+ .'- VCpuCapacity:vCPU容量'."\n"
+ ."\n"
+ .'- ExecutorCapacity:执行节点数',
+ 'description' => 'Target resource type: the capacity of vCPUs or the number of execution nodes. Valid values:'."\n"
+ ."\n"
+ .'* VCpuCapacity'."\n"
+ .'* ExecutorCapacity'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'VCpuCapacity',
+ 'enum' => [
+ 'VCpuCapacity',
+ 'ExecutorCapacity',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'DesiredCapacity',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '执行计划期望的资源规模。如果ResourceType是VcpuCapacity的话,该字段表示执行计划希望保有10000vCPU。',
+ 'description' => 'The expected scale of resources for the execution plan. If the ResourceType parameter is set to VcpuCapacity, the execution plan is expected to have 10000 vCPUs.'."\n",
+ 'type' => 'number',
+ 'format' => 'double',
+ 'required' => false,
+ 'example' => '1000',
+ ],
+ ],
+ [
+ 'name' => 'Resources',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '执行计划运行环境的资源配置列表。资源配置支持 1 ~ 10个。',
+ 'description' => 'The list of resource configurations of the execution plan runtime environment. You can configure 1 to 10 resources.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '执行计划运行环境的资源配置列表。资源配置支持 1 ~ 10个。',
+ 'description' => 'The resource configuration of the execution plan runtime environment.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Cores' => [
+ 'title' => '运行环境的CPU数。',
+ 'description' => 'The number of CPUs in the running environment.'."\n",
+ 'type' => 'number',
+ 'format' => 'double',
+ 'required' => false,
+ 'example' => '2',
+ ],
+ 'Memory' => [
+ 'title' => '运行环境的内存大小。单位是GiB。',
+ 'description' => 'The memory size of the running environment. Unit: GiB.'."\n",
+ 'type' => 'number',
+ 'format' => 'double',
+ 'required' => false,
+ 'example' => '4',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'example' => '1000',
+ ],
+ ],
+ [
+ 'name' => 'Regions',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '执行计划运行环境的地域资源配置列表。',
+ 'description' => 'The list of resource configurations in the region where the execution plan runs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '执行计划运行环境的地域资源配置列表。',
+ 'description' => 'The resource configuration of the region in which the execution plan runs.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => [
+ 'title' => '地域ID。',
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ 'VSwitchIds' => [
+ 'title' => '交换机ID,您可以通过[DescribeVSwitches接口](https://api.aliyun.com/document/Vpc/2016-04-28/DescribeVSwitches)查询可用交换机信息。',
+ 'description' => 'The list of VSwitches available for the execution plan in the region. Supports 0 to 5 VSwitches.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '交换机ID,您可以通过[DescribeVSwitches接口](https://api.aliyun.com/document/Vpc/2016-04-28/DescribeVSwitches)查询可用交换机信息。',
+ 'description' => 'The ID of the vSwitch. You can query the information about available vSwitches through the [DescribeVSwitches interface](https://api.aliyun.com/document/Vpc/2016-04-28/DescribeVSwitches).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'vsw-8vb4m54nq1hwtxxda****',
+ ],
+ 'required' => false,
+ ],
+ 'SecurityGroupId' => [
+ 'title' => '交换机ID列表,您可以通过[DescribeSecurityGroups接口](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups)查询可用交换机信息。',
+ 'description' => 'The list of security groups available for the execution plan in the region. You can have 0 to 5 security groups.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '交换机ID,您可以通过[DescribeSecurityGroups接口](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups)查询可用交换机信息。',
+ 'description' => 'The ID of the vSwitch. You can query the information about available vSwitches through the [DescribeSecurityGroups interface](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'sg-2zeh9711f6c04bkr****',
+ ],
+ 'required' => false,
+ ],
+ 'SecurityGroupIds' => [
+ 'title' => '交换机ID列表,您可以通过[DescribeSecurityGroups接口](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups)查询可用交换机信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '交换机ID,您可以通过[DescribeSecurityGroups接口](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups)查询可用交换机信息。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'sg-uf6j4pp39x9k3x05c3vw',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'AllocationSpec',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '资源类型。'."\n"
+ .'- Standard:标准型。',
+ 'description' => 'The type of the resource.'."\n"
+ ."\n"
+ .'* Standard'."\n"
+ .'* Dedicated: You must enable a whitelist for use.'."\n"
+ .'* Economic: You must enable a whitelist for use.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Standard',
+ ],
+ ],
+ [
+ 'name' => 'Level',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '算力等级,仅在资源类型为经济型时有效。支持以下类型:'."\n"
+ .'- General:通用型。'."\n"
+ .'- Performance:性能型。'."\n"
+ ."\n"
+ .'默认值:General',
+ 'description' => 'The computing power level. This value is valid only when the resource type is Economic. The following disk categories are supported:'."\n"
+ ."\n"
+ .'* General'."\n"
+ .'* Performance'."\n"
+ ."\n"
+ .'Default value: General'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'General',
+ ],
+ ],
+ [
+ 'name' => 'IntervalMinutes',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '执行计划的定时周期。单位分钟,取值范围:10 ~ 10080,默认值60。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '60',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'ActionPlanId' => [
+ 'title' => '执行计划 ID。',
+ 'description' => 'The ID of the execution plan.'."\n",
+ 'type' => 'string',
+ 'example' => 'ap-hz036ubmx2qmw93k****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 406 => [
+ [
+ 'errorCode' => 'QuotaExceeded.ActionPlan',
+ 'errorMessage' => 'The number of action plans in the current account has exceeded quota.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"ActionPlanId\\": \\"ap-hz036ubmx2qmw93k****\\"\\n}","type":"json"}]',
+ 'title' => 'CreateActionPlan',
+ 'description' => '**Make sure that you fully understand E-HPC Instnat billing methods and [prices](https://help.aliyun.com/zh/e-hpc/e-hpc-instant/product-overview/billing-overview?spm=a2c4g.11186623.help-menu-57664.d\\_0\\_2\\_0.5fdd28422y6UvO).'."\n",
+ ],
+ 'UpdateActionPlan' => [
+ 'summary' => 'Adjust the resource scale of the execution plan or modify the execution status',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpc11IJC9',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ActionPlanId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the execution plan.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ap-hz036ubmx2qmw93k****',
+ ],
+ ],
+ [
+ 'name' => 'DesiredCapacity',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The expected scale of resources for the execution plan. If the ResourceType parameter is set to VcpuCapacity, the execution plan is expected to have 10000 vCPUs.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'required' => false,
+ 'example' => '1000',
+ ],
+ ],
+ [
+ 'name' => 'Enabled',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Whether to enable the execution plan. Valid values:'."\n"
+ ."\n"
+ .'* true: enables the execution plan.'."\n"
+ ."\n"
+ .'* false: The execution plan is disabled.'."\n"
+ ."\n"
+ .' **'."\n"
+ ."\n"
+ .' **Note:** After an execution plan is disabled, the created Instant jobs are not automatically managed by the execution plan.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'IntervalMinutes',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '执行计划的定时周期。单位分钟,取值范围:10 ~ 10080,默认值60。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '60',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'NotExisted.ActionPlan',
+ 'errorMessage' => 'The specified action plan does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'InvalidStatus.ActionPlan',
+ 'errorMessage' => 'The current status of the execution plan does not support this operation. Please try again later.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\"\\n}","type":"json"}]',
+ 'title' => 'UpdateActionPlan',
+ ],
+ 'ListActionPlans' => [
+ 'summary' => 'Queries the list of execution plans.',
+ 'path' => '',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpc11IJC9',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ActionPlanIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The IDs of the execution plans to be queried.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the execution plan to be queried.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ap-hz036ubmx2qmw93k****'."\n",
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'A pagination token.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1d2db86scXXXXXXXXXX',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The maximum number of entries per page.'."\n"
+ ."\n"
+ .'Valid values: 1 to 100.'."\n"
+ ."\n"
+ .'Default value: 20.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回',
+ 'description' => 'Total data count under the current request conditions (optional; not returned by default).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n",
+ ],
+ 'NextToken' => [
+ 'title' => '表示当前调用返回读取到的位置,空代表数据已经读取完毕',
+ 'description' => 'Indicates the read position returned by the current call. An empty value means all data has been read.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1d2db86scXXXXXXXXXX',
+ ],
+ 'MaxResults' => [
+ 'title' => 'MaxResults本次请求所返回的最大记录条数',
+ 'description' => 'The maximum number of records returned in this request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ 'ActionPlans' => [
+ 'description' => 'The list of execution plan results.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the prefetch plans.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the execution plan. The possible values are as follows:'."\n"
+ ."\n"
+ .'* Active Instant tasks are dynamically managed only when the execution plan is in the Active state.'."\n"
+ .'* Inactive Instant tasks are no longer managed by execution plans in the Inactive state.'."\n"
+ .'* Deleting: The execution plan is being deleted. You cannot modify the parameters of an execution plan in this state.'."\n",
+ 'type' => 'string',
+ 'example' => 'Active',
+ ],
+ 'ActionPlanId' => [
+ 'description' => 'The ID of the execution plan.'."\n",
+ 'type' => 'string',
+ 'example' => 'ap-hz036ubmx2qmw93k****'."\n",
+ ],
+ 'ActionPlanName' => [
+ 'description' => 'The name of the execution plan.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestActionPlan',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the execution plan was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-08-10 17:58:24 ',
+ ],
+ 'UpdateTime' => [
+ 'description' => 'The time when the execution plan was last modified. The time follows the ISO 8601 standard and UTC +0. The format is yyyy-MM-ddTHH:mmZ.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-08-10 17:58:24 '."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'NotExisted.ActionPlan',
+ 'errorMessage' => 'The specified action plan does not exist.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\",\\n \\"NextToken\\": \\"1d2db86scXXXXXXXXXX\\",\\n \\"MaxResults\\": 20,\\n \\"ActionPlans\\": [\\n {\\n \\"Status\\": \\"Active\\",\\n \\"ActionPlanId\\": \\"ap-hz036ubmx2qmw93k****\\\\n\\",\\n \\"ActionPlanName\\": \\"TestActionPlan\\",\\n \\"CreateTime\\": \\"2025-08-10 17:58:24\\\\t\\",\\n \\"UpdateTime\\": \\"2025-08-10 17:58:24\\\\t\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListActionPlans',
+ ],
+ 'ListActionPlanActivities' => [
+ 'summary' => 'Queries the execution status of an execution plan.',
+ 'path' => '',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpc11IJC9',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ActionPlanId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the execution plan.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ap-hz036ubmx2qmw93k****',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'A pagination token.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1d2db86scXXXXXXXXXX',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The maximum number of entries per page.'."\n"
+ ."\n"
+ .'Valid values: 1 to 100.'."\n"
+ ."\n"
+ .'Default value: 20.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回',
+ 'description' => 'Total data count under the current request conditions (optional; not returned by default).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '40',
+ ],
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'NextToken' => [
+ 'title' => '表示当前调用返回读取到的位置,空代表数据已经读取完毕',
+ 'description' => 'Indicates the read position returned by the current call. An empty value means all data has been read.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1d2db86scXXXXXXXXXX',
+ ],
+ 'MaxResults' => [
+ 'title' => 'MaxResults本次请求所返回的最大记录条数',
+ 'description' => 'The maximum number of records returned in this request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'ActionPlanActivities' => [
+ 'description' => 'The list of execution details of the execution plan.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The execution details of the execution plan.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The implementation status of the execution plan activity. Valid values:'."\n"
+ ."\n"
+ .'* InProcess'."\n"
+ .'* Completed'."\n"
+ .'* Failed'."\n",
+ 'type' => 'string',
+ 'example' => 'InProcess',
+ ],
+ 'EndTime' => [
+ 'description' => 'The end time of the execution plan activity.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-08-10 18:28:05'."\n",
+ ],
+ 'CreatedCapacity' => [
+ 'description' => 'The increased capacity of this execution plan activity.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '100',
+ ],
+ 'Jobs' => [
+ 'description' => 'The list of Instant jobs involved in the execution plan.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the Instant jobs involved in the execution plan.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'JobOperationType' => [
+ 'description' => 'The operation type of the execution plan activity on the job. Possible values are as follows:'."\n"
+ ."\n"
+ .'* Create'."\n"
+ .'* Delete'."\n",
+ 'type' => 'string',
+ 'example' => 'Create',
+ ],
+ 'JobId' => [
+ 'description' => 'The ID of the job.'."\n",
+ 'type' => 'string',
+ 'example' => 'job-hz12dqq8y3ormo1hz49h',
+ ],
+ ],
+ ],
+ ],
+ 'StartTime' => [
+ 'description' => 'The start time of the implementation of the planned activity.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-08-10 18:28:05'."\n",
+ ],
+ 'ActionPlanActivityId' => [
+ 'description' => 'The activity ID of the execution plan.'."\n",
+ 'type' => 'string',
+ 'example' => 'et-4119e3f60eb34fc4',
+ ],
+ 'DestroyCapacity' => [
+ 'description' => 'The capacity released by this execution plan activity.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'NotExisted.ActionPlan',
+ 'errorMessage' => 'The specified action plan does not exist.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 40,\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"NextToken\\": \\"1d2db86scXXXXXXXXXX\\",\\n \\"MaxResults\\": 100,\\n \\"ActionPlanActivities\\": [\\n {\\n \\"Status\\": \\"InProcess\\",\\n \\"EndTime\\": \\"2025-08-10 18:28:05\\\\n\\",\\n \\"CreatedCapacity\\": 100,\\n \\"Jobs\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"JobOperationType\\": \\"Create\\",\\n \\"JobId\\": \\"job-hz12dqq8y3ormo1hz49h\\"\\n }\\n ],\\n \\"StartTime\\": \\"2025-08-10 18:28:05\\\\n\\",\\n \\"ActionPlanActivityId\\": \\"et-4119e3f60eb34fc4\\",\\n \\"DestroyCapacity\\": 0\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListActionPlanActivities',
+ ],
+ 'GetActionPlan' => [
+ 'summary' => 'Querying Execution Plan Details',
+ 'path' => '',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpc11IJC9',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ActionPlanId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '执行计划 ID。',
+ 'description' => 'The ID of the execution plan.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ap-hz036ubmx2qmw93k****',
+ ],
+ ],
+ ],
+ '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' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'ActionPlanId' => [
+ 'title' => '执行计划 ID。',
+ 'description' => 'The ID of the execution plan.'."\n",
+ 'type' => 'string',
+ 'example' => 'ap-hz036ubmx2qmw93k****',
+ ],
+ 'ActionPlanName' => [
+ 'title' => '执行计划的名称。',
+ 'description' => 'The name of the execution plan.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestActionPlan',
+ ],
+ 'CreateTime' => [
+ 'title' => '执行计划的创建时间。',
+ 'description' => 'The time when the execution plan was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-08-10 18:28:05',
+ ],
+ 'UpdateTime' => [
+ 'title' => '执行计划的上次修改时间。',
+ 'description' => 'The time when the execution plan was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-08-10 18:28:05'."\n",
+ ],
+ 'AppId' => [
+ 'title' => '应用 ID。',
+ 'description' => 'The ID of the application.'."\n",
+ 'type' => 'string',
+ 'example' => 'ci-vm-rYfypJKwlN9Y',
+ ],
+ 'PrologScript' => [
+ 'title' => '前处理脚本。需Base64编码。',
+ 'description' => 'The pre-processing script. Base64 encoding is required.'."\n",
+ 'type' => 'string',
+ 'example' => 'bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==',
+ ],
+ 'ResourceType' => [
+ 'title' => '执行目标资源类型:vCPU容量或者执行节点数。取值范围如下:'."\n"
+ ."\n"
+ .'- VCpuCapacity:vCPU容量'."\n"
+ ."\n"
+ .'- ExecutorCapacity:执行节点数',
+ 'description' => 'Target resource type: the capacity of vCPUs or the number of execution nodes. Valid values:'."\n"
+ ."\n"
+ .'* VCpuCapacity'."\n"
+ .'* ExecutorCapacity'."\n",
+ 'type' => 'string',
+ 'example' => 'VCpuCapacity',
+ ],
+ 'DesiredCapacity' => [
+ 'title' => '执行计划期望的资源规模。如果ResourceType是VcpuCapacity的话,该字段表示执行计划希望保有10000vCPU。',
+ 'description' => 'The expected scale of resources for the execution plan. If the ResourceType parameter is set to VcpuCapacity, the execution plan is expected to have 10000 vCPUs.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '1000',
+ ],
+ 'TotalCapacity' => [
+ 'title' => '执行计划当前管理的资源规模。',
+ 'description' => 'The size of the resources currently managed by the execution plan.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '1000',
+ ],
+ 'Status' => [
+ 'title' => '执行计划状态,可能值如下:'."\n"
+ ."\n"
+ .'- Active:生效状态。处于生效状态的执行计划才会动态管理Instant任务。'."\n"
+ ."\n"
+ .'- Inactive:失效状态。失效状态的执行计划不再管理Instant任务。'."\n"
+ ."\n"
+ .'- Deleting:执行计划正在删除中。该状态下执行计划不支持修改参数。',
+ 'description' => 'The status of the execution plan. The possible values are as follows:'."\n"
+ ."\n"
+ .'* Active Instant tasks are dynamically managed only when the execution plan is in the Active state.'."\n"
+ .'* Inactive Instant tasks are no longer managed by execution plans in the Inactive state.'."\n"
+ .'* Deleting You cannot modify the parameters of an execution plan in this state.'."\n",
+ 'type' => 'string',
+ 'example' => 'Active',
+ ],
+ 'Resources' => [
+ 'title' => '执行计划运行环境的资源配置。',
+ 'description' => 'The list of resource configurations of the execution plan runtime environment.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '执行计划运行环境的资源配置。',
+ 'description' => 'The resource configuration of the execution plan runtime environment.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Cores' => [
+ 'title' => '运行环境的CPU数。',
+ 'description' => 'The number of CPUs in the running environment.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '64',
+ ],
+ 'Memory' => [
+ 'title' => '运行环境的内存大小。单位是GiB。',
+ 'description' => 'The memory size of the running environment. Unit: GiB.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '128',
+ ],
+ ],
+ ],
+ ],
+ 'Regions' => [
+ 'title' => '执行计划运行环境的地域资源配置。',
+ 'description' => 'The list of resource configurations in the region where the execution plan runs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '执行计划运行环境的地域资源配置。',
+ 'description' => 'The resource configuration of the region in which the execution plan runs.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => [
+ 'title' => '地域ID。',
+ 'description' => 'The region ID of the instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'VSwitchIds' => [
+ 'title' => '交换机 ID。',
+ 'description' => 'The list of VSwitches available for the execution plan in the region.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '交换机 ID。',
+ 'description' => 'The ID of the vSwitch.'."\n",
+ 'type' => 'string',
+ 'example' => 'vsw-bp14v5eikr8wrgoqje7hr',
+ ],
+ ],
+ 'SecurityGroupIds' => [
+ 'title' => '交换机ID。',
+ 'description' => 'The list of security groups available for the execution plan in the region.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '交换机ID。',
+ 'description' => 'The ID of the vSwitch.'."\n",
+ 'type' => 'string',
+ 'example' => 'sg-uf6j4pp39x9k3x05c3vw',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AllocationSpec' => [
+ 'title' => '资源类型。',
+ 'description' => 'The type of the resource.'."\n",
+ 'type' => 'string',
+ 'example' => 'Standard',
+ ],
+ 'Level' => [
+ 'title' => '算力等级。',
+ 'description' => 'The computing power level.'."\n",
+ 'type' => 'string',
+ 'example' => 'General',
+ ],
+ 'IntervalMinutes' => [
+ 'title' => '执行计划的定时周期,单位分钟。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '60',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'NotExisted.ActionPlan',
+ 'errorMessage' => 'The specified action plan does not exist.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"ActionPlanId\\": \\"ap-hz036ubmx2qmw93k****\\",\\n \\"ActionPlanName\\": \\"TestActionPlan\\",\\n \\"CreateTime\\": \\"2025-08-10 18:28:05\\",\\n \\"UpdateTime\\": \\"2025-08-10 18:28:05\\\\n\\",\\n \\"AppId\\": \\"ci-vm-rYfypJKwlN9Y\\",\\n \\"PrologScript\\": \\"bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==\\",\\n \\"ResourceType\\": \\"VCpuCapacity\\",\\n \\"DesiredCapacity\\": 1000,\\n \\"TotalCapacity\\": 1000,\\n \\"Status\\": \\"Active\\",\\n \\"Resources\\": [\\n {\\n \\"Cores\\": 64,\\n \\"Memory\\": 128\\n }\\n ],\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-bp14v5eikr8wrgoqje7hr\\"\\n ],\\n \\"SecurityGroupIds\\": [\\n \\"sg-uf6j4pp39x9k3x05c3vw\\"\\n ]\\n }\\n ],\\n \\"AllocationSpec\\": \\"Standard\\",\\n \\"Level\\": \\"General\\",\\n \\"IntervalMinutes\\": 60\\n}","type":"json"}]',
+ 'title' => 'GetActionPlan',
+ ],
+ 'DeleteActionPlan' => [
+ 'summary' => 'Delete an execution plan',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpc11IJC9',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ActionPlanId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the execution plan.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ap-hz036ubmx2qmw93k****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'NotExisted.ActionPlan',
+ 'errorMessage' => 'The specified action plan does not exist.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'InvalidStatus.ActionPlan',
+ 'errorMessage' => 'The current status of the execution plan does not support this operation. Please try again later.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteActionPlan',
+ 'description' => '**Make sure that you fully understand E-HPC Instnat billing methods and [prices](https://help.aliyun.com/zh/e-hpc/e-hpc-instant/product-overview/billing-overview?spm=a2c4g.11186623.help-menu-57664.d\\_0\\_2\\_0.5fdd28422y6UvO).**'."\n"
+ ."\n"
+ .'This operation stops all Instant jobs that are managed by ActionPlanId.'."\n",
+ ],
+ 'AddImage' => [
+ 'summary' => 'Add a custom image.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219054',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcE21063',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ImageType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the images. Valid values:'."\n"
+ ."\n"
+ .'* VM: virtual machine image.'."\n"
+ .'* Container: the container image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'VM',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the custom image.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'app-image'."\n",
+ ],
+ ],
+ [
+ 'name' => 'ImageVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The version of the image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'V1.0',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Test image'."\n",
+ ],
+ ],
+ [
+ 'name' => 'ContainerImageSpec',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The configurations of the container image.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RegistryUrl' => [
+ 'description' => 'The endpoint of the container image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest'."\n",
+ ],
+ 'IsACRRegistry' => [
+ 'description' => 'Whether it is an Alibaba Cloud image repository.'."\n"
+ ."\n"
+ .'* True'."\n"
+ .'* False'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'True',
+ ],
+ 'IsACREnterprise' => [
+ 'description' => 'Whether the instance is an Alibaba Cloud image repository Enterprise Edition.'."\n"
+ ."\n"
+ .'* True'."\n"
+ .'* False'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'True',
+ ],
+ 'RegistryCriId' => [
+ 'description' => 'The ID of the Container Registry Enterprise Edition image repository.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cri-xyz795ygf8k9****'."\n",
+ ],
+ 'RegistryCredential' => [
+ 'description' => 'The authentication of the private image repository.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Server' => [
+ 'description' => 'The registered address of the image repository.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com'."\n",
+ ],
+ 'UserName' => [
+ 'description' => 'The username of the logon user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'username',
+ ],
+ 'Password' => [
+ 'description' => 'The password of the logon user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'userpassword',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'VMImageSpec',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The image configuration of the virtual machine.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ImageId' => [
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-bp1akkkr1rkxtb******'."\n",
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n",
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ 'ImageId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'm-bp1akkkr1rkxtb******'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'ImageAlreadyExists',
+ 'errorMessage' => 'The image id already exists.',
+ ],
+ [
+ 'errorCode' => 'InDebt',
+ 'errorMessage' => 'Your account has overdue payments.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'ImageInUse',
+ 'errorMessage' => 'Image is still used by jobs.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'ImageNotFound',
+ 'errorMessage' => 'The specified image does not exist.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'EcsError',
+ 'errorMessage' => 'An error occurred while calling the ECS API operation.',
+ ],
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database error occurred.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'NotAuthorized',
+ 'errorMessage' => 'No authorization is granted.',
+ ],
+ ],
+ 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\\",\\n \\"Success\\": true,\\n \\"ImageId\\": \\"m-bp1akkkr1rkxtb******\\\\n\\"\\n}","type":"json"}]',
+ 'title' => 'AddImage',
+ ],
+ 'GetImage' => [
+ 'summary' => 'Obtains the information about an image.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219057',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcEZT3HW',
+ 'FEATUREehpcE21063',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ImageCategory',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The source of the image. Valid values:'."\n"
+ ."\n"
+ .'* Public: public images provided by Alibaba Cloud.'."\n"
+ .'* Custom: the custom image that you added.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Custom',
+ ],
+ ],
+ [
+ 'name' => 'ImageType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the images. Valid values:'."\n"
+ ."\n"
+ .'* VM: virtual machine image.'."\n"
+ .'* Container: the container image.'."\n"
+ ."\n"
+ .'Default value: VM'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'VM',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-2ze74g5mvy4pjg*****',
+ ],
+ ],
+ [
+ 'name' => 'AdditionalRegionIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n",
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true: The task is successful.'."\n"
+ .'* false: The error occurred.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TotalCount' => [
+ 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回',
+ 'description' => 'The total amount of data in this request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'Image' => [
+ 'title' => 'Image',
+ 'description' => 'The details of the image.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ImageType' => [
+ 'description' => 'The type of the image.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'VM',
+ ],
+ 'AppId' => [
+ 'type' => 'string',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the image.'."\n",
+ 'type' => 'string',
+ 'example' => 'app-image',
+ ],
+ 'Version' => [
+ 'description' => 'The version.'."\n",
+ 'type' => 'string',
+ 'example' => 'v1.0',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the image.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Size' => [
+ 'description' => 'The size of the image. Unit: GiB.'."\n",
+ 'type' => 'string',
+ 'example' => '40 GiB',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the image was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-12-23T09:51:39Z',
+ ],
+ 'Status' => [
+ 'type' => 'string',
+ ],
+ 'ContainerImageSpec' => [
+ 'description' => 'The configuration details of the container image.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RegistryUrl' => [
+ 'description' => 'The endpoint of the container image.'."\n",
+ 'type' => 'string',
+ 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest',
+ ],
+ 'IsACRRegistry' => [
+ 'description' => 'Whether it is an Alibaba Cloud image repository.'."\n"
+ ."\n"
+ .'* True'."\n"
+ .'* False'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ 'IsACREnterprise' => [
+ 'description' => 'Whether the instance is an Alibaba Cloud image repository Enterprise Edition.'."\n"
+ ."\n"
+ .'* True'."\n"
+ .'* False'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ 'RegistryCriId' => [
+ 'description' => 'The ID of the Container Registry Enterprise Edition image repository.'."\n",
+ 'type' => 'string',
+ 'example' => 'cri-xyz795ygf8k9****',
+ ],
+ 'RegistryCredential' => [
+ 'description' => 'The authentication of the private image repository.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Server' => [
+ 'description' => 'The registered address of the image repository.'."\n",
+ 'type' => 'string',
+ 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com',
+ ],
+ 'UserName' => [
+ 'description' => 'The username of the logon user.'."\n",
+ 'type' => 'string',
+ 'example' => 'username',
+ ],
+ 'Password' => [
+ 'description' => 'The password of the logon user.'."\n",
+ 'type' => 'string',
+ 'example' => 'userpassword',
+ ],
+ ],
+ ],
+ 'OsTag' => [
+ 'type' => 'string',
+ ],
+ 'Platform' => [
+ 'type' => 'string',
+ ],
+ 'Architecture' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'VMImageSpec' => [
+ 'description' => 'The configuration details of the virtual machine image.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ImageId' => [
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'm-uf60twafjtaart******',
+ ],
+ 'OsTag' => [
+ 'description' => 'The ID of the specific OS version.'."\n",
+ 'type' => 'string',
+ 'example' => 'CentOS 7.6 64 bit',
+ ],
+ 'Platform' => [
+ 'description' => 'The type of the platform.'."\n",
+ 'type' => 'string',
+ 'example' => 'CentOS',
+ ],
+ 'Architecture' => [
+ 'description' => 'The type of the architecture.'."\n",
+ 'type' => 'string',
+ 'example' => 'x86_64',
+ ],
+ ],
+ ],
+ 'DocumentInfo' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DocumentId' => [
+ 'type' => 'string',
+ ],
+ 'EncodingMode' => [
+ 'type' => 'string',
+ ],
+ 'Document' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'AdditionalRegionsInfo' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'type' => 'string',
+ ],
+ 'ImageId' => [
+ 'type' => 'string',
+ ],
+ 'RegionId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ ],
+ 404 => [
+ [
+ 'errorCode' => 'ImageNotFound',
+ 'errorMessage' => 'The specified image does not exist.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'EcsError',
+ 'errorMessage' => 'An error occurred while calling the ECS API operation.',
+ ],
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database error occurred.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'NotAuthorized',
+ 'errorMessage' => 'No authorization is granted.',
+ ],
+ ],
+ 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\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 10,\\n \\"Image\\": {\\n \\"ImageType\\": \\"VM\\",\\n \\"AppId\\": \\"\\",\\n \\"Name\\": \\"app-image\\",\\n \\"Version\\": \\"v1.0\\",\\n \\"Description\\": \\"应用测试镜像。\\",\\n \\"Size\\": \\"40 GiB\\",\\n \\"CreateTime\\": \\"2022-12-23T09:51:39Z\\",\\n \\"Status\\": \\"\\",\\n \\"ContainerImageSpec\\": {\\n \\"RegistryUrl\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest\\",\\n \\"IsACRRegistry\\": true,\\n \\"IsACREnterprise\\": true,\\n \\"RegistryCriId\\": \\"cri-xyz795ygf8k9****\\",\\n \\"RegistryCredential\\": {\\n \\"Server\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com\\",\\n \\"UserName\\": \\"username\\",\\n \\"Password\\": \\"userpassword\\"\\n },\\n \\"OsTag\\": \\"\\",\\n \\"Platform\\": \\"\\",\\n \\"Architecture\\": \\"\\"\\n },\\n \\"VMImageSpec\\": {\\n \\"ImageId\\": \\"m-uf60twafjtaart******\\",\\n \\"OsTag\\": \\"CentOS 7.6 64 bit\\",\\n \\"Platform\\": \\"CentOS\\",\\n \\"Architecture\\": \\"x86_64\\"\\n },\\n \\"DocumentInfo\\": {\\n \\"DocumentId\\": \\"\\",\\n \\"EncodingMode\\": \\"\\",\\n \\"Document\\": \\"\\"\\n },\\n \\"AdditionalRegionsInfo\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"ImageId\\": \\"\\",\\n \\"RegionId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'GetImage',
+ ],
+ 'ListImages' => [
+ 'summary' => 'Queries the image list.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219055',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcEZT3HW',
+ 'FEATUREehpcE21063',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.\\'."\n"
+ .'Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of pieces per page.\\'."\n"
+ .'Default value: 20.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ImageCategory',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The source of the image. Valid values:'."\n"
+ ."\n"
+ .'* Public: public images provided by Alibaba Cloud.'."\n"
+ .'* Custom: the custom image that you added.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Custom' => 'Custom',
+ 'Public' => 'Public',
+ ],
+ 'example' => 'Custom',
+ ],
+ ],
+ [
+ 'name' => 'ImageType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the images. Valid values:'."\n"
+ ."\n"
+ .'* VM: virtual machine image.'."\n"
+ .'* Container: the container image.'."\n"
+ ."\n"
+ .'Default value: VM'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Container' => 'Container',
+ 'VM' => 'VM',
+ ],
+ 'example' => 'VM',
+ ],
+ ],
+ [
+ 'name' => 'ImageIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The array of image IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-uf6bzz76jb4ai9******',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ImageNames',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The array of image names.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'appimage',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Mode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The query mode. Valid values:'."\n"
+ ."\n"
+ .'* List: queries the list of all corresponding image versions.'."\n"
+ .'* Merge: merges images to query the latest version list.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Merge' => 'Merge',
+ 'List' => 'List',
+ ],
+ 'example' => 'Merge',
+ ],
+ ],
+ ],
+ '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' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'TotalCount' => [
+ 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回',
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'title' => 'PageSize',
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '20',
+ ],
+ 'PageNumber' => [
+ 'title' => 'PageNumber',
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'Images' => [
+ 'title' => 'Images',
+ 'description' => 'The list of image information.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information of the image.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ImageType' => [
+ 'description' => 'The type of the image.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'VM',
+ ],
+ 'ImageId' => [
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'm-bp181x855551ww5yq****',
+ ],
+ 'AppId' => [
+ 'description' => 'The application ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'ci-vm-kHLPzEWun6zz****',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the image.'."\n",
+ 'type' => 'string',
+ 'example' => 'app-image',
+ ],
+ 'Version' => [
+ 'description' => 'The version of the image.'."\n",
+ 'type' => 'string',
+ 'example' => 'v1.0',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the image.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the storage resource was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-12-09T07:06:34Z',
+ ],
+ 'OsTag' => [
+ 'description' => 'The ID of the specific OS version.'."\n",
+ 'type' => 'string',
+ 'example' => 'Ubuntu 22.04 64 bit',
+ ],
+ 'UpdateTime' => [
+ 'description' => 'The time when the image was updated.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-09-25 14:15:28',
+ ],
+ 'DocumentId' => [
+ 'description' => 'The document ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '30',
+ ],
+ 'Weight' => [
+ 'description' => 'The weight.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '70',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'InDebt',
+ 'errorMessage' => 'Your account has overdue payments.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'EcsError',
+ 'errorMessage' => 'An error occurred while calling the ECS API operation.',
+ ],
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database error occurred.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'NotAuthorized',
+ 'errorMessage' => 'No authorization is granted.',
+ ],
+ ],
+ 503 => [
+ [
+ 'errorCode' => 'ServiceUnavailable',
+ 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Images\\": [\\n {\\n \\"ImageType\\": \\"VM\\",\\n \\"ImageId\\": \\"m-bp181x855551ww5yq****\\",\\n \\"AppId\\": \\"ci-vm-kHLPzEWun6zz****\\",\\n \\"Name\\": \\"app-image\\",\\n \\"Version\\": \\"v1.0\\",\\n \\"Description\\": \\"应用测试镜像。\\",\\n \\"CreateTime\\": \\"2022-12-09T07:06:34Z\\",\\n \\"OsTag\\": \\"Ubuntu 22.04 64 bit\\",\\n \\"UpdateTime\\": \\"2024-09-25 14:15:28\\",\\n \\"DocumentId\\": 30,\\n \\"Weight\\": 70\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListImages',
+ ],
+ 'RemoveImage' => [
+ 'summary' => 'Remove a custom image',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219056',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcE21063',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ImageType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the images. Valid values:'."\n"
+ ."\n"
+ .'* VM: Virtual Machine Image'."\n"
+ .'* Container: container image'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'VM',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'm-bp14wakr1rkxtb******',
+ ],
+ ],
+ ],
+ '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' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ '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.',
+ ],
+ [
+ 'errorCode' => 'ImageAlreadyExists',
+ 'errorMessage' => 'The image id already exists.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'ImageInUse',
+ 'errorMessage' => 'Image is still used by jobs.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'ImageNotFound',
+ 'errorMessage' => 'The specified image does not exist.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'EcsError',
+ 'errorMessage' => 'An error occurred while calling the ECS API operation.',
+ ],
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database error occurred.',
+ ],
+ [
+ 'errorCode' => 'ServiceAPIError',
+ 'errorMessage' => 'Failed to call the operation. Cause:%s.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'NotAuthorized',
+ 'errorMessage' => 'No authorization is granted.',
+ ],
+ ],
+ 503 => [
+ [
+ 'errorCode' => 'ServiceUnavailable',
+ 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'RemoveImage',
+ ],
+ 'GetAppVersions' => [
+ 'summary' => 'Obtains the application version list.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '255311',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcEZT3HW',
+ 'FEATUREehpcE21063',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page. Default value: 20.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'ImageCategory',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The source of the image. Valid values:'."\n"
+ ."\n"
+ .'Public: public images provided by Alibaba Cloud.'."\n"
+ ."\n"
+ .'Custom: the custom image that you added.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Custom' => 'Custom',
+ 'Public' => 'Public',
+ ],
+ 'example' => 'Public',
+ ],
+ ],
+ [
+ 'name' => 'ImageType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the images. Valid values:'."\n"
+ ."\n"
+ .'VM: Virtual Machine Image'."\n"
+ ."\n"
+ .'Container: container image'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Container' => 'Container',
+ 'VM' => 'VM',
+ ],
+ 'example' => 'VM',
+ ],
+ ],
+ [
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The application name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'V-Ray',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The information that is returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n",
+ ],
+ 'Success' => [
+ 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
+ ."\n"
+ .'true'."\n"
+ ."\n"
+ .'false'."\n",
+ 'type' => 'boolean',
+ 'enumValueTitles' => [
+ 'true' => 'true',
+ 'false' => 'false',
+ ],
+ 'example' => 'true',
+ ],
+ 'TotalCount' => [
+ 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回',
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'PageSize' => [
+ 'title' => 'PageSize',
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '20',
+ ],
+ 'PageNumber' => [
+ 'title' => 'PageNumber',
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'AppVersions' => [
+ 'title' => 'Images',
+ 'description' => 'The list of application versions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the application version.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'description' => 'The application name.'."\n",
+ 'type' => 'string',
+ 'example' => 'V-Ray',
+ ],
+ 'Version' => [
+ 'description' => 'The application version.'."\n",
+ 'type' => 'string',
+ 'example' => 'v1.0',
+ ],
+ 'ImageId' => [
+ 'description' => 'The image ID of the application.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'm-f8z0dfa96luomqly****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'InDebt',
+ 'errorMessage' => 'Your account has overdue payments.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'EcsError',
+ 'errorMessage' => 'An error occurred while calling the ECS API operation.',
+ ],
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database error occurred.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'NotAuthorized',
+ 'errorMessage' => 'No authorization is granted.',
+ ],
+ ],
+ 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\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"AppVersions\\": [\\n {\\n \\"Name\\": \\"V-Ray\\",\\n \\"Version\\": \\"v1.0\\",\\n \\"ImageId\\": \\"m-f8z0dfa96luomqly****\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'GetAppVersions',
+ ],
+ 'SynchronizeApp' => [
+ 'summary' => 'Application cross-region synchronization',
+ 'path' => '',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcEZT3HW',
+ 'FEATUREehpcE21063',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'AppId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The application ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'ci-vm-rYfypJKwlN9Y',
+ ],
+ ],
+ [
+ 'name' => 'TargetRegionIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of arrays that are synchronized to the specified region. If \'all\' is included, it is synchronized to all other unsynchronized regions by default.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-shanghai',
+ ],
+ 'required' => false,
+ 'enumValueTitles' => [],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'ImageAlreadyExists',
+ 'errorMessage' => 'The image id already exists.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'Invalid parameters: %s.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'ImageNotFound',
+ 'errorMessage' => 'The specified image does not exist.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database error occurred.',
+ ],
+ [
+ 'errorCode' => 'ServiceAPIError',
+ 'errorMessage' => 'Failed to call the operation. Cause:%s.',
+ ],
+ [
+ '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\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
+ 'title' => 'SynchronizeApp',
+ ],
+ 'CreateJob' => [
+ 'summary' => 'Create a E-HPC Instant job.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '219052',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JobName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The job name. The name must be 2 to 64 characters in length and can contain letters, digits, and Chinese characters. It can contain hyphens (-) and underscores (\\_).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'testjob',
+ ],
+ ],
+ [
+ 'name' => 'JobDescription',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the job.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Demo',
+ ],
+ ],
+ [
+ 'name' => 'Tasks',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of tasks. Only one task is supported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => [
+ 'description' => 'The job name. It must be 2 to 32 characters in length and can contain letters, digits, and Chinese characters. It can contain hyphens (-) and underscores (\\_).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'task0',
+ ],
+ 'TaskSpec' => [
+ 'description' => 'The details of the task specification.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskExecutor' => [
+ 'description' => 'The task execution configurations.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The task execution configurations.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Container' => [
+ 'description' => 'Use the container environment.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Image' => [
+ 'description' => 'The image of the container.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/ehpc/hpl:latest',
+ ],
+ 'WorkingDir' => [
+ 'description' => 'The working directory of the container.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '/usr/local/',
+ ],
+ 'Command' => [
+ 'description' => 'The container startup commands. You can specify up to 20 commands. Each command can be up to 256 characters in length.'."\n"
+ ."\n"
+ .'> '."\n"
+ ."\n"
+ .'* If the start command contains spaces (for example, `sleep 60s` ), the input JSON format parameter is `["sleep", "60s"]`.'."\n"
+ ."\n"
+ .'* If the startup command is complex, the parameter format may be a combination of `Command: ["/bin/bash"]` and `Arg:["-c", "<customized command>"]`. The `<customized command>` is a user-defined combination of commands and can contain characters such as spaces.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The content of the container startup command. Each command contains up to 256 characters.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'sleep',
+ ],
+ 'required' => false,
+ ],
+ 'EnvironmentVars' => [
+ 'description' => 'The environment variables of the container. A maximum of 20 groups.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The environment variables of the container.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => [
+ 'description' => 'The name of the environment variable for the container. It can be 1 to 128 characters in length. Format requirement: \\[0-9a-zA-Z], and underscores, cannot start with a number.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PATH',
+ ],
+ 'Value' => [
+ 'description' => 'The value of the environment variable for the container. The value must be 0 to 256 bits in length.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '/usr/local/bin',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'AppId' => [
+ 'description' => 'The application ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ci-vm-32k6LXAi3cOG',
+ ],
+ 'ImageRegistryOptions' => [
+ 'title' => '镜像仓库配置信息',
+ 'type' => 'string',
+ ],
+ 'Arg' => [
+ 'description' => 'The startup argument of the init container. A maximum of 10 groups.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The startup argument of the init container.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '60s',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'VM' => [
+ 'description' => 'Use a virtual machine environment.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Image' => [
+ 'description' => 'The ID of the image.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'm-xxxx',
+ ],
+ 'PrologScript' => [
+ 'description' => 'The pre-processing script. Base64 encoding is required.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ZWNobyBoZWxsbyBlY3Mh',
+ ],
+ 'Script' => [
+ 'description' => 'The running-job script. Base64 encoding is required.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ZWNobyBoZWxsbyBlY3Mh',
+ ],
+ 'AppId' => [
+ 'description' => 'The ID of the virtual machine application.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ci-vm-9jc58Pm5Leky',
+ ],
+ 'Password' => [
+ 'description' => 'The logon password of the virtual machine environment. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The following special characters are supported:'."\n"
+ ."\n"
+ .'()\\`~!@#$%^&\\*-\\_+=|{}\\[]:;\'<>,.?/ In Windows, the password cannot contain a forward slash (/) as the first character.'."\n"
+ ."\n"
+ .'> We recommend that you use HTTPS to send requests if you specify Password to avoid password leakage.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'EHPC@1234',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'VolumeMount' => [
+ 'description' => 'The list of data volumes mounted to the task. A maximum of 10 groups.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of data volumes mounted to the task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'MountPath' => [
+ 'description' => 'The directory where the task mounts the data volume.'."\n"
+ ."\n"
+ .'> The content of the mounted directory is overwritten by the content of the volume. Exercise caution when you use the directory.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '/mnt',
+ ],
+ 'VolumeDriver' => [
+ 'description' => 'Currently supported data volume types.'."\n"
+ ."\n"
+ .'* alicloud/nas: mounts NAS.'."\n"
+ .'* alicloud/oss: mounts OSS.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'alicloud/nas',
+ ],
+ 'MountOptions' => [
+ 'description' => 'The list of data volume mount parameters. Each option is a key-value pair in a JSON string.'."\n"
+ ."\n"
+ .'* Format for mounting a NAS file system:{"server":"xxxxx-xxxxx.cn-heyuan.nas.aliyuncs.com","vers":"3","path":"/data","options":"nolock,tcp,noresvport"}'."\n"
+ ."\n"
+ .'> server indicates the address of the mount point of the NAS file system. path indicates the subdirectory of the NAS file system. The subdirectory must start with a (/) and must already exist. vers indicates the version number of the NFS protocol used to mount the file system. We recommend that you use v3. options indicates the custom parameters in the format of "xxx,xxx,xxx".'."\n"
+ ."\n"
+ .'* OSS mount format:{"bucket":"xxxxx", "url":"oss-cn-heyuan-internal.aliyuncs.com","path":"/data","akId":"xxxxx","akSecret":"xxxxx"}'."\n"
+ ."\n"
+ .'> bucket indicates the name of the OSS bucket. url indicates the endpoint of the OSS bucket. You can log on to the OSS console and obtain the endpoint on the Overview page of the destination bucket. path indicates the directory structure of the root file of the bucket. The default value is /, which requires that the directory already exists. akId indicates the AccessKey ID. akSecret indicates the AccessKey secret.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '{"server":"xxxxx-xxxxx.cn-heyuan.nas.aliyuncs.com","vers":"3","path":"/data","options":"nolock,tcp,noresvport"}',
+ ],
+ 'ReadOnly' => [
+ 'description' => 'Specifies whether the volume is read-only. Default value: false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'Resource' => [
+ 'description' => 'The resource information of the running environment.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Cores' => [
+ 'description' => 'The number of CPUs in the running environment.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'required' => false,
+ 'example' => '2',
+ ],
+ 'EnableHT' => [
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ 'Memory' => [
+ 'description' => 'The memory size of the running environment. Unit: GiB.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'required' => false,
+ 'example' => '4',
+ ],
+ 'Disks' => [
+ 'description' => 'The array of the disks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The array of the disks.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The type of the disk. Currently, only System is supported, which indicates the system disk.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'System',
+ ],
+ 'Size' => [
+ 'description' => 'The size of the disk. Unit: GiB.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '40',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'HostNamePrefix' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'InstanceTypes' => [
+ 'description' => 'The instance type of the running environment. A maximum of 5 groups.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The instance type of the running environment.'."\n"
+ ."\n"
+ .'> This parameter takes effect only when the `DeploymentPolicy. AllocationSpec` parameter is set to `Standard`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecs.c7a.8xlarge',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'RetryPolicy' => [
+ 'description' => 'Task retry policy.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RetryCount' => [
+ 'description' => 'The maximum number of retries. Valid values: 1 to 10. Default value: 3.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '5',
+ ],
+ 'ExitCodeActions' => [
+ 'description' => 'The retry rule. A maximum of 10 groups.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The retry rule.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ExitCode' => [
+ 'description' => 'The task exit code, which is used together with the action to form a job retry rule. Valid values: 0 to 255.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ 'Action' => [
+ 'description' => 'The next step behavior of the task.'."\n"
+ ."\n"
+ .'* Retry: The job starts a retry when a specific exit code is hit.'."\n"
+ .'* Exit: The job exits when a specific exit code is hit.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Retry',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'ExecutorPolicy' => [
+ 'description' => 'The task execution policy.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'MaxCount' => [
+ 'description' => 'The maximum number of nodes to run the job.'."\n"
+ ."\n"
+ .'> Follow the calculation formula: `MaxCount = (IndexEnd - IndexStart) / IndexStep +1`'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'ArraySpec' => [
+ 'description' => 'The details of the array job. The index value of the sub-job is passed to the running environment through environment variables to support user business program reference. Environment variables include:'."\n"
+ ."\n"
+ .'* EHPC_JOB_NAME: the name of the job. This parameter corresponds to the JobName parameter.'."\n"
+ .'* EHPC_JOB_ID: The ID of the job.'."\n"
+ .'* EHPC_TASK_NAME: the name of the task. This parameter corresponds to the TaskName parameter.'."\n"
+ .'* EHPC_EXECUTOR_ID: The ID of the execution unit.'."\n"
+ .'* EHPC_ARRAY_TASK_ID: the sub-job index value.'."\n"
+ .'* EHPC_ARRAY_TASK_COUNT: the total number of sub-jobs.'."\n"
+ .'* EHPC_ARRAY_TASK_MAX: the maximum sub-job index, which corresponds to the IndexStart parameter.'."\n"
+ .'* EHPC_ARRAY_TASK_MIN: the minimum value of the sub-job index, which corresponds to the IndexEnd parameter.'."\n"
+ .'* EHPC_ARRAY_TASK_STEP: the index step size of the sub-job, which corresponds to the IndexStep parameter.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IndexStart' => [
+ 'description' => 'The starting value of the array job index. Valid values: 0 to 4999.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ 'IndexEnd' => [
+ 'description' => 'The end value of the array job index. Valid values: 0 to 4999. The value must be greater than or equal to the value of IndexStart.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '9',
+ ],
+ 'IndexStep' => [
+ 'description' => 'The interval of the array job index.'."\n"
+ ."\n"
+ .'> If the array job property is IndexStart=1,IndexEnd=5, and IndexStep=2, the array job contains three sub-jobs. The index values of the sub-jobs are 1,3, and 5. You can access the sub-jobs by using environment variables.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'TaskSustainable' => [
+ 'description' => 'Indicate whether the job is a long-running job.'."\n"
+ ."\n"
+ .'* true: background service the job.'."\n"
+ .'* false: batch jobs.'."\n"
+ ."\n"
+ .'Default value: false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'false' => 'false',
+ 'true' => 'true',
+ ],
+ 'example' => 'true',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ 'minItems' => 1,
+ ],
+ ],
+ [
+ 'name' => 'DeploymentPolicy',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The resource deployment policy.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'AllocationSpec' => [
+ 'description' => 'The resource type,'."\n"
+ ."\n"
+ .'* Standard'."\n"
+ .'* Dedicated: You must enable a whitelist for use.'."\n"
+ .'* Economic: You must enable a whitelist for use.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Dedicated',
+ ],
+ 'Network' => [
+ 'description' => 'The network configuration information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Vswitch' => [
+ 'description' => 'The VSwitch array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the VSwitch.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'vsw-xxxx',
+ ],
+ 'required' => false,
+ ],
+ 'EnableExternalIpAddress' => [
+ 'description' => 'Whether the job creates a public IP address.'."\n"
+ ."\n"
+ .'* true: creates a public IP address.'."\n"
+ .'* false: does not create a public IP address.'."\n"
+ ."\n"
+ .'Default value: false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'false' => 'false',
+ 'true' => 'true',
+ ],
+ 'example' => 'true',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'Tag' => [
+ 'description' => 'The tag information of the job. A maximum of 20 groups.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag information of the job.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'description' => 'The key of the job tag. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'TestKey',
+ ],
+ 'Value' => [
+ 'description' => 'The value of the job tag. You can specify empty strings as tag values. The tag value can be up to 128 characters in length and cannot contain http:// or https://.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TestValue',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ 'Pool' => [
+ 'description' => 'The resource pool of the job.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'compute',
+ ],
+ 'Priority' => [
+ 'description' => 'The priorities of the jobs. A larger value indicates a higher job scheduling priority. Valid values: 1 to 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'Level' => [
+ 'description' => 'The computing power level. This value is valid only when the resource type is Economic. The following disk categories are supported:'."\n"
+ ."\n"
+ .'* General'."\n"
+ .'* Performance'."\n"
+ ."\n"
+ .'Default value: General.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'General',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'SecurityPolicy',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The security policy.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SecurityGroup' => [
+ 'description' => 'The security group ID.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SecurityGroupIds' => [
+ 'description' => 'The array of security group IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the security group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'sg-xxxxxxxxxxxxxxx',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'DependencyPolicy',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'Dependency policy.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobDependency' => [
+ 'description' => 'The job dependency. A maximum of 10 groups.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The job dependency.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobId' => [
+ 'description' => 'The ID of the job.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'job-bjxxxxxxxxxxxx',
+ ],
+ 'Type' => [
+ 'description' => 'The type of the dependency. Valid values:'."\n"
+ ."\n"
+ .'* AfterSucceeded: **All subtasks** of the dependent job or array job succeed. The exit code is 0.'."\n"
+ .'* AfterFailed: **All subtasks** of the dependent job or array job fail. The exit code is not 0.'."\n"
+ .'* AfterAny: The dependent job completes (succeeds or fails).'."\n"
+ .'* AfterCorresponding: The subtask corresponding to the dependent array job succeeds. The exit code is 0.'."\n"
+ ."\n"
+ .'Default value: AfterSucceeded.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AfterSucceeded',
+ 'enum' => [
+ 'AfterSucceeded',
+ 'AfterFailed',
+ 'AfterAny',
+ 'AfterCorresponding',
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'JobId' => [
+ 'description' => 'The job ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'job-xxxx',
+ ],
+ 'Tasks' => [
+ 'description' => 'The list of tasks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the task list.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => [
+ 'description' => 'The name of the task.'."\n",
+ 'type' => 'string',
+ 'example' => 'task0',
+ ],
+ 'ExecutorIds' => [
+ 'description' => 'The list of executor IDs contained in the task.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the executor. The format is JobId-TaskName-ArrayIndex.'."\n",
+ 'type' => 'string',
+ 'example' => '[\\"job-xxxx-task0_11-2\\"]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'InDebt',
+ 'errorMessage' => 'Your account has overdue payments.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'GetResourceFailed',
+ 'errorMessage' => 'Failed to get resource.',
+ ],
+ [
+ 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut',
+ 'errorMessage' => 'The resource is out of stock.',
+ ],
+ [
+ 'errorCode' => 'DuplicateTagKey',
+ 'errorMessage' => 'Duplicate tag key exists: %s.',
+ ],
+ [
+ 'errorCode' => 'PoolNotFound',
+ 'errorMessage' => 'The specified pool was not found.',
+ ],
+ [
+ 'errorCode' => 'PoolStatusInvalid',
+ 'errorMessage' => 'The specified pool in invalid status.',
+ ],
+ [
+ 'errorCode' => 'QuotaExceeded.PrivateIpAddress',
+ 'errorMessage' => 'Insufficient private IP addresses in vSwitch: %s.',
+ ],
+ [
+ 'errorCode' => 'SecurityGroupInstanceLimitExceed',
+ 'errorMessage' => 'The maximum number of instances in a security group is exceeded.',
+ ],
+ [
+ 'errorCode' => 'QuotaExceeded.Resource',
+ 'errorMessage' => 'Insufficient resource quota.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'ImageNotFound',
+ 'errorMessage' => 'The specified image does not exist.',
+ ],
+ [
+ 'errorCode' => 'SecurityGroupNotExists',
+ 'errorMessage' => 'The security group does not exist.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'EcsError',
+ 'errorMessage' => 'An error occurred while calling the ECS API operation.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database error occurred.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"JobId\\": \\"job-xxxx\\",\\n \\"Tasks\\": [\\n {\\n \\"TaskName\\": \\"task0\\",\\n \\"ExecutorIds\\": [\\n \\"[\\\\\\\\\\\\\\"job-xxxx-task0_11-2\\\\\\\\\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'CreateJob',
+ ],
+ 'GetJob' => [
+ 'summary' => 'Obtains the details of an execution job.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219050',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the job.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxxx',
+ ],
+ ],
+ ],
+ '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' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'JobInfo' => [
+ 'description' => 'The job details.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobId' => [
+ 'description' => 'The ID of the job.'."\n",
+ 'type' => 'string',
+ 'example' => 'job-xxxx',
+ ],
+ 'JobName' => [
+ 'description' => 'The job name.'."\n",
+ 'type' => 'string',
+ 'example' => 'testJob',
+ ],
+ 'JobDescription' => [
+ 'description' => 'The description of the job.'."\n",
+ 'type' => 'string',
+ 'example' => 'Demo',
+ ],
+ 'Tasks' => [
+ 'description' => 'The list of tasks. Only one task is supported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of tasks. Only one task is supported.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => [
+ 'description' => 'The name of the task.'."\n",
+ 'type' => 'string',
+ 'example' => 'task0',
+ ],
+ 'TaskSpec' => [
+ 'description' => 'The details of the task specification.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskExecutor' => [
+ 'description' => 'The task execution configurations.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The task execution configurations.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'VM' => [
+ 'description' => 'Use ECS instances.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Image' => [
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'm-xxxx',
+ ],
+ 'PrologScript' => [
+ 'description' => 'The pre-processing script. Base64 encoding is required.'."\n",
+ 'type' => 'string',
+ 'example' => 'ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg',
+ ],
+ 'Script' => [
+ 'description' => 'The running-job script. Base64 encoding is required.'."\n",
+ 'type' => 'string',
+ 'example' => 'ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'VolumeMount' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'MountPath' => [
+ 'type' => 'string',
+ ],
+ 'VolumeDriver' => [
+ 'type' => 'string',
+ ],
+ 'MountOptions' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 'Resource' => [
+ 'description' => 'The resource information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Cores' => [
+ 'description' => 'The number of CPUs on which the job is run.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '1',
+ ],
+ 'EnableHT' => [
+ 'type' => 'boolean',
+ ],
+ 'Memory' => [
+ 'description' => 'The memory capacity. Unit: GiB.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '4',
+ ],
+ 'Disks' => [
+ 'description' => 'The array of the disks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The array of the disks.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The type of the disk. The following disk categories are supported:'."\n"
+ ."\n"
+ .'* System: system disk.'."\n"
+ .'* Data: data disk.'."\n",
+ 'type' => 'string',
+ 'example' => 'System',
+ ],
+ 'Size' => [
+ 'description' => 'The size of the disk.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ ],
+ ],
+ ],
+ 'HostNamePrefix' => [
+ 'type' => 'string',
+ ],
+ 'InstanceTypes' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 'RetryPolicy' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RetryCount' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'ExitCodeActions' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Action' => [
+ 'type' => 'string',
+ ],
+ 'ExitCode' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ExecutorPolicy' => [
+ 'description' => 'The task execution policy.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'MaxCount' => [
+ 'description' => 'The maximum number of nodes to run the job.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'ArraySpec' => [
+ 'description' => 'The details of the array job.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'IndexStart' => [
+ 'description' => 'The starting value of the array job index. Valid values: 0 to 4999.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'IndexEnd' => [
+ 'description' => 'The end value of the array job index. Valid values: 0 to 4999. The value must be greater than or equal to the value of IndexStart.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '9',
+ ],
+ 'IndexStep' => [
+ 'description' => 'The interval of the array job index.'."\n"
+ ."\n"
+ .'> If the array job property is IndexStart=1,IndexEnd=5, and IndexStep=2, the array job contains three subtasks. The values of the subtask indexes are 1,3, and 5.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TaskSustainable' => [
+ 'description' => 'Indicate whether the job is a long-running job.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'ExecutorStatus' => [
+ 'description' => 'The execution status of the task.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The execution status of the task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ArrayId' => [
+ 'description' => 'Sub-job ID'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the job.'."\n",
+ 'type' => 'string',
+ 'example' => 'Running',
+ ],
+ 'StatusReason' => [
+ 'description' => 'The reason why the stack instance is in the OUTDATED state.'."\n",
+ 'type' => 'string',
+ 'example' => 'Creating executor',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the job was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-02-04 13:54:10',
+ ],
+ 'StartTime' => [
+ 'description' => 'The start time of the scaling plan job.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-02-04 13:54:10',
+ ],
+ 'EndTime' => [
+ 'description' => 'The end time of the scaling plan job.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-02-04 13:54:10',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DeploymentPolicy' => [
+ 'description' => 'The resource deployment policy.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'AllocationSpec' => [
+ 'description' => 'The type of the resource. Only Dedicated is supported. You must enable a whitelist.'."\n",
+ 'type' => 'string',
+ 'example' => 'Dedicated',
+ ],
+ 'Network' => [
+ 'description' => 'The network configuration information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Vswitch' => [
+ 'description' => 'The VSwitch array.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the VSwitch.'."\n",
+ 'type' => 'string',
+ 'example' => 'vsw-xxx',
+ ],
+ ],
+ 'EnableExternalIpAddress' => [
+ 'description' => 'Whether to create a public IP address.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* false: false.'."\n"
+ .'* true: true.'."\n",
+ 'type' => 'boolean',
+ 'enumValueTitles' => [
+ 'false' => 'false',
+ 'true' => 'true',
+ ],
+ 'example' => 'false',
+ ],
+ 'EnableENIMapping' => [
+ 'description' => 'Whether the resource is created in the zone corresponding to the passed-in VSwitch parameter.'."\n"
+ ."\n"
+ .'* true: The resource is created in the zone corresponding to the passed-in VSwitch parameter.'."\n"
+ .'* false: The resource is created in any zone that has resources.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'Tags' => [
+ 'description' => 'The list of job tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of job tags.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => [
+ 'description' => 'The key of the job tag.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestKey',
+ ],
+ 'TagValue' => [
+ 'description' => 'The value of the job tag.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestValue',
+ ],
+ ],
+ ],
+ ],
+ 'Level' => [
+ 'description' => 'The computing power level. The following disk categories are supported:'."\n"
+ ."\n"
+ .'* General'."\n"
+ .'* Performance'."\n"
+ ."\n"
+ .'Default value: General'."\n",
+ 'type' => 'string',
+ 'example' => 'General',
+ ],
+ ],
+ ],
+ 'SecurityPolicy' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SecurityGroup' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SecurityGroupIds' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'DependencyPolicy' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'JobDependency' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'JobId' => [
+ 'type' => 'string',
+ ],
+ 'Type' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the job was submitted.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-03-05 20:00:46',
+ ],
+ 'StartTime' => [
+ 'description' => 'The time when the job started.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-03-05 20:00:48',
+ ],
+ 'EndTime' => [
+ 'description' => 'The time when the job is complete.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-03-05 20:01:48',
+ ],
+ 'Status' => [
+ 'description' => 'The job status. Valid values:'."\n"
+ ."\n"
+ .'* Pending: The job is being queued.'."\n"
+ .'* Initing: The job is being initialized.'."\n"
+ .'* Succeed: The job is successfully run.'."\n"
+ .'* Failed: The job failed to run.'."\n"
+ .'* Running: The job is running.'."\n"
+ .'* Exception: scheduling exception'."\n"
+ .'* Retrying: The job is being retried.'."\n"
+ .'* Expired: The job timed out.'."\n"
+ .'* Deleted: The job is deleted.'."\n"
+ .'* Suspended: job hibernation'."\n"
+ .'* Restarting: The job is being restarted.'."\n",
+ 'type' => 'string',
+ 'example' => 'Succeed',
+ ],
+ 'AppExtraInfo' => [
+ 'description' => 'The additional information about the application.'."\n",
+ 'type' => 'string',
+ 'example' => '{\\"xxx\\": \\"xxxxx\\"}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'JobNotFound',
+ 'errorMessage' => 'The specified job id is not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database error occurred.',
+ ],
+ ],
+ 503 => [
+ [
+ 'errorCode' => 'ServiceUnavailable',
+ 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"JobInfo\\": {\\n \\"JobId\\": \\"job-xxxx\\",\\n \\"JobName\\": \\"testJob\\",\\n \\"JobDescription\\": \\"Demo\\",\\n \\"Tasks\\": [\\n {\\n \\"TaskName\\": \\"task0\\",\\n \\"TaskSpec\\": {\\n \\"TaskExecutor\\": [\\n {\\n \\"VM\\": {\\n \\"Image\\": \\"m-xxxx\\",\\n \\"PrologScript\\": \\"ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg\\",\\n \\"Script\\": \\"ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg\\"\\n }\\n }\\n ],\\n \\"VolumeMount\\": [\\n {\\n \\"MountPath\\": \\"\\",\\n \\"VolumeDriver\\": \\"\\",\\n \\"MountOptions\\": \\"\\"\\n }\\n ],\\n \\"Resource\\": {\\n \\"Cores\\": 1,\\n \\"EnableHT\\": true,\\n \\"Memory\\": 4,\\n \\"Disks\\": [\\n {\\n \\"Type\\": \\"System\\",\\n \\"Size\\": 100\\n }\\n ],\\n \\"HostNamePrefix\\": \\"\\",\\n \\"InstanceTypes\\": [\\n \\"\\"\\n ]\\n },\\n \\"RetryPolicy\\": {\\n \\"RetryCount\\": 0,\\n \\"ExitCodeActions\\": [\\n {\\n \\"Action\\": \\"\\",\\n \\"ExitCode\\": 0\\n }\\n ]\\n }\\n },\\n \\"ExecutorPolicy\\": {\\n \\"MaxCount\\": 10,\\n \\"ArraySpec\\": {\\n \\"IndexStart\\": 0,\\n \\"IndexEnd\\": 9,\\n \\"IndexStep\\": 1\\n }\\n },\\n \\"TaskSustainable\\": true,\\n \\"ExecutorStatus\\": [\\n {\\n \\"ArrayId\\": 0,\\n \\"Status\\": \\"Running\\",\\n \\"StatusReason\\": \\"Creating executor\\",\\n \\"CreateTime\\": \\"2024-02-04 13:54:10\\",\\n \\"StartTime\\": \\"2024-02-04 13:54:10\\",\\n \\"EndTime\\": \\"2024-02-04 13:54:10\\"\\n }\\n ]\\n }\\n ],\\n \\"DeploymentPolicy\\": {\\n \\"AllocationSpec\\": \\"Dedicated\\",\\n \\"Network\\": {\\n \\"Vswitch\\": [\\n \\"vsw-xxx\\"\\n ],\\n \\"EnableExternalIpAddress\\": false,\\n \\"EnableENIMapping\\": false\\n },\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"Level\\": \\"General\\"\\n },\\n \\"SecurityPolicy\\": {\\n \\"SecurityGroup\\": {\\n \\"SecurityGroupIds\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"DependencyPolicy\\": {\\n \\"JobDependency\\": [\\n {\\n \\"JobId\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ]\\n },\\n \\"JobScheduler\\": \\"HPC\\",\\n \\"CreateTime\\": \\"2024-03-05 20:00:46\\",\\n \\"StartTime\\": \\"2024-03-05 20:00:48\\",\\n \\"EndTime\\": \\"2024-03-05 20:01:48\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"AppExtraInfo\\": \\"{\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"xxxxx\\\\\\\\\\\\\\"}\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetJob',
+ ],
+ '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' => '219053',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries on the current page. Default value: 50. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '50',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Filter',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'Queries job filter conditions.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobName' => [
+ 'description' => 'The job name. Fuzzy search is supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testJob',
+ ],
+ 'JobId' => [
+ 'description' => 'The ID of the job.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxxx',
+ ],
+ 'TimeCreatedAfter' => [
+ 'description' => 'For jobs submitted after this time, the time in the region is converted into a UNIX timestamp (UI8).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1703819914',
+ ],
+ 'TimeCreatedBefore' => [
+ 'description' => 'For jobs submitted before this time, the time in the region is converted into a Unix timestamp (for domestic sites, the UI8 region).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1703820113',
+ ],
+ 'Status' => [
+ 'description' => 'The job status. Valid values:'."\n"
+ ."\n"
+ .'* Pending'."\n"
+ .'* initing'."\n"
+ .'* Succeed'."\n"
+ .'* Failed'."\n"
+ .'* Running'."\n"
+ .'* Exception'."\n"
+ .'* Retrying'."\n"
+ .'* Expired'."\n"
+ .'* Suspended'."\n"
+ .'* Restarting'."\n"
+ .'* Deleted'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Running',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'SortBy',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The sorting method.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Label' => [
+ 'description' => 'The sorting label. Valid values:'."\n"
+ ."\n"
+ .'* time_start'."\n"
+ .'* job_name'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'time_start',
+ ],
+ 'Order' => [
+ 'description' => 'The sorting order. Valid values:'."\n"
+ ."\n"
+ .'* ASC (default): ascending order'."\n"
+ .'* DESC: descending order'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ASC',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => [
+ 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回',
+ 'description' => 'The total number of entries returned. This parameter is optional and is not returned by default.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'PageNumber' => [
+ 'title' => 'MaxResults本次请求所返回的最大记录条数',
+ 'description' => 'The current page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'JobList' => [
+ 'description' => 'The list of jobs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of jobs.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobName' => [
+ 'description' => 'The job name.'."\n",
+ 'type' => 'string',
+ 'example' => 'testJob',
+ ],
+ 'JobId' => [
+ 'description' => 'The ID of the job.'."\n",
+ 'type' => 'string',
+ 'example' => 'job-xxx',
+ ],
+ 'JobDescription' => [
+ 'description' => 'The description of the job.'."\n",
+ 'type' => 'string',
+ 'example' => 'Demo',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the job was submitted.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-01-25 12:29:21',
+ ],
+ 'OwnerUid' => [
+ 'description' => 'The UID of the creator.'."\n",
+ 'type' => 'string',
+ 'example' => '129**********',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the job. Valid values:'."\n"
+ ."\n"
+ .'* Pending'."\n"
+ .'* Initing'."\n"
+ .'* Succeed'."\n"
+ .'* Failed'."\n"
+ .'* Running'."\n"
+ .'* Exception'."\n"
+ .'* Retrying'."\n"
+ .'* Expired'."\n"
+ .'* Deleting'."\n"
+ .'* Deleted'."\n",
+ 'type' => 'string',
+ 'example' => 'Running',
+ ],
+ 'TaskCount' => [
+ 'description' => 'The number of tasks.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'ExecutorCount' => [
+ 'description' => 'The number of running nodes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'StartTime' => [
+ 'description' => 'The start time of the job.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-01-25 12:29:23',
+ ],
+ 'EndTime' => [
+ 'description' => 'The end time of the job.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-01-25 12:35:23',
+ ],
+ 'TaskSustainable' => [
+ 'description' => 'Indicate whether the job is a long-running job.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Tags' => [
+ 'description' => 'The list of job tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of job tags.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => [
+ 'description' => 'The key of the job tag.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestKey',
+ ],
+ 'TagValue' => [
+ 'description' => 'The value of the job tag.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestValue',
+ ],
+ ],
+ ],
+ ],
+ 'AppName' => [
+ 'type' => 'string',
+ ],
+ 'AppExtraInfo' => [
+ 'description' => 'The additional information about the application.'."\n",
+ 'type' => 'string',
+ 'example' => '{\\"xxx\\": \\"xxxxx\\"}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'InDebt',
+ 'errorMessage' => 'Your account has overdue payments.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"JobList\\": [\\n {\\n \\"JobName\\": \\"testJob\\",\\n \\"JobId\\": \\"job-xxx\\",\\n \\"JobDescription\\": \\"Demo\\",\\n \\"CreateTime\\": \\"2024-01-25 12:29:21\\",\\n \\"OwnerUid\\": \\"129**********\\",\\n \\"Status\\": \\"Running\\",\\n \\"TaskCount\\": 1,\\n \\"ExecutorCount\\": 1,\\n \\"StartTime\\": \\"2024-01-25 12:29:23\\",\\n \\"EndTime\\": \\"2024-01-25 12:35:23\\",\\n \\"TaskSustainable\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"AppName\\": \\"Alphafold3\\",\\n \\"AppExtraInfo\\": \\"{\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"xxxxx\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListJobs',
+ ],
+ 'DeleteJobs' => [
+ 'summary' => 'Deletes one or more jobs from a specified cluster.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219051',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JobSpec',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The information about the job to be deleted.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the job to be deleted.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobId' => [
+ 'description' => 'The ID of the job to be deleted.\\'."\n"
+ .'You can call the ListJobs operation to query job IDs.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxxx'."\n",
+ ],
+ 'TaskSpec' => [
+ 'description' => 'The task details of the job to be deleted.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The task details of the job to be deleted.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => [
+ 'description' => 'The name of the task to be deleted.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'task0',
+ ],
+ 'ArrayIndex' => [
+ 'description' => 'The list of array job indexes to be deleted.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The index of the array job.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ExecutorIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of executor IDs. A maximum of 100 IDs are supported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The executor ID. The format is JobId-TaskName-ArrayIndex.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxxx-task0-1'."\n",
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'JobScheduler',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the job scheduler.'."\n"
+ ."\n"
+ .'* HPC'."\n"
+ .'* K8S'."\n"
+ ."\n"
+ .'Default value: HPC'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'HPC',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'JobNotFound',
+ 'errorMessage' => 'The specified job id is not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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' => 'DeleteJobs',
+ ],
+ 'ListJobExecutors' => [
+ 'summary' => 'Queries job executor information.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219059',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the job.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxx',
+ ],
+ ],
+ [
+ 'name' => 'TaskName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The job name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'task0',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ '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' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'JobId' => [
+ 'description' => 'The job ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'job-xxxx',
+ ],
+ 'TaskName' => [
+ 'description' => 'The job name.'."\n",
+ 'type' => 'string',
+ 'example' => 'task0',
+ ],
+ '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',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of list entries.'."\n",
+ 'type' => 'string',
+ 'example' => '50',
+ ],
+ 'Executors' => [
+ 'description' => 'The executor list.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The executor property.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ExecutorId' => [
+ 'description' => 'The executor ID. The format is JobId-TaskName-ArrayIndex.'."\n",
+ 'type' => 'string',
+ 'example' => 'job-xxxx-Task0-1'."\n",
+ ],
+ 'ArrayIndex' => [
+ 'description' => 'The executor index number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'IpAddress' => [
+ 'description' => 'The list of node IP addresses.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The IP address of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '192.168.10.11',
+ ],
+ ],
+ 'ExternalIpAddress' => [
+ 'description' => 'The list of public IP addresses of the nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The public IP address of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '116.62.100.6',
+ ],
+ ],
+ 'HostName' => [
+ 'description' => 'An array of node hostnames.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The hostname.'."\n",
+ 'type' => 'string',
+ 'example' => 'host0',
+ ],
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the storage resource was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-02-20 10:04:10',
+ ],
+ 'StartTime' => [
+ 'description' => 'The create time.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-02-20 10:04:13',
+ ],
+ 'EndTime' => [
+ 'description' => 'The end time.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-02-20 10:04:18',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the executor. Valid values:'."\n"
+ ."\n"
+ .'* Pending'."\n"
+ .'* Initing'."\n"
+ .'* Succeed'."\n"
+ .'* Failed'."\n"
+ .'* Running'."\n"
+ .'* Unknown'."\n"
+ .'* Exception'."\n"
+ .'* Retrying'."\n"
+ .'* Expired'."\n"
+ .'* Deleted'."\n",
+ 'type' => 'string',
+ 'example' => 'Running',
+ ],
+ 'StatusReason' => [
+ 'description' => 'The description of the status reason.'."\n",
+ 'type' => 'string',
+ 'example' => 'Creating executor',
+ ],
+ 'Tags' => [
+ 'description' => 'The list of executor tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of executor tags.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => [
+ 'description' => 'The key of the executor tag.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestKey'."\n",
+ ],
+ 'TagValue' => [
+ 'description' => 'The value of the executor tag.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestValue',
+ ],
+ ],
+ ],
+ ],
+ 'ExpirationTime' => [
+ 'type' => 'string',
+ ],
+ 'BlockDuration' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Preemptible' => [
+ 'type' => 'boolean',
+ ],
+ 'AllocationSpec' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 'ExecutorStatus' => [
+ 'description' => 'Executor status statistics.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Pending' => [
+ 'description' => 'The number of executers in the queued state.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Initing' => [
+ 'description' => 'The number of executers in the initialized state.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Running' => [
+ 'description' => 'The number of executers in the running state.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Succeeded' => [
+ 'description' => 'The number of executoresin the Successful state.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Failed' => [
+ 'description' => 'The number of executers in the Failed state.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Deleted' => [
+ 'description' => 'The number of executers in the Deleted state.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Exception' => [
+ 'description' => 'The number of executers in the abnormal state.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Suspended' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Restarting' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'JobNotFound',
+ 'errorMessage' => 'The specified job id is not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"JobId\\": \\"job-xxxx\\",\\n \\"TaskName\\": \\"Task0\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": \\"50\\",\\n \\"Executors\\": [\\n {\\n \\"ExecutorId\\": \\"job-xxxx-Task0-1\\\\n\\",\\n \\"ArrayIndex\\": 0,\\n \\"IpAddress\\": [\\n \\"192.168.10.11\\"\\n ],\\n \\"ExternalIpAddress\\": [\\n \\"116.62.100.6\\"\\n ],\\n \\"HostName\\": [\\n \\"compute-0\\"\\n ],\\n \\"CreateTime\\": \\"2024-02-20 10:04:10\\",\\n \\"StartTime\\": \\"2024-02-20 10:04:13\\",\\n \\"EndTime\\": \\"2024-02-20 10:04:18\\",\\n \\"Status\\": \\"Running\\",\\n \\"StatusReason\\": \\"ExecutorReady\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\\\n\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"ExpirationTime\\": \\"\\",\\n \\"BlockDuration\\": 24,\\n \\"Preemptible\\": true,\\n \\"AllocationSpec\\": \\"Standard\\"\\n }\\n ],\\n \\"ExecutorStatus\\": {\\n \\"Pending\\": 1,\\n \\"Initing\\": 1,\\n \\"Running\\": 1,\\n \\"Succeeded\\": 1,\\n \\"Failed\\": 1,\\n \\"Deleted\\": 1,\\n \\"Exception\\": 1,\\n \\"Suspended\\": 1,\\n \\"Restarting\\": 1\\n }\\n}","type":"json"}]',
+ 'title' => 'ListJobExecutors',
+ 'description' => 'Queries job executor information.'."\n",
+ ],
+ 'ListExecutors' => [
+ 'summary' => 'Querying Global Executor Information',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219060',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Filter',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'Queries the Executor filter conditions.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobName' => [
+ 'description' => 'The job name. Exact filtering. Fuzzy query is not supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testJob',
+ ],
+ 'ExecutorIds' => [
+ 'description' => 'The list of executor IDs. A maximum of 100 IDs are supported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The Executor ID. The format is JobId-TaskName-ArrayIndex.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxxx-task0-1',
+ ],
+ 'required' => false,
+ ],
+ 'IpAddresses' => [
+ 'description' => 'The list of internal IP addresses. A maximum of 100 IP addresses are supported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The internal IP address.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '192.168.0.1',
+ ],
+ 'required' => false,
+ ],
+ 'Status' => [
+ 'description' => 'Executor status list.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The executor status. Valid values:'."\n"
+ ."\n"
+ .'* Pending'."\n"
+ .'* Initing'."\n"
+ .'* Succeed'."\n"
+ .'* Failed'."\n"
+ .'* Running'."\n"
+ .'* Exception'."\n"
+ .'* Retrying'."\n"
+ .'* Expired'."\n"
+ .'* Deleted'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Running',
+ 'enum' => [
+ 'Pending',
+ 'Initing',
+ 'Succeed',
+ 'Failed',
+ 'Running',
+ 'Exception',
+ 'Retrying',
+ 'Expired',
+ 'Deleting',
+ 'Deleted',
+ 'Suspended',
+ 'Restarting',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'TimeCreatedBefore' => [
+ 'description' => 'For jobs submitted before this time, the time in the region is converted into a Unix timestamp (for domestic sites, the UI8 region).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1703820113',
+ ],
+ 'TimeCreatedAfter' => [
+ 'description' => 'For jobs submitted after this time, the time in the region is converted into a UNIX timestamp (UI8).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1703819914',
+ ],
+ 'VswitchId' => [
+ 'description' => 'The ID of the vSwitch.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'vsw-xxx',
+ ],
+ 'Image' => [
+ 'description' => 'Executor image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-f8z0dfa96luxxxxx',
+ ],
+ 'VpcId' => [
+ 'type' => 'string',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. The number of entries returned per page. Default value: 50. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '50',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The current page number.\\'."\n"
+ .'Starting value: 1\\'."\n"
+ .'Default value: 1'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ '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' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '50',
+ ],
+ 'PageNumber' => [
+ 'description' => 'The current page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'string',
+ 'example' => '40',
+ ],
+ 'Executors' => [
+ 'description' => 'Executor list.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Executor property.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ExecutorId' => [
+ 'description' => 'The executor ID. The format is JobId-TaskName-ArrayIndex.'."\n",
+ 'type' => 'string',
+ 'example' => 'job-xxxx-task0-1',
+ ],
+ 'JobId' => [
+ 'description' => 'The job ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'job-hy1nggvyukuvkr******',
+ ],
+ 'JobName' => [
+ 'description' => 'The job name.'."\n",
+ 'type' => 'string',
+ 'example' => 'testJob',
+ ],
+ 'TaskName' => [
+ 'description' => 'The name of the task.'."\n",
+ 'type' => 'string',
+ 'example' => 'task0',
+ ],
+ 'ArrayIndex' => [
+ 'description' => 'The executor number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'IpAddress' => [
+ 'description' => 'The list of internal IP addresses.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The internal IP address.'."\n",
+ 'type' => 'string',
+ 'example' => '192.168.0.1',
+ ],
+ ],
+ 'ExternalIpAddress' => [
+ 'description' => 'The list of public IP addresses of the nodes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of public IP addresses of the nodes.'."\n",
+ 'type' => 'string',
+ 'example' => '116.62.100.6'."\n",
+ ],
+ ],
+ 'HostName' => [
+ 'description' => 'The list of hostnames.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The hostname.'."\n",
+ 'type' => 'string',
+ 'example' => 'testJob-0',
+ ],
+ ],
+ 'Image' => [
+ 'description' => 'Executor image.'."\n",
+ 'type' => 'string',
+ 'example' => 'm-f8z0dfa96luxxxxx',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the instance was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-02-20 10:04:10',
+ ],
+ 'ExpirationTime' => [
+ 'type' => 'string',
+ ],
+ 'StartTime' => [
+ 'description' => 'The start time.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-02-20 10:04:13',
+ ],
+ 'EndTime' => [
+ 'description' => 'The end time.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-02-20 10:04:18',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the executor. Valid values:'."\n"
+ ."\n"
+ .'* Pending'."\n"
+ .'* Initing'."\n"
+ .'* Succeed'."\n"
+ .'* Failed'."\n"
+ .'* Running'."\n"
+ .'* Unknown'."\n"
+ .'* Exception'."\n"
+ .'* Retrying'."\n"
+ .'* Expired'."\n"
+ .'* Deleted'."\n",
+ 'type' => 'string',
+ 'example' => 'Running',
+ ],
+ 'StatusReason' => [
+ 'description' => 'The description of the status reason.'."\n",
+ 'type' => 'string',
+ 'example' => 'Succeeded to release executor resource',
+ ],
+ 'Resource' => [
+ 'description' => 'The resource information.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Cores' => [
+ 'description' => 'The number of running CPUs.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '1',
+ ],
+ 'Memory' => [
+ 'description' => 'The total amount of memory resources. Unit: GiB.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '4',
+ ],
+ 'Disks' => [
+ 'description' => 'The array of the disks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => [
+ 'description' => 'The category of the disk. The following disk categories are supported:'."\n"
+ ."\n"
+ .'* System: system disk.'."\n"
+ .'* Data: data disk.'."\n",
+ 'type' => 'string',
+ 'example' => 'System',
+ ],
+ 'Size' => [
+ 'description' => 'The size of the disk.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'InstanceType' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'VswitchId' => [
+ 'description' => 'The ID of the vSwitch.'."\n",
+ 'type' => 'string',
+ 'example' => 'vsw-xxx',
+ ],
+ 'ResourceType' => [
+ 'description' => 'The type of the resource.'."\n",
+ 'type' => 'string',
+ 'example' => 'ECI',
+ ],
+ 'TaskSustainable' => [
+ 'description' => 'Indicate whether the job is a long-running job.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Tags' => [
+ 'description' => 'The list of executor tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The list of executor tags.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => [
+ 'description' => 'The key of the executor tag.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestKey'."\n",
+ ],
+ 'TagValue' => [
+ 'description' => 'The value of the executor tag.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestValue',
+ ],
+ ],
+ ],
+ ],
+ 'AppName' => [
+ 'type' => 'string',
+ ],
+ 'BlockDuration' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'Preemptible' => [
+ 'type' => 'boolean',
+ ],
+ 'AllocationSpec' => [
+ 'type' => 'string',
+ ],
+ 'VpcId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"PageSize\\": 50,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": \\"40\\",\\n \\"Executors\\": [\\n {\\n \\"ExecutorId\\": \\"job-xxxx-Task0-1\\",\\n \\"JobId\\": \\"job-hy1nggvyukuvkr******\\",\\n \\"JobName\\": \\"testJob\\",\\n \\"TaskName\\": \\"Task0\\",\\n \\"ArrayIndex\\": 0,\\n \\"IpAddress\\": [\\n \\"192.168.0.1\\"\\n ],\\n \\"ExternalIpAddress\\": [\\n \\"116.62.100.6\\\\n\\"\\n ],\\n \\"HostName\\": [\\n \\"testJob-0\\"\\n ],\\n \\"Image\\": \\"m-f8z0dfa96luxxxxx\\",\\n \\"CreateTime\\": \\"2024-02-20 10:04:10\\",\\n \\"ExpirationTime\\": \\"\\",\\n \\"StartTime\\": \\"2024-02-20 10:04:13\\",\\n \\"EndTime\\": \\"2024-02-20 10:04:18\\",\\n \\"Status\\": \\"Running\\",\\n \\"StatusReason\\": \\"ExecutorReady\\",\\n \\"Resource\\": {\\n \\"Cores\\": 1,\\n \\"Memory\\": 4,\\n \\"Disks\\": [\\n {\\n \\"Type\\": \\"System\\",\\n \\"Size\\": 10\\n }\\n ],\\n \\"InstanceType\\": \\"ecs.c7a.8xlarge\\"\\n },\\n \\"VswitchId\\": \\"vsw-xxx\\",\\n \\"ResourceType\\": \\"ECI\\",\\n \\"TaskSustainable\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\\\n\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"AppName\\": \\"Alphafold3\\",\\n \\"BlockDuration\\": 24,\\n \\"Preemptible\\": true,\\n \\"AllocationSpec\\": \\"Standard\\",\\n \\"VpcId\\": \\"vpc-xxx\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListExecutors',
+ ],
+ 'ListExecutorEvents' => [
+ 'summary' => 'Queries the running event list of one or more executers.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '223066',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries on the current page. Default value: 50. Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '50',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The current page number.\\'."\n"
+ .'Starting value: 1\\'."\n"
+ .'Default value: 1'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Filter',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'Queries the Executor filter conditions.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Level' => [
+ 'description' => 'The level of the running event. Valid value:'."\n"
+ ."\n"
+ .'* Normal'."\n"
+ .'* Warning'."\n"
+ .'* Error'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Normal',
+ ],
+ 'TimeAfter' => [
+ 'description' => 'For jobs submitted after this time, the time in the region is converted into a Unix timestamp (UI8 regionfor Aliyun sites).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1703820113',
+ ],
+ 'TimeBefore' => [
+ 'description' => 'For jobs submitted before this time, the time in the region is converted into a Unix timestamp (UI8 regionfor Aliyun sites).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1703819914',
+ ],
+ 'JobId' => [
+ 'description' => 'The job ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxxx',
+ ],
+ 'ExecutorIds' => [
+ 'description' => 'The list of executor IDs. A maximum of 100 IDs are supported.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The Executor ID. The format is JobId-TaskName-ArrayIndex.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxxx-Task0-1',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '50',
+ ],
+ 'PageNumber' => [
+ 'description' => 'The page number of the returned page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '40',
+ ],
+ 'ExecutorEventList' => [
+ 'description' => 'The list of the running event.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The properties of the running event.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'JobId' => [
+ 'description' => 'The job ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'job-xxxx',
+ ],
+ 'ExecutorId' => [
+ 'description' => 'The ID of the executor. The format is JobId-TaskName-ArrayIndex.'."\n",
+ 'type' => 'string',
+ 'example' => 'job-xxxx-Task0-1',
+ ],
+ 'Level' => [
+ 'description' => 'The level of the running event. Valid values:'."\n"
+ ."\n"
+ .'* Normal'."\n"
+ .'* Warning'."\n"
+ .'* Error'."\n",
+ 'type' => 'string',
+ 'example' => 'Normal',
+ ],
+ 'Time' => [
+ 'description' => 'The event of the running event.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-02-20 10:04:13',
+ ],
+ 'Content' => [
+ 'description' => 'The content of the running event.'."\n",
+ 'type' => 'string',
+ 'example' => 'Executor created successfully',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'JobNotFound',
+ 'errorMessage' => 'The specified job id is not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"PageSize\\": 50,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 40,\\n \\"ExecutorEventList\\": [\\n {\\n \\"JobId\\": \\"job-xxxx\\",\\n \\"ExecutorId\\": \\"job-xxxx-Task0-1\\",\\n \\"Level\\": \\"Normal\\",\\n \\"Time\\": \\"2024-02-20 10:04:13\\",\\n \\"Content\\": \\"Executor created successfully\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListExecutorEvents',
+ 'description' => 'Queries job executor information.'."\n",
+ ],
+ 'DeleteJobRecords' => [
+ 'summary' => 'Deletes one or more job records that are in the final state from a specified cluster.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219051',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JobIds',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of job IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the job whose records are to be deleted.'."\n"
+ ."\n"
+ .'You can call the ListJobs operation to query job IDs.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxx',
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'JobNotFound',
+ 'errorMessage' => 'The specified job id is not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteJobRecords',
+ ],
+ 'DescribeJobResults' => [
+ 'summary' => 'Query job logs',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '223066',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxxxxxx',
+ ],
+ ],
+ [
+ 'name' => 'TaskName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Task0',
+ ],
+ ],
+ [
+ 'name' => 'ArrayIndex',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0_1',
+ ],
+ ],
+ [
+ 'name' => 'ContentEncoding',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PlainText',
+ ],
+ ],
+ [
+ 'name' => 'LimitBytes',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1048576',
+ ],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2024-09-02T16:00:00Z',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request',
+ 'type' => 'string',
+ 'example' => 'BABC742E-04D7-5BA5-8A5F-7D9461D37B19',
+ ],
+ 'Output' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'MTU6MzA6MDEK',
+ ],
+ 'ExitCode' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '0',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'JobNotFound',
+ 'errorMessage' => 'The specified job id is not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\": \\"BABC742E-04D7-5BA5-8A5F-7D9461D37B19\\",\\n \\"Output\\": \\"MTU6MzA6MDEK\\",\\n \\"ExitCode\\": 0\\n}","type":"json"}]',
+ 'title' => 'DescribeJobResults',
+ ],
+ 'DescribeJobMetricData' => [
+ 'summary' => 'You can query the monitoring time series dataset of a job by specifying the job array index and query metric parameters.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219038',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcR6Y931',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The job ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'job-xxxxx'."\n",
+ ],
+ ],
+ [
+ 'name' => 'TaskName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Task0'."\n",
+ ],
+ ],
+ [
+ 'name' => 'MetricName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The metrics of the job.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cpu_utilization'."\n",
+ ],
+ ],
+ [
+ 'name' => 'ArrayIndex',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of array job indexes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The index of the array job.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ 'required' => true,
+ 'docRequired' => 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' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n",
+ ],
+ 'Period' => [
+ 'description' => 'The statistical period of the monitoring data. Valid values: 15, 60, 900, and 3600. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '15',
+ ],
+ 'DataPoints' => [
+ 'description' => 'Monitoring statistics points.'."\n",
+ 'type' => 'string',
+ 'example' => '[{"timestamp":1709540685000,"Minimum":28.45,"Maximum":28.45,"Average":28.45}]'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'JobNotFound',
+ 'errorMessage' => 'The specified job id is not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\",\\n \\"Period\\": 15,\\n \\"DataPoints\\": \\"[{\\\\\\"timestamp\\\\\\":1709540685000,\\\\\\"Minimum\\\\\\":28.45,\\\\\\"Maximum\\\\\\":28.45,\\\\\\"Average\\\\\\":28.45}]\\\\n\\"\\n}","type":"json"}]',
+ 'title' => 'DescribeJobMetricData',
+ ],
+ 'DescribeJobMetricLast' => [
+ 'summary' => 'Queries all instant monitoring metrics in the job array list by specifying a specific job array index list.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219041',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcR6Y931',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'JobId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The job ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'job-xxxxx'."\n",
+ ],
+ ],
+ [
+ 'name' => 'TaskName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Task0',
+ ],
+ ],
+ [
+ 'name' => 'ArrayIndex',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The list of array job indexes.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The index of the array job.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ 'required' => true,
+ 'docRequired' => 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' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n",
+ ],
+ 'Metrics' => [
+ 'description' => 'The list of the JobMetric details.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the JobMetric.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ArrayIndex' => [
+ 'description' => 'The index of the array job.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Metric' => [
+ 'description' => 'The monitoring item information corresponding to the array job index.'."\n",
+ 'type' => 'string',
+ 'example' => '{"memory_utilization": 37.42,"cpu_utilization": 1.008, "disk_utilization": 3.562}'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'JobNotFound',
+ 'errorMessage' => 'The specified job id is not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\",\\n \\"Metrics\\": [\\n {\\n \\"ArrayIndex\\": 1,\\n \\"Metric\\": \\"{\\\\\\"memory_utilization\\\\\\": 37.42,\\\\\\"cpu_utilization\\\\\\": 1.008, \\\\\\"disk_utilization\\\\\\": 3.562}\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeJobMetricLast',
+ ],
+ 'TagResources' => [
+ 'summary' => 'Create and bind tags to Instant resource list',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '239758',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ 'autoTest' => true,
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '资源类型',
+ 'description' => 'The type of the resource. Valid values:'."\n"
+ ."\n"
+ .'* Job'."\n"
+ .'* Executor'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Job',
+ 'enum' => [],
+ ],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '资源ID,最多 50个子项',
+ 'description' => 'The list of resource IDs. Valid values of N: 1 to 50.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The resource ID.'."\n"
+ ."\n"
+ .'* If the ResourceType parameter is set to `Job`, the Resource ID parameter specifies the Job ID.'."\n"
+ .'* If the ResourceType parameter is set to `Executor`, the resource ID parameter specifies the executor ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxxxxxxx',
+ ],
+ 'required' => true,
+ 'maxItems' => 51,
+ ],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '标签列表,最多包含20个子项',
+ 'description' => 'The tags to add to the replication pair-consistent group. You can specify up to 20 tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'title' => '标签键',
+ 'description' => 'The key of the tag. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'TestKey',
+ ],
+ 'Value' => [
+ 'title' => '标签值',
+ 'description' => 'The value of the tag. You can specify empty strings as tag values. The tag value can be up to 128 characters in length and cannot contain http:// or https://.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TestValue',
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => true,
+ 'maxItems' => 21,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'JobNotFound',
+ 'errorMessage' => 'The specified job id is not found.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'DuplicateTagKey',
+ 'errorMessage' => 'Duplicate tag key exists: %s.',
+ ],
+ [
+ 'errorCode' => 'ExecutorNotFound',
+ 'errorMessage' => 'The specified job executor was not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'TagError',
+ 'errorMessage' => 'Tag operation error.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'NotAuthorized',
+ 'errorMessage' => 'No authorization is granted.',
+ ],
+ ],
+ 503 => [
+ [
+ 'errorCode' => 'ServiceUnavailable',
+ 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
+ 'title' => 'TagResources',
+ ],
+ 'ListTagResources' => [
+ 'summary' => 'Queries the tags that are bound to one or more Instant resources.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '240622',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ 'autoTest' => true,
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the resource. Valid values:'."\n"
+ ."\n"
+ .'* Job'."\n"
+ .'* Executor'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Job',
+ 'enum' => [],
+ ],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '资源ID,最多 50个子项',
+ 'description' => 'The list of resource IDs. Valid values of N: 1 to 50.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The resource ID.'."\n"
+ ."\n"
+ .'* If the ResourceType parameter is set to `Job`, the Resource ID parameter specifies the Job ID.'."\n"
+ .'* If the ResourceType parameter is set to `Executor`, the resource ID parameter specifies the executor ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxxxxxxx',
+ ],
+ 'required' => false,
+ 'maxItems' => 51,
+ ],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '标签列表,最多包含20个子项',
+ 'description' => 'The tags to add to the replication pair-consistent group. You can specify up to 20 tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => [
+ 'title' => '标签键',
+ 'description' => 'The key of the tag.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TestKey',
+ ],
+ 'Value' => [
+ 'title' => '标签值',
+ 'description' => 'The value of the tag.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TestValue'."\n",
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 21,
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'A pagination token.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1d2db86scXXXXXXXXXX',
+ ],
+ ],
+ [
+ 'name' => 'MaxResult',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of records per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NextToken' => [
+ 'title' => '下一个查询开始Token,NextToken为空说明没有下一个',
+ 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n",
+ 'type' => 'string',
+ 'example' => '1d2db86scXXXXXXXXXX',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n",
+ ],
+ 'TagResources' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'TagResource' => [
+ 'title' => '资源列表',
+ 'description' => 'The resource list.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ResourceType' => [
+ 'title' => '资源类型',
+ 'description' => 'The type of the resource.'."\n",
+ 'type' => 'string',
+ 'example' => 'Job',
+ ],
+ 'TagValue' => [
+ 'title' => '标签值',
+ 'description' => 'The value of the tag.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestValue',
+ ],
+ 'ResourceId' => [
+ 'title' => '资源ID',
+ 'description' => 'The ID of the resource.'."\n",
+ 'type' => 'string',
+ 'example' => 'job-xxxxxxxx'."\n",
+ ],
+ 'TagKey' => [
+ 'title' => '标签键',
+ 'description' => 'The key of the tag that is added to the resource.'."\n",
+ 'type' => 'string',
+ 'example' => 'TestKey',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'JobNotFound',
+ 'errorMessage' => 'The specified job id is not found.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'DuplicateTagKey',
+ 'errorMessage' => 'Duplicate tag key exists: %s.',
+ ],
+ [
+ 'errorCode' => 'ExecutorNotFound',
+ 'errorMessage' => 'The specified job executor was not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'TagError',
+ 'errorMessage' => 'Tag operation error.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'NotAuthorized',
+ 'errorMessage' => 'No authorization is granted.',
+ ],
+ ],
+ 503 => [
+ [
+ 'errorCode' => 'ServiceUnavailable',
+ 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"1d2db86scXXXXXXXXXX\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"Job\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"job-xxxxxxxx\\\\n\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'ListTagResources',
+ ],
+ 'UnTagResources' => [
+ 'summary' => 'Unbind tags from Instant resource list. If the tag is not bound to other resources, the tag is automatically deleted.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '240623',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ 'autoTest' => true,
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '资源类型',
+ 'description' => 'The type of the resource. Valid values:'."\n"
+ ."\n"
+ .'* Job'."\n"
+ .'* Executor'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'Job'."\n",
+ 'enum' => [],
+ ],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '资源ID,最多 50个子项',
+ 'description' => 'The list of resource IDs. Valid values of N: 1 to 50.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The resource ID.'."\n"
+ ."\n"
+ .'If the ResourceType parameter is set to `Job`, the Resource ID parameter specifies the Job ID. If the ResourceType parameter is set to `Executor`, the resource ID parameter specifies the executor ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'job-xxxxxxxx'."\n",
+ ],
+ 'required' => true,
+ 'maxItems' => 50,
+ ],
+ ],
+ [
+ 'name' => 'TagKey',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of tag keys, which can contain a maximum of 20 child items.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The key of the tag.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TestKey'."\n",
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'All',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Whether to delete all tags of the target resource. This field takes effect only when TagKey.N is left empty. Default False'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'False',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'JobNotFound',
+ 'errorMessage' => 'The specified job id is not found.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'DuplicateTagKey',
+ 'errorMessage' => 'Duplicate tag key exists: %s.',
+ ],
+ [
+ 'errorCode' => 'ExecutorNotFound',
+ 'errorMessage' => 'The specified job executor was not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'TagError',
+ 'errorMessage' => 'Tag operation error.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'NotAuthorized',
+ 'errorMessage' => 'No authorization is granted.',
+ ],
+ ],
+ 503 => [
+ [
+ 'errorCode' => 'ServiceUnavailable',
+ 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
+ 'title' => 'UnTagResources',
+ ],
+ 'CreatePool' => [
+ 'summary' => 'Creates a resource pool.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '248937',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PoolName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the resource pool.'."\n"
+ ."\n"
+ .'* The name can be up to 15 characters in length.'."\n"
+ .'* It can contain digits, uppercase letters, lowercase letters, underscores (\\_), and dots (.).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PoolTest',
+ 'maxLength' => 32,
+ ],
+ ],
+ [
+ 'name' => 'Priority',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The priority of the resource pool.'."\n"
+ ."\n"
+ .'* You can set a priority in the range of 1 to 99. The default value is 1, which is the lowest priority.'."\n"
+ .'* Jobs submitted to a resource pool with a higher priority level value will be scheduled before pending jobs in a resource pool with a lower priority level value, and the priority level of the resource pool takes precedence over the priority of the job.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ResourceLimits',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The quota of resources that users are allowed to concurrently use in a resource pool.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'MaxExectorNum' => [
+ 'description' => 'The maximum number of concurrent execution nodes in a resource pool.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2000',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request'."\n",
+ 'type' => 'string',
+ 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'InDebt',
+ 'errorMessage' => 'Your account has overdue payments.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ [
+ 'errorCode' => 'PoolAlreadyExists',
+ 'errorMessage' => 'The pool already exists.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'GetResourceFailed',
+ 'errorMessage' => 'Failed to get resource.',
+ ],
+ [
+ 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut',
+ 'errorMessage' => 'The resource is out of stock.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'EcsError',
+ 'errorMessage' => 'An error occurred while calling the ECS API operation.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database error occurred.',
+ ],
+ ],
+ 503 => [
+ [
+ 'errorCode' => 'ServiceUnavailable',
+ 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
+ 'title' => 'CreatePool',
+ ],
+ 'UpdatePool' => [
+ 'summary' => 'Update the resource pool configuration.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '257986',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PoolName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the resource pool.'."\n"
+ ."\n"
+ .'* The value can be up to 15 characters in length.'."\n"
+ .'* It can contain digits, uppercase letters, lowercase letters, underscores (\\_), and dots (.).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PoolTest',
+ ],
+ ],
+ [
+ 'name' => 'Priority',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The priority of the resource pool.'."\n"
+ ."\n"
+ .'* You can set a priority in the range of 1 to 99. The default value is 1, which is the lowest priority.'."\n"
+ .'* Jobs submitted to a resource pool with a higher priority level value will be scheduled before pending jobs in a resource pool with a lower priority level value, and the priority level of the resource pool takes precedence over the priority of the job.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ResourceLimits',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The quota of resources that users are allowed to concurrently use in a resource pool.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'MaxExectorNum' => [
+ 'description' => 'The maximum number of concurrent execution nodes in a resource pool.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2000',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request'."\n",
+ 'type' => 'string',
+ 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'InDebt',
+ 'errorMessage' => 'Your account has overdue payments.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'GetResourceFailed',
+ 'errorMessage' => 'Failed to get resource.',
+ ],
+ [
+ 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut',
+ 'errorMessage' => 'The resource is out of stock.',
+ ],
+ [
+ 'errorCode' => 'PoolNotFound',
+ 'errorMessage' => 'The specified pool was not found.',
+ ],
+ [
+ 'errorCode' => 'PoolStatusInvalid',
+ 'errorMessage' => 'The specified pool in invalid status.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'EcsError',
+ 'errorMessage' => 'An error occurred while calling the ECS API operation.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\"\\n}","type":"json"}]',
+ 'title' => 'UpdatePool',
+ ],
+ 'GetPool' => [
+ 'summary' => 'Obtains the details of a resource pool.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '250272',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcKIUG5Z',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PoolName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the resource pool.'."\n"
+ ."\n"
+ .'* The value can be up to 15 characters in length.'."\n"
+ .'* It can contain digits, uppercase letters, lowercase letters, underscores (\\_), and dots (.).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PoolTest',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request'."\n",
+ 'type' => 'string',
+ 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'PoolInfo' => [
+ 'description' => 'The information about the resource pool.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolName' => [
+ 'description' => 'The name of the resource group.'."\n"
+ ."\n"
+ .'* The value can be up to 15 characters in length.'."\n"
+ .'* It can contain digits, uppercase letters, lowercase letters, underscores (\\_), and dots (.).'."\n",
+ 'type' => 'string',
+ 'example' => 'PoolTest',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the resource pool. Valid values:'."\n"
+ ."\n"
+ .'* Creating: The resource pool is being created.'."\n"
+ .'* Updating: The resource pool is being updated.'."\n"
+ .'* Deleting: The resource pool is being deleted.'."\n"
+ .'* Working: The resource pool is working.'."\n"
+ .'* Deleted: The resource pool is deleted.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [],
+ 'example' => 'Working',
+ ],
+ 'IsDefault' => [
+ 'description' => 'Indices whether the resource pool is the default resource pool. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority of the resource pool.'."\n"
+ ."\n"
+ .'* You can set a priority in the range of 1 to 99. The default value is 1, which is the lowest priority.'."\n"
+ .'* Jobs submitted to a resource pool with a higher priority level value will be scheduled before pending jobs in a resource pool with a lower priority level value, and the priority level of the resource pool takes precedence over the priority of the job.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'MaxExectorNum' => [
+ 'description' => 'The maximum number of execution nodes that can run concurrently in a resource pool.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2000',
+ ],
+ 'ExectorUsage' => [
+ 'description' => 'The usage of execution nodes that are running in a resource pool.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the resource pool is created.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-12-01 20:00:00',
+ ],
+ 'UpdateTime' => [
+ 'description' => 'The time when the resource pool was updated.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-12-01 20:00:00',
+ ],
+ 'Reason' => [
+ 'description' => 'The cause of the error.'."\n",
+ 'type' => 'string',
+ 'example' => 'Fails to *** pool: ***.',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'InDebt',
+ 'errorMessage' => 'Your account has overdue payments.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'GetResourceFailed',
+ 'errorMessage' => 'Failed to get resource.',
+ ],
+ [
+ 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut',
+ 'errorMessage' => 'The resource is out of stock.',
+ ],
+ [
+ 'errorCode' => 'PoolNotFound',
+ 'errorMessage' => 'The specified pool was not found.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'EcsError',
+ 'errorMessage' => 'An error occurred while calling the ECS API operation.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"PoolInfo\\": {\\n \\"PoolName\\": \\"PoolTest\\",\\n \\"Status\\": \\"Working\\",\\n \\"IsDefault\\": true,\\n \\"Priority\\": 1,\\n \\"MaxExectorNum\\": 2000,\\n \\"ExectorUsage\\": 1,\\n \\"CreateTime\\": \\"2024-12-01 20:00:00\\",\\n \\"UpdateTime\\": \\"2024-12-01 20:00:00\\",\\n \\"Reason\\": \\"Fails to *** pool: ***.\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetPool',
+ ],
+ 'ListPools' => [
+ 'summary' => 'Queries the resource pool list.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249321',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'Filter',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'Queries the filter conditions of a resource pool.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolName' => [
+ 'description' => 'Queries the list of resource pool names.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the resource pool.'."\n"
+ ."\n"
+ .'* The value can be up to 15 characters in length.'."\n"
+ .'* It can contain digits, uppercase letters, lowercase letters, underscores (\\_), and dots (.).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PoolTest',
+ ],
+ 'required' => false,
+ ],
+ 'Status' => [
+ 'description' => 'Queries resource pool status list.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The status of the resource pool. Valid values:'."\n"
+ ."\n"
+ .'* Creating: The resource pool is being created.'."\n"
+ .'* Updating: The resource pool is being updated.'."\n"
+ .'* Deleting: The resource pool is being deleted.'."\n"
+ .'* Working: The resource pool is working.'."\n"
+ .'* Deleted: The resource pool is deleted.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'Working',
+ 'enum' => [
+ 'Creating',
+ 'Working',
+ 'Updating',
+ 'Deleting',
+ 'Deleted',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'TimeCreatedBefore' => [
+ 'description' => 'For node pools created before this time, the time in the region is converted into a UNIX timestamp.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1703820113',
+ ],
+ 'TimeCreatedAfter' => [
+ 'description' => 'For node pools created after this time, the time in the region is converted into a UNIX timestamp.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1703819914',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries on each page. Maximum value: 50. Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request'."\n",
+ 'type' => 'string',
+ 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ 'PageSize' => [
+ 'description' => 'The number of entries on each page. Maximum value: 50. Default value: 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'PageNumber' => [
+ 'description' => 'The page number. Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'TotalCount' => [
+ 'description' => 'The total number of list entries.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'PoolList' => [
+ 'description' => 'Queries the resource pool list.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about a single resource pool in the list.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolName' => [
+ 'description' => 'The name of the resource pool.'."\n"
+ ."\n"
+ .'* The value can be up to 15 characters in length.'."\n"
+ .'* It can contain digits, uppercase letters, lowercase letters, underscores (\\_), and dots (.).'."\n",
+ 'type' => 'string',
+ 'example' => 'PoolTest',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the resource pool. Valid values:'."\n"
+ ."\n"
+ .'* Creating: The resource pool is being created.'."\n"
+ .'* Updating: The resource pool is being updated.'."\n"
+ .'* Deleting: The resource pool is being deleted.'."\n"
+ .'* Working: The resource pool is working.'."\n"
+ .'* Deleted: The resource pool is deleted.'."\n",
+ 'type' => 'string',
+ 'example' => 'Working',
+ ],
+ 'Priority' => [
+ 'description' => 'The priority of the resource pool.'."\n"
+ ."\n"
+ .'* You can set a priority in the range of 1 to 99. The default value is 1, which is the lowest priority.'."\n"
+ .'* Jobs submitted to a resource pool with a higher priority level value will be scheduled before pending jobs in a resource pool with a lower priority level value, and the priority level of the resource pool takes precedence over the priority of the job.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'IsDefault' => [
+ 'description' => 'Indices whether the resource pool is the default resource pool. Valid values:'."\n"
+ ."\n"
+ .'* **true**'."\n"
+ .'* **false**'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'MaxExectorNum' => [
+ 'description' => 'The maximum number of execution nodes that can run concurrently in a resource pool.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'InDebt',
+ 'errorMessage' => 'Your account has overdue payments.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'GetResourceFailed',
+ 'errorMessage' => 'Failed to get resource.',
+ ],
+ [
+ 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut',
+ 'errorMessage' => 'The resource is out of stock.',
+ ],
+ ],
+ [
+ [
+ 'errorCode' => 'ImageNotFound',
+ 'errorMessage' => 'The specified image does not exist.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'EcsError',
+ 'errorMessage' => 'An error occurred while calling the ECS API operation.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"PoolList\\": [\\n {\\n \\"PoolName\\": \\"PoolTest\\",\\n \\"Status\\": \\"Working\\",\\n \\"Priority\\": 1,\\n \\"IsDefault\\": true,\\n \\"MaxExectorNum\\": 2000\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListPools',
+ ],
+ 'DeletePool' => [
+ 'summary' => 'You can execute this statement to delete a resource pool.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249322',
+ 'abilityTreeNodes' => [
+ 'FEATUREehpcSHKJ2Q',
+ 'FEATUREehpcKIUG5Z',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PoolName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the resource pool.'."\n"
+ ."\n"
+ .'* The value can be up to 15 characters in length.'."\n"
+ .'* It can contain digits, uppercase letters, lowercase letters, underscores (\\_), and dots (.).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'PoolTest',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => 'Id of the request'."\n",
+ 'type' => 'string',
+ 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InvalidParams',
+ 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ [
+ 'errorCode' => 'InDebt',
+ 'errorMessage' => 'Your account has overdue payments.',
+ ],
+ [
+ 'errorCode' => 'NotEnabled',
+ 'errorMessage' => 'You have not enabled this service.',
+ ],
+ ],
+ 403 => [
+ [
+ 'errorCode' => 'GetResourceFailed',
+ 'errorMessage' => 'Failed to get resource.',
+ ],
+ [
+ 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut',
+ 'errorMessage' => 'The resource is out of stock.',
+ ],
+ [
+ 'errorCode' => 'PoolNotFound',
+ 'errorMessage' => 'The specified pool was not found.',
+ ],
+ [
+ 'errorCode' => 'PoolStatusInvalid',
+ 'errorMessage' => 'The specified pool in invalid status.',
+ ],
+ [
+ 'errorCode' => 'PoolInUse',
+ 'errorMessage' => 'The specified pool is in use.',
+ ],
+ ],
+ 406 => [
+ [
+ 'errorCode' => 'AliyunError',
+ 'errorMessage' => 'An Alibaba Cloud product error occurred.',
+ ],
+ [
+ 'errorCode' => 'EcsError',
+ 'errorMessage' => 'An error occurred while calling the ECS API operation.',
+ ],
+ [
+ 'errorCode' => 'DbError',
+ 'errorMessage' => 'A database 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\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
+ 'title' => 'DeletePool',
+ ],
+ ],
+ 'endpoints' => [
+ [
+ 'regionId' => 'cn-beijing',
+ 'endpoint' => 'ehpcinstant.cn-beijing.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-wulanchabu',
+ 'endpoint' => 'ehpcinstant.cn-wulanchabu.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hangzhou',
+ 'endpoint' => 'ehpcinstant.cn-hangzhou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shanghai',
+ 'endpoint' => 'ehpcinstant.cn-shanghai.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-shenzhen',
+ 'endpoint' => 'ehpcinstant.cn-shenzhen.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-heyuan',
+ 'endpoint' => 'ehpcinstant.cn-heyuan.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-guangzhou',
+ 'endpoint' => 'ehpcinstant.cn-guangzhou.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-chengdu',
+ 'endpoint' => 'ehpcinstant.cn-chengdu.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'cn-hongkong',
+ 'endpoint' => 'ehpcinstant.cn-hongkong.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-northeast-1',
+ 'endpoint' => 'ehpcinstant.ap-northeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-1',
+ 'endpoint' => 'ehpcinstant.ap-southeast-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-5',
+ 'endpoint' => 'ehpcinstant.ap-southeast-5.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'eu-central-1',
+ 'endpoint' => 'ehpcinstant.eu-central-1.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-northeast-2',
+ 'endpoint' => 'ehpcinstant.ap-northeast-2.aliyuncs.com',
+ ],
+ [
+ 'regionId' => 'ap-southeast-3',
+ 'endpoint' => 'ehpcinstant.ap-southeast-3.aliyuncs.com',
+ ],
+ ],
+];