summaryrefslogtreecommitdiff
path: root/data/en_us/ehpcinstant/2023-07-01
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/ehpcinstant/2023-07-01
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/ehpcinstant/2023-07-01')
-rw-r--r--data/en_us/ehpcinstant/2023-07-01/api-docs.php9412
1 files changed, 4095 insertions, 5317 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
index 410a03f..25616d0 100644
--- a/data/en_us/ehpcinstant/2023-07-01/api-docs.php
+++ b/data/en_us/ehpcinstant/2023-07-01/api-docs.php
@@ -1,98 +1,206 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'EhpcInstant',
- 'version' => '2023-07-01',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'EhpcInstant', 'version' => '2023-07-01'],
'directories' => [
[
- 'id' => 380391,
- 'title' => null,
+ 'children' => ['CreateActionPlan', 'UpdateActionPlan', 'ListActionPlans', 'ListActionPlanActivities', 'GetActionPlan', 'DeleteActionPlan'],
'type' => 'directory',
- 'children' => [
- 'CreateActionPlan',
- 'UpdateActionPlan',
- 'ListActionPlans',
- 'ListActionPlanActivities',
- 'GetActionPlan',
- 'DeleteActionPlan',
- ],
+ 'title' => 'Execution plan',
],
[
- 'id' => 380398,
- 'title' => null,
+ 'children' => ['AddImage', 'GetImage', 'GetAppVersions', 'ListImages', 'RemoveImage', 'SynchronizeApp'],
'type' => 'directory',
- 'children' => [
- 'AddImage',
- 'GetImage',
- 'ListImages',
- 'RemoveImage',
- 'GetAppVersions',
- 'SynchronizeApp',
- ],
+ 'title' => 'Image',
],
[
- 'id' => 380405,
- 'title' => null,
+ 'children' => ['CreateJob', 'DeleteJobs', 'DeleteJobRecords', 'DescribeJobResults', 'GetJob', 'GetJobRecordDuration', 'ListJobs', 'ListExecutors', 'ListJobExecutors', 'ListExecutorEvents', 'UpdateJobRecordDuration'],
'type' => 'directory',
- 'children' => [
- 'CreateJob',
- 'GetJob',
- 'ListJobs',
- 'DeleteJobs',
- 'ListJobExecutors',
- 'ListExecutors',
- 'ListExecutorEvents',
- 'DeleteJobRecords',
- 'DescribeJobResults',
- ],
+ 'title' => 'Job',
],
[
- 'id' => 380415,
- 'title' => null,
+ 'children' => ['DescribeJobMetricData', 'DescribeJobMetricLast'],
'type' => 'directory',
- 'children' => [
- 'DescribeJobMetricData',
- 'DescribeJobMetricLast',
- ],
+ 'title' => 'Monitoring',
],
[
- 'id' => 380418,
- 'title' => null,
+ 'children' => ['CreatePool', 'DeletePool', 'GetPool', 'ListPools', 'UpdatePool'],
'type' => 'directory',
- 'children' => [
- 'TagResources',
- 'ListTagResources',
- 'UnTagResources',
- ],
+ 'title' => 'Resource pool',
],
[
- 'id' => 380422,
- 'title' => null,
+ 'children' => ['ListTagResources', 'TagResources', 'UnTagResources'],
'type' => 'directory',
- 'children' => [
- 'CreatePool',
- 'UpdatePool',
- 'GetPool',
- 'ListPools',
- 'DeletePool',
- ],
+ 'title' => 'Other',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateActionPlan' => [
- 'summary' => 'Create a E-HPC execution plan.',
- 'path' => '',
- 'methods' => [
- 'post',
+ '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', 'title' => ''],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The name of the custom image.'."\n", 'type' => 'string', 'required' => true, 'example' => 'app-image'."\n", 'title' => ''],
+ ],
+ [
+ 'name' => 'ImageVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The version of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'V1.0', 'title' => ''],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Test image'."\n", 'title' => ''],
+ ],
+ [
+ '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", 'title' => ''],
+ 'IsACRRegistry' => ['description' => 'Whether it is an Alibaba Cloud image repository.'."\n"
+ ."\n"
+ .'* True'."\n"
+ .'* False'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'True', 'title' => ''],
+ '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', 'title' => ''],
+ 'RegistryCriId' => ['description' => 'The ID of the Container Registry Enterprise Edition image repository.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cri-xyz795ygf8k9****'."\n", 'title' => ''],
+ '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", 'title' => ''],
+ 'UserName' => ['description' => 'The username of the logon user.'."\n", 'type' => 'string', 'required' => false, 'example' => 'username', 'title' => ''],
+ 'Password' => ['description' => 'The password of the logon user.'."\n", 'type' => 'string', 'required' => false, 'example' => 'userpassword', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ '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", 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ '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', 'title' => ''],
+ 'ImageId' => ['title' => 'Id of the request', 'description' => 'The image ID.'."\n", 'type' => 'string', 'example' => 'm-bp1akkkr1rkxtb******'."\n"],
+ ],
+ 'example' => '',
+ ],
+ ],
],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'ImageAlreadyExists', 'errorMessage' => 'The image id already exists.', 'description' => 'Mirror already exists'],
+ ['errorCode' => 'InDebt', 'errorMessage' => 'Your account has overdue payments.', 'description' => 'Your account has overdue payments.'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => 'You have not enabled this service'],
+ ],
+ 403 => [
+ ['errorCode' => 'ImageInUse', 'errorMessage' => 'Image is still used by jobs.', 'description' => 'Mirror still in use'],
+ ],
+ [
+ ['errorCode' => 'ImageNotFound', 'errorMessage' => 'The specified image does not exist.', 'description' => 'The specified image does not exist. Please verify the parameter.'],
+ ],
+ 406 => [
+ ['errorCode' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
+ ],
+ [
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'No authorization is granted.', 'description' => 'No authorization is granted.'],
+ ],
+ 503 => [
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddImage'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ehpc:AddImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CreateActionPlan' => [
+ 'summary' => 'Creates an E-HPC execution plan.',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -104,9 +212,7 @@
'operationType' => 'create',
'riskType' => 'high',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREehpc11IJC9',
- ],
+ 'abilityTreeNodes' => ['FEATUREehpc11IJC9'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -114,112 +220,62 @@
[
'name' => 'ActionPlanName',
'in' => 'query',
- 'schema' => [
- 'title' => '执行计划的名称。',
- 'description' => 'The name of the execution plan.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestActionPlan',
- ],
+ 'schema' => ['description' => 'The name of the execution plan.', 'type' => 'string', 'example' => 'TestActionPlan', 'title' => '', 'required' => false],
],
[
'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'title' => '应用ID。',
- 'description' => 'The ID of the application.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ci-vm-rYfypJKwlN9Y',
- ],
+ 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'ci-vm-rYfypJKwlN9Y', 'title' => '', 'required' => false],
],
[
'name' => 'Script',
'in' => 'query',
- 'schema' => [
- 'title' => '运行作业脚本。需Base64编码。',
- 'description' => 'The running-job script. Base64 encoding is required.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==',
- ],
+ 'schema' => ['description' => 'The script to run the job. The script must be Base64-encoded.', 'type' => 'string', 'example' => 'bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==', 'title' => '', 'required' => false],
],
[
'name' => 'PrologScript',
'in' => 'query',
- 'schema' => [
- 'title' => '前处理脚本。需Base64编码。',
- 'description' => 'The pre-processing script. Base64 encoding is required.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==',
- ],
+ 'schema' => ['description' => 'The pre-execution script. The script must be Base64-encoded.', 'type' => 'string', 'example' => 'bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==', 'title' => '', 'required' => false],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
- 'title' => '执行目标资源类型:vCPU容量或者执行节点数。取值范围如下:'."\n"
+ 'description' => 'The type of resource for the execution target. The value can be the vCPU capacity or the number of executor nodes. Valid values:'."\n"
."\n"
- .'- VCpuCapacity:vCPU容量'."\n"
+ .'- VCpuCapacity: vCPU capacity'."\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",
+ .'- ExecutorCapacity: number of executor nodes',
'type' => 'string',
- 'required' => false,
'example' => 'VCpuCapacity',
- 'enum' => [
- 'VCpuCapacity',
- 'ExecutorCapacity',
- ],
+ 'enum' => ['VCpuCapacity', 'ExecutorCapacity'],
+ 'title' => '',
+ 'required' => false,
],
],
[
'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',
- ],
+ 'schema' => ['description' => 'The desired size of the resource for the execution plan. For example, if you set ResourceType to VcpuCapacity, this parameter specifies the number of vCPUs that you want to maintain for the execution plan.', 'type' => 'number', 'format' => 'double', 'example' => '1000', 'title' => '', 'required' => false],
],
[
'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",
+ 'title' => '',
+ 'description' => 'A list of resource configurations for the runtime environment of the execution plan. You can specify 1 to 10 resource configurations.',
'type' => 'array',
'items' => [
- 'title' => '执行计划运行环境的资源配置列表。资源配置支持 1 ~ 10个。',
- 'description' => 'The resource configuration of the execution plan runtime environment.'."\n",
+ 'title' => '',
+ 'description' => 'The resource configuration for the runtime environment of the execution plan.',
'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',
- ],
+ 'Cores' => ['description' => 'The number of vCPUs for the runtime environment.', 'type' => 'number', 'format' => 'double', 'example' => '2', 'title' => '', 'required' => false],
+ 'Memory' => ['description' => 'The memory size of the runtime environment. Unit: GiB.', 'type' => 'number', 'format' => 'double', 'example' => '4', 'title' => '', 'required' => false],
],
'required' => false,
+ 'example' => '',
],
'required' => false,
'example' => '1000',
@@ -230,158 +286,124 @@
'in' => 'query',
'style' => 'json',
'schema' => [
- 'title' => '执行计划运行环境的地域资源配置列表。',
- 'description' => 'The list of resource configurations in the region where the execution plan runs.'."\n",
+ 'title' => '',
+ 'description' => 'A list of regional resource configurations for the runtime environment of the execution plan.',
'type' => 'array',
'items' => [
- 'title' => '执行计划运行环境的地域资源配置列表。',
- 'description' => 'The resource configuration of the region in which the execution plan runs.'."\n",
+ 'title' => '',
+ 'description' => 'The regional resource configuration for the runtime environment of the execution plan.',
'type' => 'object',
'properties' => [
- 'RegionId' => [
- 'title' => '地域ID。',
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
- ],
+ 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => '', 'required' => false],
'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",
+ 'title' => '',
+ 'description' => 'A list of vSwitches that are available for the execution plan in the region. You can specify 0 to 5 vSwitches.',
'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****',
- ],
+ 'items' => ['description' => 'The vSwitch ID. You can call the [DescribeVSwitches](https://api.aliyun.com/document/Vpc/2016-04-28/DescribeVSwitches) operation to query information about available vSwitches.', 'type' => 'string', 'example' => 'vsw-8vb4m54nq1hwtxxda****', 'title' => '', 'required' => false],
'required' => false,
+ 'example' => '',
],
'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",
+ 'title' => '',
+ 'description' => 'A list of security groups that are available for the execution plan in the region. You can specify 0 to 5 security groups.',
'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****',
- ],
+ 'items' => ['description' => 'The security group ID. You can call the [DescribeSecurityGroups](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups) operation to query information about available security groups.', 'type' => 'string', 'example' => 'sg-2zeh9711f6c04bkr****', 'title' => '', 'required' => false],
'required' => false,
+ 'example' => '',
],
'SecurityGroupIds' => [
- 'title' => '交换机ID列表,您可以通过[DescribeSecurityGroups接口](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups)查询可用交换机信息。',
+ 'title' => '',
'type' => 'array',
- 'items' => [
- 'title' => '交换机ID,您可以通过[DescribeSecurityGroups接口](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups)查询可用交换机信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sg-uf6j4pp39x9k3x05c3vw',
- ],
+ 'items' => ['description' => 'The security group ID. You can call the [DescribeSecurityGroups](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups) operation to query information about available security groups.', 'type' => 'string', 'example' => 'sg-uf6j4pp39x9k3x05c3vw', 'title' => '', 'required' => false],
'required' => false,
+ 'description' => 'A list of security group IDs. You can call the [DescribeSecurityGroups](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups) operation to query information about available security groups.',
+ 'example' => '',
],
],
'required' => false,
+ 'example' => '',
],
'required' => false,
+ 'example' => '',
],
],
[
'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',
- ],
+ 'schema' => ['description' => 'The resource type.'."\n"
+ ."\n"
+ .'- Standard: Standard.'."\n"
+ ."\n"
+ .'- Dedicated: Dedicated. This type is available only to users in the whitelist.'."\n"
+ ."\n"
+ .'- Economic: Economy. This type is available only to users in the whitelist.', 'type' => 'string', 'example' => 'Standard', 'title' => '', 'required' => false],
],
[
'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',
- ],
+ 'schema' => ['description' => 'The computing power level. This parameter is valid only when you set AllocationSpec to Economic. The following types are supported:'."\n"
+ ."\n"
+ .'- General: General-purpose.'."\n"
+ ."\n"
+ .'- Performance: Compute-optimized.'."\n"
+ ."\n"
+ .'Default value: General', 'type' => 'string', 'example' => 'General', 'title' => '', 'required' => false],
],
[
'name' => 'IntervalMinutes',
'in' => 'query',
- 'schema' => [
- 'title' => '执行计划的定时周期。单位分钟,取值范围:10 ~ 10080,默认值60。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '60',
- ],
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '60', 'description' => '', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'The returned result.'."\n",
+ 'description' => 'The response.',
'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****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
+ 'ActionPlanId' => ['description' => 'The execution plan ID.', 'type' => 'string', 'example' => 'ap-hz036ubmx2qmw93k****', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
406 => [
- [
- 'errorCode' => 'QuotaExceeded.ActionPlan',
- 'errorMessage' => 'The number of action plans in the current account has exceeded quota.',
- ],
+ ['errorCode' => 'QuotaExceeded.ActionPlan', 'errorMessage' => 'The number of action plans in the current account has exceeded quota.', 'description' => 'The number of execution plans under the current account exceeds the limit of execution plans under the user account.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"ActionPlanId\\": \\"ap-hz036ubmx2qmw93k****\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'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',
+ 'description' => '**Before you call this operation, ensure that you understand the billing methods and&#x20;**[**pricing**](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)**&#x20;of E-HPC Instant.**',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-21T07:14:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateActionPlan'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ehpc:CreateActionPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"ActionPlanId\\": \\"ap-hz036ubmx2qmw93k****\\"\\n}","type":"json"}]',
+ ],
+ 'CreateJob' => [
+ 'summary' => 'Creates an E-HPC Instant job.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -390,63 +412,468 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'high',
+ 'operationType' => 'create',
+ 'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREehpc11IJC9',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '219052',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
],
'parameters' => [
[
- 'name' => 'ActionPlanId',
+ 'name' => 'JobName',
'in' => 'query',
+ 'schema' => ['description' => 'The name of the job. The name must be 2 to 64 characters in length. It can contain letters, digits, hyphens (-), and underscores (\\_).', 'type' => 'string', 'required' => true, 'example' => 'testjob', 'title' => ''],
+ ],
+ [
+ 'name' => 'JobDescription',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description of the job.', 'type' => 'string', 'required' => false, 'example' => 'Demo', 'title' => ''],
+ ],
+ [
+ 'name' => 'Tasks',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The ID of the execution plan.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ap-hz036ubmx2qmw93k****',
+ 'description' => 'The list of tasks. Currently, only one task is supported.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the task.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => ['description' => 'The name of the task. The name must be 2 to 32 characters in length. It can contain letters, digits, hyphens (-), and underscores (\\_).', 'type' => 'string', 'required' => false, 'example' => 'task0', 'title' => ''],
+ 'TaskSpec' => [
+ 'description' => 'The details of the task specifications.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskExecutor' => [
+ 'description' => 'The execution configuration for the task.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The execution configuration for the task.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Container' => [
+ 'description' => 'The container environment.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Image' => ['description' => 'The container image.', 'type' => 'string', 'required' => true, 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/ehpc/hpl:latest', 'title' => ''],
+ 'WorkingDir' => ['description' => 'The working directory of the container.', 'type' => 'string', 'required' => false, 'example' => '/usr/local/', 'title' => ''],
+ 'Command' => [
+ 'description' => 'The startup commands for the container. You can specify up to 20 commands. Each command can be up to 256 characters long.'."\n"
+ ."\n"
+ .'> 1. If a startup command contains spaces, such as `sleep 60s`, pass the JSON parameter as `["sleep", "60s"]`.'."\n"
+ .'>'."\n"
+ .'> 2. For complex startup commands, use a combination of `Command: ["/bin/bash"]` and `Arg:["-c", "<your_command>"]`. The `<your_command>` is a user-defined command string that can contain spaces and other characters.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The content of the container startup command. Each command can be up to 256 characters long.', 'type' => 'string', 'required' => false, 'example' => 'sleep', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'EnvironmentVars' => [
+ 'description' => 'The environment variables for the container. You can specify up to 20 variables.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The environment variables for the container.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => 'The name of the environment variable. The name must be 1 to 128 characters in length. It can contain letters, digits, and underscores (\\_). It cannot start with a digit.', 'type' => 'string', 'required' => false, 'example' => 'PATH', 'title' => ''],
+ 'Value' => ['description' => 'The value of the environment variable. The value can be up to 256 characters in length.', 'type' => 'string', 'required' => false, 'example' => '/usr/local/bin', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AppId' => ['description' => 'The ID of the containerized application.', 'type' => 'string', 'required' => false, 'example' => 'ci-vm-32k6LXAi3cOG', 'title' => ''],
+ 'ImageRegistryOptions' => ['description' => 'The custom options for the image registry. This parameter is a JSON string of key-value pairs.'."\n"
+ ."\n"
+ .'- Example: {"ImageRegistryType":"https","ImageRegistryServer":"xxx","ImageRegistryUserName":"xxx","ImageRegistryPassword":"xxx"}', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"ImageRegistryType":"https","ImageRegistryServer":"xxx","ImageRegistryUserName":"xxx","ImageRegistryPassword":"xxx"}'."\n"],
+ 'Arg' => [
+ 'description' => 'The arguments for the container startup command. You can specify up to 10 arguments.',
+ 'type' => 'array',
+ 'items' => ['description' => 'An argument for the container startup command.', 'type' => 'string', 'required' => false, 'example' => '60s', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'VM' => [
+ 'description' => 'The virtual machine (VM) environment.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Image' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => 'm-xxxx', 'title' => ''],
+ 'PrologScript' => ['description' => 'The pre-execution script. The script must be Base64-encoded.', 'type' => 'string', 'required' => false, 'example' => 'ZWNobyBoZWxsbyBlY3Mh', 'title' => ''],
+ 'Script' => ['description' => 'The job execution script. The script must be Base64-encoded.', 'type' => 'string', 'required' => false, 'example' => 'ZWNobyBoZWxsbyBlY3Mh', 'title' => ''],
+ 'AppId' => ['description' => 'The ID of the VM application.', 'type' => 'string', 'required' => false, 'example' => 'ci-vm-9jc58Pm5Leky', 'title' => ''],
+ 'Password' => ['description' => 'The logon password for the VM. The password must be 8 to 30 characters long. It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The supported special characters are:'."\n"
+ ."\n"
+ .'()\\`\\~!@#$%^&\\*-\\_+=|{}\\[]:;\'<>,.?/'."\n"
+ .'For Windows, the password cannot start with a forward slash (/).'."\n"
+ ."\n"
+ .'> If you specify the \\`Password\\` parameter, send the request over HTTPS to prevent password leaks.', 'type' => 'string', 'required' => false, 'example' => 'EHPC@1234', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'VolumeMount' => [
+ 'description' => 'The volumes to mount to the task. You can specify up to 10 volumes.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The volumes to mount to the task.',
+ 'type' => 'object',
+ 'properties' => [
+ 'MountPath' => ['description' => 'The directory in the task where the volume is mounted.'."\n"
+ ."\n"
+ .'> The content in the mount directory is overwritten by the volume content. Use this parameter with caution.', 'type' => 'string', 'required' => false, 'example' => '/mnt', 'title' => ''],
+ 'VolumeDriver' => ['description' => 'The type of the volume. Valid values:'."\n"
+ ."\n"
+ .'- alicloud/nas: Mounts a Network Attached Storage (NAS) file system.'."\n"
+ ."\n"
+ .'- alicloud/oss: Mounts an Object Storage Service (OSS) bucket.', 'type' => 'string', 'required' => false, 'example' => 'alicloud/nas', 'title' => ''],
+ 'MountOptions' => ['description' => 'The mount parameters for the volume. This parameter is a JSON string of key-value pairs.'."\n"
+ ."\n"
+ .'- Example 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\\`: The mount target address of the NAS file system. \\`path\\`: A subdirectory of the NAS path. The subdirectory must start with a forward slash (/) and must already exist. \\`vers\\`: The NFS protocol version. Version 3 is recommended. \\`options\\`: Custom mount parameters, in the format \\`xxx,xxx,xxx\\`.'."\n"
+ ."\n"
+ .'- Example for mounting an OSS bucket: {"bucket":"xxxxx", "url":"oss-cn-heyuan-internal.aliyuncs.com","path":"/data","akId":"xxxxx","akSecret":"xxxxx"}'."\n"
+ ."\n"
+ .'> \\`bucket\\`: The name of the OSS bucket. \\`url\\`: The endpoint of the OSS bucket. You can obtain the endpoint from the Overview page of the bucket in the OSS console. \\`path\\`: The directory structure relative to the root of the bucket. The default value is \\`/\\`. The directory must exist. \\`akId\\`: The AccessKey ID for direct authorization. \\`akSecret\\`: The AccessKey secret for direct authorization.', 'type' => 'string', 'required' => false, 'example' => '{"server":"xxxxx-xxxxx.cn-heyuan.nas.aliyuncs.com","vers":"3","path":"/data","options":"nolock,tcp,noresvport"}', 'title' => ''],
+ 'ReadOnly' => ['description' => 'Specifies whether the volume is read-only. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Resource' => [
+ 'description' => 'The resource information for the runtime environment.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Cores' => ['description' => 'The number of vCPUs for the runtime environment.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '2', 'title' => ''],
+ 'EnableHT' => ['description' => 'Specifies whether to enable hyper-threading for the runtime environment. The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ 'Memory' => ['description' => 'The memory size of the runtime environment, in GiB.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '4', 'title' => ''],
+ 'Disks' => [
+ 'description' => 'The cloud disks.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'An array of cloud disks.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The type of the cloud disk. Currently, only \\`System\\` is supported, which indicates the system disk.', 'type' => 'string', 'required' => false, 'example' => 'System', 'title' => ''],
+ 'Size' => ['description' => 'The size of the cloud disk, in GiB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'HostNamePrefix' => ['description' => 'The hostname prefix for the runtime environment. The prefix has the following limits:'."\n"
+ ."\n"
+ .'- It cannot start or end with a period (.) or a hyphen (-). It cannot contain consecutive periods or hyphens.'."\n"
+ ."\n"
+ .'- For Windows: The prefix can be up to 10 characters long. It cannot contain periods or consist of only digits. It can contain uppercase letters, lowercase letters, digits, and hyphens (-).'."\n"
+ ."\n"
+ .'- For Linux: The prefix can be up to 32 characters long. It can contain multiple periods (.). Each segment separated by a period can contain uppercase letters, lowercase letters, digits, and hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'compute', 'title' => ''],
+ 'InstanceTypes' => [
+ 'description' => 'The instance types for the runtime environment. You can specify up to five instance types.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The instance type for the runtime environment.'."\n"
+ ."\n"
+ .'> This parameter is valid only when \\`DeploymentPolicy.AllocationSpec\\` is set to \\`Standard\\`.', 'type' => 'string', 'required' => false, 'example' => 'ecs.c7a.8xlarge', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'RetryPolicy' => [
+ 'description' => 'The retry policy for the task.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RetryCount' => ['description' => 'The number of retries. Valid values: 1 to 10. The default value is 3.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''],
+ 'ExitCodeActions' => [
+ 'description' => 'The retry rules. You can specify up to 10 rules.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A retry rule.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExitCode' => ['description' => 'The exit code of the task. This parameter works with \\`Action\\` to define a job retry rule. Valid values: 0 to 255.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''],
+ 'Action' => ['description' => 'The action to take when the task exits with the specified \\`ExitCode\\`.'."\n"
+ ."\n"
+ .'- Retry: The job starts a new retry.'."\n"
+ ."\n"
+ .'- Exit: The job exits.', 'type' => 'string', 'required' => true, 'example' => 'Retry', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ExecutorPolicy' => [
+ 'description' => 'The execution policy for the task.',
+ 'type' => 'object',
+ 'properties' => [
+ 'MaxCount' => ['description' => 'The maximum number of nodes for job execution.'."\n"
+ ."\n"
+ .'> The value must follow this formula: `MaxCount = (IndexEnd - IndexStart) / IndexStep + 1`', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ 'ArraySpec' => [
+ 'description' => 'The details for an array job. The subjob index value is passed to the runtime environment as an environment variable that your application can reference.'."\n"
+ ."\n"
+ .'- EHPC\\_JOB\\_NAME: The job name. This matches the JobName parameter.'."\n"
+ ."\n"
+ .'- EHPC\\_JOB\\_ID: The job ID.'."\n"
+ ."\n"
+ .'- EHPC\\_TASK\\_NAME: The task name. This matches the TaskName parameter.'."\n"
+ ."\n"
+ .'- EHPC\\_EXECUTOR\\_ID: The executor ID.'."\n"
+ ."\n"
+ .'- EHPC\\_ARRAY\\_TASK\\_ID: The subjob index value.'."\n"
+ ."\n"
+ .'- EHPC\\_ARRAY\\_TASK\\_COUNT: The total number of subjobs.'."\n"
+ ."\n"
+ .'- EHPC\\_ARRAY\\_TASK\\_MAX: The maximum subjob index. This matches the IndexStart parameter.'."\n"
+ ."\n"
+ .'- EHPC\\_ARRAY\\_TASK\\_MIN: The minimum subjob index. This matches the IndexEnd parameter.'."\n"
+ ."\n"
+ .'- EHPC\\_ARRAY\\_TASK\\_STEP: The subjob index step size. This matches the IndexStep parameter.',
+ 'type' => 'object',
+ 'properties' => [
+ 'IndexStart' => ['description' => 'The start index for the array job. Valid values: 0 to 4999.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
+ 'IndexEnd' => ['description' => 'The end index for the array job. Valid values: 0 to 4999. The value must be greater than or equal to \\`IndexStart\\`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9', 'title' => ''],
+ 'IndexStep' => ['description' => 'The step size for the array job index.'."\n"
+ ."\n"
+ .'> For example, if an array job has \\`IndexStart\\`=1, \\`IndexEnd\\`=5, and \\`IndexStep\\`=2, the job contains three subjobs with index values of 1, 3, and 5. Your application can access these values through environment variables.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TaskSustainable' => [
+ 'description' => 'Specifies whether the job is a long-running job.'."\n"
+ ."\n"
+ .'- true: The job is a background service job.'."\n"
+ ."\n"
+ .'- false: The job is a batch job.'."\n"
+ ."\n"
+ .'The default value is false.',
+ 'enumValueTitles' => ['false' => 'false', 'true' => 'true'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'title' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'minItems' => 1,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'DesiredCapacity',
+ 'name' => 'DeploymentPolicy',
'in' => 'query',
+ 'style' => 'json',
'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',
+ 'description' => 'The resource deployment policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'AllocationSpec' => ['description' => 'The type of resource.'."\n"
+ ."\n"
+ .'- Standard: Standard resources.'."\n"
+ ."\n"
+ .'- Dedicated: Dedicated resources. This option requires you to be on the whitelist.'."\n"
+ ."\n"
+ .'- Economy: Economy resources. This option requires you to be on the whitelist.', 'type' => 'string', 'required' => false, 'example' => 'Dedicated', 'title' => ''],
+ 'Network' => [
+ 'description' => 'The network configuration.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Vswitch' => [
+ 'description' => 'The vSwitches.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxxx', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'EnableExternalIpAddress' => [
+ 'description' => 'Specifies whether to create a public IP address for the job.'."\n"
+ ."\n"
+ .'- true: Creates a public IP address.'."\n"
+ ."\n"
+ .'- false: Does not create a public IP address.'."\n"
+ ."\n"
+ .'The default value is false.',
+ 'enumValueTitles' => ['false' => 'false', 'true' => 'true'],
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'title' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Tag' => [
+ 'description' => 'The tags for the job. You can specify up to 20 tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A tag for the job.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => 'The key of the job tag. The key cannot be an empty string. It can be up to 128 characters in length. It cannot start with \\`aliyun\\` or \\`acs:\\`, and cannot contain \\`http\\://\\` or \\`https\\://\\`.', 'type' => 'string', 'required' => true, 'example' => 'TestKey', 'title' => ''],
+ 'Value' => ['description' => 'The value of the job tag. The value can be an empty string. It can be up to 128 characters in length. It cannot contain \\`http\\://\\` or \\`https\\://\\`.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Pool' => ['description' => 'The resource pool for the job.', 'type' => 'string', 'required' => false, 'example' => 'compute', 'title' => ''],
+ 'Priority' => ['description' => 'The priority of the job. A larger value indicates a higher scheduling priority. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ 'Level' => ['description' => 'The computing power level. This parameter is valid only when \\`AllocationSpec\\` is set to \\`Economy\\`. Valid values:'."\n"
+ ."\n"
+ .'- General: General-purpose.'."\n"
+ ."\n"
+ .'- Performance: Compute-optimized.'."\n"
+ ."\n"
+ .'The default value is \\`General\\`.', 'type' => 'string', 'required' => false, 'example' => 'General', 'title' => ''],
+ ],
'required' => false,
- 'example' => '1000',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'Enabled',
+ 'name' => 'SecurityPolicy',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'Whether to enable the execution plan. Valid values:'."\n"
+ 'description' => 'The job scheduler type.'."\n"
."\n"
- .'* true: enables the execution plan.'."\n"
+ .'- HPC'."\n"
."\n"
- .'* false: The execution plan is disabled.'."\n"
+ .'- K8S'."\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',
+ .'Default value: HPC',
+ 'type' => 'object',
+ 'properties' => [
+ 'SecurityGroup' => [
+ 'description' => 'The ID of the security group.',
+ 'type' => 'object',
+ 'properties' => [
+ 'SecurityGroupIds' => [
+ 'description' => 'The IDs of the security groups.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the security group.', 'type' => 'string', 'required' => false, 'example' => 'sg-xxxxxxxxxxxxxxx', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
'required' => false,
- 'example' => 'true',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'IntervalMinutes',
+ 'name' => 'DependencyPolicy',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '执行计划的定时周期。单位分钟,取值范围:10 ~ 10080,默认值60。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '60',
+ 'description' => 'The security policy.',
+ 'type' => 'object',
+ 'properties' => [
+ 'JobDependency' => [
+ 'description' => 'The job dependencies. You can specify a maximum of 10 dependencies.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A job dependency.',
+ 'type' => 'object',
+ 'properties' => [
+ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'example' => 'job-bjxxxxxxxxxxxx', 'title' => ''],
+ 'Type' => [
+ 'description' => 'The type of dependency. Valid values: \\`AfterSucceeded\\`: The current job runs after all subtasks of the dependent job or array job succeed (exit code 0). \\`AfterFailed\\`: The current job runs after all subtasks of the dependent job or array job fail (exit code is not 0). \\`AfterAny\\`: The current job runs after the dependent job completes, regardless of success or failure. \\`AfterCorresponding\\`: The current job runs after the corresponding subtask of the dependent array job succeeds (exit code 0). The default value is \\`AfterSucceeded\\`.',
+ 'type' => 'string',
+ 'enum' => ['AfterSucceeded', 'AfterFailed', 'AfterAny', 'AfterCorresponding'],
+ 'required' => false,
+ 'example' => 'AfterSucceeded',
+ 'title' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -454,222 +881,230 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n",
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
+ 'JobId' => ['description' => 'The ID of the job.', 'type' => 'string', 'example' => 'job-xxxx', 'title' => ''],
+ 'Tasks' => [
+ 'description' => 'The list of tasks.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of the tasks.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'task0', 'title' => ''],
+ 'ExecutorIds' => [
+ 'description' => 'The list of executor IDs in the task.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the executor. The format is \\`JobId-TaskName-ArrayIndex\\`.', 'type' => 'string', 'example' => '[\\"job-xxxx-task0_11-2\\"]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'NotExisted.ActionPlan',
- 'errorMessage' => 'The specified action plan does not exist.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'InDebt', 'errorMessage' => 'Your account has overdue payments.', 'description' => 'Your account has overdue payments.'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => 'You have not enabled this service'],
],
403 => [
- [
- 'errorCode' => 'InvalidStatus.ActionPlan',
- 'errorMessage' => 'The current status of the execution plan does not support this operation. Please try again later.',
- ],
+ ['errorCode' => 'GetResourceFailed', 'errorMessage' => 'Failed to get resource.', 'description' => 'Failed to get resource'],
+ ['errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', 'errorMessage' => 'The resource is out of stock.', 'description' => 'Resources are sold out'],
+ ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Duplicate tag key exists: %s.', 'description' => 'Duplicate tag key exists.'],
+ ['errorCode' => 'PoolNotFound', 'errorMessage' => 'The specified pool was not found.', 'description' => 'Resource pool does not exist'],
+ ['errorCode' => 'PoolStatusInvalid', 'errorMessage' => 'The specified pool in invalid status.', 'description' => 'Invalid Resource Pool Status'],
+ ['errorCode' => 'QuotaExceeded.PrivateIpAddress', 'errorMessage' => 'Insufficient private IP addresses in vSwitch: %s.', 'description' => ''],
+ ['errorCode' => 'SecurityGroupInstanceLimitExceed', 'errorMessage' => 'The maximum number of instances in a security group is exceeded.', 'description' => 'The number of instances in the security group has reached the maximum limit.'],
+ ['errorCode' => 'QuotaExceeded.Resource', 'errorMessage' => 'Insufficient resource quota.', 'description' => 'Insufficient resource quota'],
+ ],
+ [
+ ['errorCode' => 'ImageNotFound', 'errorMessage' => 'The specified image does not exist.', 'description' => 'The specified image does not exist. Please verify the parameter.'],
+ ['errorCode' => 'SecurityGroupNotExists', 'errorMessage' => 'The security group does not exist.', 'description' => 'The security group does not exist.'],
+ ],
+ 406 => [
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-28T08:25:28.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-08-04T08:47:34.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2025-07-29T07:28:12.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-06-12T04:36:05.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-03-13T06:52:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-02-20T02:20:01.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2024-12-30T12:12:13.000Z', 'description' => 'Error codes changed, Request parameters changed'],
+ ['createdAt' => '2024-12-19T08:46:25.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2024-11-11T05:46:39.000Z', 'description' => 'Error codes changed, Request parameters changed'],
+ ['createdAt' => '2024-09-18T13:48:53.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-05-14T06:28:55.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-05-11T08:41:48.000Z', 'description' => 'Error codes changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateJob'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ehpc:CreateJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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',
- ],
+ 'CreatePool' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREehpc11IJC9',
- ],
+ 'abilityTreeCode' => '248937',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ActionPlanIds',
+ 'name' => 'PoolName',
'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,
- ],
+ 'schema' => ['description' => 'The name of the pool.'."\n"
+ ."\n"
+ .'- The name can be up to 15 characters long.'."\n"
+ ."\n"
+ .'- The name can contain digits, uppercase and lowercase letters, underscores (\\_), and periods (.).', 'type' => 'string', 'required' => true, 'maxLength' => 32, 'example' => 'PoolTest', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'Priority',
'in' => 'query',
- 'schema' => [
- 'description' => 'A pagination token.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1d2db86scXXXXXXXXXX',
- ],
+ 'schema' => ['description' => 'The priority of the pool.'."\n"
+ ."\n"
+ .'- Valid values: 1 to 99. The default value is 1, which indicates the lowest priority.'."\n"
+ ."\n"
+ .'- Jobs in higher-priority pools are scheduled before pending jobs in lower-priority pools. The pool\'s priority overrides an individual job\'s priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'ResourceLimits',
'in' => 'query',
+ 'style' => 'json',
'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',
+ 'description' => 'The limits on the resources that a single user can use concurrently in the pool.',
+ 'type' => 'object',
+ 'properties' => [
+ 'MaxExecutorNum' => ['description' => 'The maximum number of executor nodes a user can run concurrently in a pool.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
+ ],
'required' => false,
- 'example' => '20',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'SchedulingPolicyId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'example' => 'policy-xxx', 'title' => '', 'description' => '', 'required' => false],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The response data.',
'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",
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'NotExisted.ActionPlan',
- 'errorMessage' => 'The specified action plan does not exist.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'InDebt', 'errorMessage' => 'Your account has overdue payments.', 'description' => 'Your account has overdue payments.'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => 'You have not enabled this service'],
+ ['errorCode' => 'PoolAlreadyExists', 'errorMessage' => 'The pool already exists.', 'description' => 'Pool already exists'],
+ ],
+ 403 => [
+ ['errorCode' => 'GetResourceFailed', 'errorMessage' => 'Failed to get resource.', 'description' => 'Failed to get resource'],
+ ['errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', 'errorMessage' => 'The resource is out of stock.', 'description' => 'Resources are sold out'],
+ ],
+ 406 => [
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
+ ],
+ 503 => [
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'The request has failed due to a temporary failure of the server.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'title' => 'CreatePool',
+ 'summary' => 'Creates a pool.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePool'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ehpc:CreatePool',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
],
- 'ListActionPlanActivities' => [
- 'summary' => 'Queries the execution status of an execution plan.',
+ 'DeleteActionPlan' => [
+ 'summary' => 'Delete an execution plan',
'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREehpc11IJC9',
- ],
+ 'operationType' => 'delete',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREehpc11IJC9'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -677,36 +1112,86 @@
[
'name' => 'ActionPlanId',
'in' => 'query',
+ 'schema' => ['description' => 'The ID of the execution plan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ap-hz036ubmx2qmw93k****', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The ID of the execution plan.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ap-hz036ubmx2qmw93k****',
+ '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"],
+ ],
+ 'example' => '',
],
],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'A pagination token.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1d2db86scXXXXXXXXXX',
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'NotExisted.ActionPlan', 'errorMessage' => 'The specified action plan does not exist.', 'description' => 'The specified execution 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.', 'description' => 'The current status of the execution plan does not support this operation. Please try again later.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ '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",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ehpc:DeleteActionPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteJobRecords' => [
+ 'summary' => 'Deletes one or more job records that are in the final state from a specified cluster.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'MaxResults',
+ '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 maximum number of entries per page.'."\n"
- ."\n"
- .'Valid values: 1 to 100.'."\n"
+ 'description' => 'The list of job IDs.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The ID of the job whose records are to be deleted.'."\n"
."\n"
- .'Default value: 20.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
+ .'You can call the ListJobs operation to query job IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'job-xxx', 'title' => ''],
'required' => false,
- 'example' => '100',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -717,135 +1202,49 @@
'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',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'NotExisted.ActionPlan',
- 'errorMessage' => 'The specified action plan does not exist.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job id is not found.', 'description' => 'Job ID not found'],
+ ],
+ 406 => [
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
+ ],
+ 503 => [
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'The request has failed due to a temporary failure of the server.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DeleteJobRecords',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ehpc:DeleteJobRecords',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
],
- 'GetActionPlan' => [
- 'summary' => 'Querying Execution Plan Details',
- 'path' => '',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteJobs' => [
+ 'summary' => 'Deletes one or more jobs from a specified cluster.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -857,24 +1256,81 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREehpc11IJC9',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'abilityTreeCode' => '219051',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q'],
],
'parameters' => [
[
- 'name' => 'ActionPlanId',
+ 'name' => 'JobSpec',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '执行计划 ID。',
- 'description' => 'The ID of the execution plan.'."\n",
- 'type' => 'string',
+ '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", 'title' => ''],
+ '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', 'title' => ''],
+ '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', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => false,
- 'example' => 'ap-hz036ubmx2qmw93k****',
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ '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", 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ [
+ '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', 'title' => ''],
+ ],
],
'responses' => [
200 => [
@@ -883,202 +1339,51 @@
'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',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'NotExisted.ActionPlan',
- 'errorMessage' => 'The specified action plan does not exist.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job id is not found.', 'description' => 'Job ID not found'],
+ ],
+ 406 => [
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
+ ],
+ 503 => [
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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 \\"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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteJobs',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteJobs'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:DeleteJobs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeletePool' => [
+ 'summary' => 'You can execute this statement to delete a resource pool.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1088,24 +1393,21 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
- 'riskType' => 'high',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREehpc11IJC9',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '249322',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ActionPlanId',
+ 'name' => 'PoolName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the execution plan.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ap-hz036ubmx2qmw93k****',
- ],
+ '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', 'title' => ''],
],
],
'responses' => [
@@ -1115,192 +1417,103 @@
'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",
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'NotExisted.ActionPlan',
- 'errorMessage' => 'The specified action plan does not exist.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'InDebt', 'errorMessage' => 'Your account has overdue payments.', 'description' => 'Your account has overdue payments.'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => 'You have not enabled this service'],
],
403 => [
- [
- 'errorCode' => 'InvalidStatus.ActionPlan',
- 'errorMessage' => 'The current status of the execution plan does not support this operation. Please try again later.',
- ],
+ ['errorCode' => 'GetResourceFailed', 'errorMessage' => 'Failed to get resource.', 'description' => 'Failed to get resource'],
+ ['errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', 'errorMessage' => 'The resource is out of stock.', 'description' => 'Resources are sold out'],
+ ['errorCode' => 'PoolNotFound', 'errorMessage' => 'The specified pool was not found.', 'description' => 'Resource pool does not exist'],
+ ['errorCode' => 'PoolStatusInvalid', 'errorMessage' => 'The specified pool in invalid status.', 'description' => 'Invalid Resource Pool Status'],
+ ['errorCode' => 'PoolInUse', 'errorMessage' => 'The specified pool is in use.', 'description' => 'Resource pool is in use.'],
+ ],
+ 406 => [
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
+ ],
+ 503 => [
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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' => '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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
+ 'title' => 'DeletePool',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePool'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ehpc:DeletePool',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ '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' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219054',
- 'abilityTreeNodes' => [
- 'FEATUREehpcE21063',
- ],
+ 'abilityTreeCode' => '219038',
+ 'abilityTreeNodes' => ['FEATUREehpcR6Y931'],
],
'parameters' => [
[
- 'name' => 'ImageType',
+ 'name' => 'JobId',
'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',
- ],
+ 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-xxxxx'."\n", 'title' => ''],
],
[
- 'name' => 'Name',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the custom image.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'app-image'."\n",
- ],
- ],
- [
- 'name' => 'ImageVersion',
+ 'name' => 'TaskName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The version of the image.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'V1.0',
- ],
+ 'schema' => ['description' => 'The name of the task.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Task0'."\n", 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'MetricName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The description of the image.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Test image'."\n",
- ],
+ 'schema' => ['description' => 'The metrics of the job.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cpu_utilization'."\n", 'title' => ''],
],
[
- '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',
+ 'name' => 'ArrayIndex',
'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,
+ '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', 'title' => ''],
+ 'required' => true,
+ 'docRequired' => true,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -1311,101 +1524,53 @@
'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",
- ],
+ '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', 'title' => ''],
+ 'DataPoints' => ['description' => 'Monitoring statistics points.'."\n", 'type' => 'string', 'example' => '[{"timestamp":1709540685000,"Minimum":28.45,"Maximum":28.45,"Average":28.45}]'."\n", 'title' => ''],
],
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job id is not found.', 'description' => 'Job ID not found'],
],
- 403 => [
- [
- 'errorCode' => 'ImageInUse',
- 'errorMessage' => 'Image is still used by jobs.',
- ],
+ 406 => [
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
- [
- [
- 'errorCode' => 'ImageNotFound',
- 'errorMessage' => 'The specified image does not exist.',
- ],
+ 503 => [
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'The request has failed due to a temporary failure of the server.'],
],
- 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.',
- ],
+ ],
+ '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',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeJobMetricData'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'NotAuthorized',
- 'errorMessage' => 'No authorization is granted.',
- ],
- ],
- 503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:DescribeJobMetricData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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',
- ],
+ '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' => [],
@@ -1414,65 +1579,35 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219057',
- 'abilityTreeNodes' => [
- 'FEATUREehpcEZT3HW',
- 'FEATUREehpcE21063',
- ],
+ 'abilityTreeCode' => '219041',
+ 'abilityTreeNodes' => ['FEATUREehpcR6Y931'],
],
'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',
+ 'name' => 'JobId',
'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',
- ],
+ 'schema' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-xxxxx'."\n", 'title' => ''],
],
[
- 'name' => 'ImageId',
+ 'name' => 'TaskName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The image ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'm-2ze74g5mvy4pjg*****',
- ],
+ 'schema' => ['description' => 'The name of the task.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Task0', 'title' => ''],
],
[
- 'name' => 'AdditionalRegionIds',
+ 'name' => 'ArrayIndex',
'in' => 'query',
'style' => 'json',
'schema' => [
+ 'description' => 'The list of array job indexes.'."\n",
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'required' => false,
+ 'items' => ['description' => 'The index of the array job.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''],
+ 'required' => true,
+ 'docRequired' => true,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -1483,251 +1618,67 @@
'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',
- ],
- ],
- ],
+ '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', 'title' => ''],
+ '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", 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job id is not found.', 'description' => 'Job ID not found'],
],
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.',
- ],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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',
+ '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',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeJobMetricLast'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:DescribeJobMetricLast',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DescribeJobResults' => [
+ 'summary' => 'Retrieves the logs for a job.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1739,431 +1690,229 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219055',
- 'abilityTreeNodes' => [
- 'FEATUREehpcEZT3HW',
- 'FEATUREehpcE21063',
- ],
+ 'abilityTreeCode' => '223066',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q'],
],
'parameters' => [
[
- 'name' => 'PageNumber',
+ 'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of the page to return.\\'."\n"
- .'Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => 'job-xxxxxxx', 'title' => ''],
],
[
- 'name' => 'PageSize',
+ 'name' => 'TaskName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of pieces per page.\\'."\n"
- .'Default value: 20.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => 'Task0', 'title' => ''],
],
[
- 'name' => 'ImageCategory',
+ 'name' => 'ArrayIndex',
'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',
- ],
+ 'schema' => ['description' => 'The executor number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0_1', 'title' => ''],
],
[
- 'name' => 'ImageType',
+ 'name' => 'ContentEncoding',
'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',
- ],
+ 'schema' => ['description' => 'The encoding format for the `CommandContent` and `Output` fields in the response. Valid values:'."\n"
+ ."\n"
+ .'- PlainText: Returns the original script content and output.'."\n"
+ ."\n"
+ .'- Base64: Returns the Base64-encoded script content and output.'."\n"
+ ."\n"
+ .'The default value is Base64.', 'type' => 'string', 'required' => false, 'example' => 'PlainText', 'title' => ''],
],
[
- 'name' => 'ImageIds',
+ 'name' => 'LimitBytes',
'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,
- ],
+ 'schema' => ['description' => 'The maximum size of the log in bytes. The value must be between 1 and 1,048,576 (1 MB).', 'type' => 'string', 'required' => false, 'example' => '1048576', 'title' => ''],
],
[
- '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',
+ 'name' => 'StartTime',
'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',
- ],
+ 'schema' => ['description' => 'The time in UTC, formatted according to RFC 3339.', 'type' => 'string', 'required' => false, 'example' => '2024-09-02T16:00:00Z', 'title' => ''],
],
],
'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',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'BABC742E-04D7-5BA5-8A5F-7D9461D37B19'],
+ 'Output' => ['description' => 'The output of the command. If ContentEncoding is set to PlainText, the original output is returned. If ContentEncoding is set to Base64, the Base64-encoded output is returned.', 'type' => 'string', 'example' => 'MTU6MzA6MDEK', 'title' => ''],
+ 'ExitCode' => ['description' => 'The exit code of the command.'."\n"
+ ."\n"
+ .'- For Linux instances, this is the exit code of the shell command.'."\n"
+ ."\n"
+ .'- For Windows instances, this is the exit code of the batch or PowerShell command.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'Schema of Response',
+ 'example' => '',
],
],
],
'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' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job id is not found.', 'description' => 'Job ID not found'],
],
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.',
- ],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'DescribeJobResults',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BABC742E-04D7-5BA5-8A5F-7D9461D37B19\\",\\n \\"Output\\": \\"MTU6MzA6MDEK\\",\\n \\"ExitCode\\": 0\\n}","type":"json"}]',
+ ],
+ 'GetActionPlan' => [
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219056',
- 'abilityTreeNodes' => [
- 'FEATUREehpcE21063',
- ],
+ 'abilityTreeNodes' => ['FEATUREehpc11IJC9'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'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',
+ 'name' => 'ActionPlanId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The image ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'm-bp14wakr1rkxtb******',
- ],
+ 'schema' => ['description' => 'ID of the execution plan.', 'type' => 'string', 'example' => 'ap-hz036ubmx2qmw93k****', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request.', 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
+ 'ActionPlanId' => ['description' => 'ID of the execution plan.', 'type' => 'string', 'example' => 'ap-hz036ubmx2qmw93k****', 'title' => ''],
+ 'ActionPlanName' => ['description' => 'Name of the execution plan.', 'type' => 'string', 'example' => 'TestActionPlan', 'title' => ''],
+ 'CreateTime' => ['description' => 'Time when the execution plan was created.', 'type' => 'string', 'example' => '2025-08-10 18:28:05', 'title' => ''],
+ 'UpdateTime' => ['description' => 'Last time the execution plan was modified.', 'type' => 'string', 'example' => '2025-08-10 18:28:05'."\n", 'title' => ''],
+ 'AppId' => ['description' => 'ID of the application.', 'type' => 'string', 'example' => 'ci-vm-rYfypJKwlN9Y', 'title' => ''],
+ 'PrologScript' => ['description' => 'Prologue script. Must be Base64-encoded.', 'type' => 'string', 'example' => 'bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==', 'title' => ''],
+ 'ResourceType' => ['description' => 'Type of target resource for the execution plan. Valid values are:'."\n"
+ ."\n"
+ .'- VCpuCapacity: vCPU capacity'."\n"
+ ."\n"
+ .'- ExecutorCapacity: number of executor nodes', 'type' => 'string', 'example' => 'VCpuCapacity', 'title' => ''],
+ 'DesiredCapacity' => ['description' => 'Target resource size for the execution plan. If ResourceType is VCpuCapacity, this value represents the target vCPU count.', 'type' => 'number', 'format' => 'float', 'example' => '1000', 'title' => ''],
+ 'TotalCapacity' => ['description' => 'Current resource size managed by the execution plan.', 'type' => 'number', 'format' => 'float', 'example' => '1000', 'title' => ''],
+ 'Status' => ['description' => 'Status of the execution plan. Valid values are:'."\n"
+ ."\n"
+ .'- Active: The execution plan is active and dynamically manages Instant jobs.'."\n"
+ ."\n"
+ .'- Inactive: The execution plan is inactive and no longer manages Instant jobs.'."\n"
+ ."\n"
+ .'- Deleting: The execution plan is being deleted. You cannot modify parameters during this state.', 'type' => 'string', 'example' => 'Active', 'title' => ''],
+ 'Resources' => [
+ 'title' => '',
+ 'description' => 'List of resource configurations for the execution plan\'s runtime environment.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'Resource configuration for the execution plan\'s runtime environment.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Cores' => ['description' => 'Number of CPUs in the runtime environment.', 'type' => 'number', 'format' => 'float', 'example' => '64', 'title' => ''],
+ 'Memory' => ['description' => 'Memory size in the runtime environment, in GiB.', 'type' => 'number', 'format' => 'float', 'example' => '128', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
- 'Success' => [
- 'description' => 'Indicates whether the request was successful. Valid values:'."\n"
- ."\n"
- .'* true'."\n"
- .'* false'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Regions' => [
+ 'title' => '',
+ 'description' => 'List of region-specific resource configurations for the execution plan\'s runtime environment.',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => 'Region-specific resource configuration for the execution plan\'s runtime environment.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionId' => ['description' => 'ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ 'VSwitchIds' => [
+ 'title' => '',
+ 'description' => 'List of vSwitches available to the execution plan in this region.',
+ 'type' => 'array',
+ 'items' => ['description' => 'ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-bp14v5eikr8wrgoqje7hr', 'title' => ''],
+ 'example' => '',
+ ],
+ 'SecurityGroupIds' => [
+ 'title' => '',
+ 'description' => 'List of security groups available to the execution plan in this region.',
+ 'type' => 'array',
+ 'items' => ['description' => 'vSwitch ID.', 'type' => 'string', 'example' => 'sg-uf6j4pp39x9k3x05c3vw', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'AllocationSpec' => ['description' => 'Resource type.', 'type' => 'string', 'example' => 'Standard', 'title' => ''],
+ 'Level' => ['description' => 'Computing power level.', 'type' => 'string', 'example' => 'General', 'title' => ''],
+ 'IntervalMinutes' => ['type' => 'integer', 'format' => 'int32', 'example' => '60', 'description' => '', 'title' => ''],
],
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'NotExisted.ActionPlan', 'errorMessage' => 'The specified action plan does not exist.', 'description' => 'The specified execution plan does not exist.'],
],
- 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.',
- ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetActionPlan',
+ 'summary' => 'Queries the details of an execution plan.',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-21T07:14:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetActionPlan'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'NotAuthorized',
- 'errorMessage' => 'No authorization is granted.',
- ],
- ],
- 503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetActionPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'RemoveImage',
+ '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"}]',
],
'GetAppVersions' => [
'summary' => 'Obtains the application version list.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2176,10 +1925,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '255311',
- 'abilityTreeNodes' => [
- 'FEATUREehpcEZT3HW',
- 'FEATUREehpcE21063',
- ],
+ 'abilityTreeNodes' => ['FEATUREehpcEZT3HW', 'FEATUREehpcE21063'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -2187,24 +1933,12 @@
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number. Default value: 1.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'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',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'ImageCategory',
@@ -2217,11 +1951,9 @@
.'Custom: the custom image that you added.'."\n",
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'Custom' => 'Custom',
- 'Public' => 'Public',
- ],
+ 'enumValueTitles' => ['Custom' => 'Custom', 'Public' => 'Public'],
'example' => 'Public',
+ 'title' => '',
],
],
[
@@ -2235,22 +1967,15 @@
.'Container: container image'."\n",
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'Container' => 'Container',
- 'VM' => 'VM',
- ],
+ 'enumValueTitles' => ['Container' => 'Container', 'VM' => 'VM'],
'example' => 'VM',
+ 'title' => '',
],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The application name.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'V-Ray',
- ],
+ 'schema' => ['description' => 'The application name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'V-Ray', 'title' => ''],
],
],
'responses' => [
@@ -2260,12 +1985,7 @@
'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",
- ],
+ '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"
@@ -2273,33 +1993,13 @@
."\n"
.'false'."\n",
'type' => 'boolean',
- 'enumValueTitles' => [
- 'true' => 'true',
- 'false' => 'false',
- ],
+ 'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'example' => 'true',
+ 'title' => '',
],
- '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',
- ],
+ 'TotalCount' => ['title' => '', '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",
@@ -2308,951 +2008,276 @@
'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****',
- ],
+ 'Name' => ['description' => 'The application name.'."\n", 'type' => 'string', 'example' => 'V-Ray', 'title' => ''],
+ 'Version' => ['description' => 'The application version.'."\n", 'type' => 'string', 'example' => 'v1.0', 'title' => ''],
+ 'ImageId' => ['description' => 'The image ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'm-f8z0dfa96luomqly****', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'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' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'InDebt', 'errorMessage' => 'Your account has overdue payments.', 'description' => 'Your account has overdue payments.'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => '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' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
[
- [
- 'errorCode' => 'NotAuthorized',
- 'errorMessage' => 'No authorization is granted.',
- ],
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'No authorization is granted.', 'description' => 'No authorization is granted.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAppVersions'],
],
],
- 'parameters' => [
- [
- 'name' => 'AppId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The application ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ci-vm-rYfypJKwlN9Y',
- ],
- ],
+ 'ramActions' => [
[
- '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****',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetAppVersions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- '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',
- ],
+ 'GetImage' => [
+ 'summary' => 'Get image details.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '219052',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '219057',
+ 'abilityTreeNodes' => ['FEATUREehpcEZT3HW', 'FEATUREehpcE21063'],
],
'parameters' => [
[
- 'name' => 'JobName',
+ 'name' => 'ImageCategory',
'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',
- ],
+ 'schema' => ['description' => 'Image source. Valid values:'."\n"
+ ."\n"
+ .'- Public: public images provided by Alibaba Cloud.'."\n"
+ ."\n"
+ .'- Custom: custom images that you added.', 'type' => 'string', 'required' => false, 'example' => 'Custom', 'title' => ''],
],
[
- 'name' => 'JobDescription',
+ 'name' => 'ImageType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The description of the job.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Demo',
- ],
+ 'schema' => ['description' => 'Image type. Valid values:'."\n"
+ ."\n"
+ .'- VM: virtual machine image.'."\n"
+ ."\n"
+ .'- Container: container image.'."\n"
+ ."\n"
+ .'Default value: VM', 'type' => 'string', 'required' => false, 'example' => 'VM', 'title' => ''],
],
[
- 'name' => 'Tasks',
+ 'name' => 'ImageId',
'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,
- ],
+ 'schema' => ['description' => 'Image ID.', 'type' => 'string', 'required' => false, 'example' => 'm-2ze74g5mvy4pjg*****', 'title' => ''],
],
[
- 'name' => 'DeploymentPolicy',
+ 'name' => 'AdditionalRegionIds',
'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',
- ],
- ],
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- [
- 'name' => 'SecurityPolicy',
- 'in' => 'query',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => 'The security policy.'."\n",
+ 'title' => 'Schema of Response',
+ 'description' => 'Response schema',
'type' => 'object',
'properties' => [
- 'SecurityGroup' => [
- 'description' => 'The security group ID.'."\n",
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n"],
+ 'Success' => ['description' => 'Indicates whether the operation succeeded. Valid values:'."\n"
+ ."\n"
+ .'- true: succeeded.'."\n"
+ ."\n"
+ .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of items returned for this request.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Image' => [
+ 'title' => 'Image',
+ 'description' => 'Image details.',
'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"
+ 'ImageType' => ['description' => 'Image type.', 'type' => 'string', 'required' => true, 'example' => 'VM', 'title' => ''],
+ 'AppId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Name' => ['description' => 'Image name.', 'type' => 'string', 'example' => 'app-image', 'title' => ''],
+ 'Version' => ['description' => 'Version.', 'type' => 'string', 'example' => 'v1.0', 'title' => ''],
+ 'Description' => ['description' => 'Image description.', 'type' => 'string', 'example' => '应用测试镜像。', 'title' => ''],
+ 'Size' => ['description' => 'Image size, in GiB.', 'type' => 'string', 'example' => '40 GiB', 'title' => ''],
+ 'CreateTime' => ['description' => 'Image creation time.', 'type' => 'string', 'example' => '2022-12-23T09:51:39Z', 'title' => ''],
+ 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ContainerImageSpec' => [
+ 'description' => 'Container image configuration details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'RegistryUrl' => ['description' => 'Container image registry URL.', 'type' => 'string', 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest', 'title' => ''],
+ 'IsACRRegistry' => ['description' => 'Indicates whether the image is stored in an Alibaba Cloud Container Registry (ACR) instance. 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"
+ .'- True: yes.'."\n"
."\n"
- .'Default value: AfterSucceeded.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AfterSucceeded',
- 'enum' => [
- 'AfterSucceeded',
- 'AfterFailed',
- 'AfterAny',
- 'AfterCorresponding',
+ .'- False: no.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'IsACREnterprise' => ['description' => 'Indicates whether the image is stored in an ACR Enterprise Edition instance. Valid values:'."\n"
+ ."\n"
+ .'- True: yes.'."\n"
+ ."\n"
+ .'- False: no.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
+ 'RegistryCriId' => ['description' => 'ACR Enterprise Edition instance ID.', 'type' => 'string', 'example' => 'cri-xyz795ygf8k9****', 'title' => ''],
+ 'RegistryCredential' => [
+ 'description' => 'Authentication for a private image registry.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Server' => ['description' => 'Registry server address.', 'type' => 'string', 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com', 'title' => ''],
+ 'UserName' => ['description' => 'Username to log on to the registry.', 'type' => 'string', 'example' => 'username', 'title' => ''],
+ 'Password' => ['description' => 'Password for the username.', 'type' => 'string', 'example' => 'userpassword', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'OsTag' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Platform' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Architecture' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- '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',
+ 'VMImageSpec' => [
+ 'description' => 'Virtual machine image configuration details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ImageId' => ['description' => 'Image ID.', 'type' => 'string', 'example' => 'm-uf60twafjtaart******', 'title' => ''],
+ 'OsTag' => ['description' => 'OS version identifier.', 'type' => 'string', 'example' => 'CentOS 7.6 64 bit', 'title' => ''],
+ 'Platform' => ['description' => 'Platform type.', 'type' => 'string', 'example' => 'CentOS', 'title' => ''],
+ 'Architecture' => ['description' => 'Architecture type.', 'type' => 'string', 'example' => 'x86_64', 'title' => ''],
],
- '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\\"]',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'DocumentInfo' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DocumentId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'EncodingMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Document' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AdditionalRegionsInfo' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ImageId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'RegionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'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' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => '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.',
- ],
+ 404 => [
+ ['errorCode' => 'ImageNotFound', 'errorMessage' => 'The specified image does not exist.', 'description' => 'The specified image does not exist. Please verify the parameter.'],
+ ],
+ 406 => [
+ ['errorCode' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
[
- [
- 'errorCode' => 'ImageNotFound',
- 'errorMessage' => 'The specified image does not exist.',
- ],
- [
- 'errorCode' => 'SecurityGroupNotExists',
- 'errorMessage' => 'The security group does not exist.',
- ],
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'No authorization is granted.', 'description' => 'No authorization is granted.'],
],
- 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.', 'description' => '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',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-03T11:07:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-12-05T05:45:33.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-05-14T03:58:59.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetImage'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3265,363 +2290,261 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '219050',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the job.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'job-xxxx',
- ],
+ 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => 'job-xxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The response schema.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
'JobInfo' => [
- 'description' => 'The job details.'."\n",
+ 'description' => 'The details of the job.',
'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',
- ],
+ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'job-xxxx', 'title' => ''],
+ 'JobName' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'testJob', 'title' => ''],
+ 'JobDescription' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Demo', 'title' => ''],
'Tasks' => [
- 'description' => 'The list of tasks. Only one task is supported.'."\n",
+ 'description' => 'The list of tasks. Currently, only one task is supported.',
'type' => 'array',
'items' => [
- 'description' => 'The list of tasks. Only one task is supported.'."\n",
+ 'description' => 'A task definition. Currently, only one task is supported.',
'type' => 'object',
'properties' => [
- 'TaskName' => [
- 'description' => 'The name of the task.'."\n",
- 'type' => 'string',
- 'example' => 'task0',
- ],
+ 'TaskName' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'task0', 'title' => ''],
'TaskSpec' => [
- 'description' => 'The details of the task specification.'."\n",
+ 'description' => 'The specifications of the task.',
'type' => 'object',
'properties' => [
'TaskExecutor' => [
- 'description' => 'The task execution configurations.'."\n",
+ 'description' => 'The execution configurations for the task.',
'type' => 'array',
'items' => [
- 'description' => 'The task execution configurations.'."\n",
+ 'description' => 'An execution configuration for the task.',
'type' => 'object',
'properties' => [
'VM' => [
- 'description' => 'Use ECS instances.'."\n",
+ 'description' => 'The configuration for using an ECS instance to run the task.',
'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',
- ],
+ 'Image' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'm-xxxx', 'title' => ''],
+ 'PrologScript' => ['description' => 'The pre-execution script. The script must be Base64-encoded.', 'type' => 'string', 'example' => 'ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg', 'title' => ''],
+ 'Script' => ['description' => 'The execution script. The script must be Base64-encoded.', 'type' => 'string', 'example' => 'ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
'VolumeMount' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'MountPath' => [
- 'type' => 'string',
- ],
- 'VolumeDriver' => [
- 'type' => 'string',
- ],
- 'MountOptions' => [
- 'type' => 'string',
- ],
+ 'MountPath' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'VolumeDriver' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'MountOptions' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'Resource' => [
- 'description' => 'The resource information.'."\n",
+ 'description' => 'The resource information.',
'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',
- ],
+ 'Cores' => ['description' => 'The number of CPU cores required for the task.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''],
+ 'EnableHT' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'Memory' => ['description' => 'The amount of memory, in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''],
'Disks' => [
- 'description' => 'The array of the disks.'."\n",
+ 'description' => 'The cloud disks that are attached to the instance.',
'type' => 'array',
'items' => [
- 'description' => 'The array of the disks.'."\n",
+ 'description' => 'A cloud disk configuration.',
'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',
- ],
+ 'Type' => ['description' => 'The type of the cloud disk. Valid values:'."\n"
+ ."\n"
+ .'- `System`: system disk.'."\n"
+ ."\n"
+ .'- `Data`: data disk.', 'type' => 'string', 'example' => 'System', 'title' => ''],
+ 'Size' => ['description' => 'The size of the cloud disk, in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- 'HostNamePrefix' => [
- 'type' => 'string',
- ],
+ 'HostNamePrefix' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'InstanceTypes' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'RetryPolicy' => [
'type' => 'object',
'properties' => [
- 'RetryCount' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'RetryCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''],
'ExitCodeActions' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Action' => [
- 'type' => 'string',
- ],
- 'ExitCode' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'Action' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'ExitCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
'ExecutorPolicy' => [
- 'description' => 'The task execution policy.'."\n",
+ 'description' => 'The task execution policy.',
'type' => 'object',
'properties' => [
- 'MaxCount' => [
- 'description' => 'The maximum number of nodes to run the job.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'MaxCount' => ['description' => 'The maximum number of nodes on which the job can run.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'ArraySpec' => [
- 'description' => 'The details of the array job.'."\n",
+ 'description' => 'The details of the array job.',
'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',
- ],
+ 'IndexStart' => ['description' => 'The start index for the array job. Valid values: 0 to 4999.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'IndexEnd' => ['description' => 'The end index for the array job. Valid values: 0 to 4999. The value must be greater than or equal to `IndexStart`.', 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''],
+ 'IndexStep' => ['description' => 'The index interval for the array job.'."\n"
+ ."\n"
+ .'> For example, if you set `IndexStart` to 1, `IndexEnd` to 5, and `IndexStep` to 2, the array job contains three subtasks. The indexes of the subtasks are 1, 3, and 5.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- 'TaskSustainable' => [
- 'description' => 'Indicate whether the job is a long-running job.'."\n",
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TaskSustainable' => ['description' => 'Indicates whether the task is a long-running task.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'ExecutorStatus' => [
- 'description' => 'The execution status of the task.'."\n",
+ 'description' => 'The execution status of the tasks.',
'type' => 'array',
'items' => [
- 'description' => 'The execution status of the task.'."\n",
+ 'description' => 'The execution status of a subtask.',
'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',
- ],
+ 'ArrayId' => ['description' => 'The subtask ID, which corresponds to the array job index.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'Status' => ['description' => 'The status of the subtask.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'StatusReason' => ['description' => 'The reason for the current status.', 'type' => 'string', 'example' => 'Creating executor', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the subtask was created.', 'type' => 'string', 'example' => '2024-02-04 13:54:10', 'title' => ''],
+ 'StartTime' => ['description' => 'The time when the subtask started.', 'type' => 'string', 'example' => '2024-02-04 13:54:10', 'title' => ''],
+ 'EndTime' => ['description' => 'The time when the subtask ended.', 'type' => 'string', 'example' => '2024-02-04 13:54:10', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
'DeploymentPolicy' => [
- 'description' => 'The resource deployment policy.'."\n",
+ 'description' => 'The resource deployment policy.',
'type' => 'object',
'properties' => [
- 'AllocationSpec' => [
- 'description' => 'The type of the resource. Only Dedicated is supported. You must enable a whitelist.'."\n",
- 'type' => 'string',
- 'example' => 'Dedicated',
- ],
+ 'AllocationSpec' => ['description' => 'The resource type. Currently, only `Dedicated` is supported. This feature is available only to users on the whitelist.', 'type' => 'string', 'example' => 'Dedicated', 'title' => ''],
'Network' => [
- 'description' => 'The network configuration information.'."\n",
+ 'description' => 'The network configurations.',
'type' => 'object',
'properties' => [
'Vswitch' => [
- 'description' => 'The VSwitch array.'."\n",
+ 'description' => 'An array of vSwitch IDs.',
'type' => 'array',
- 'items' => [
- 'description' => 'The ID of the VSwitch.'."\n",
- 'type' => 'string',
- 'example' => 'vsw-xxx',
- ],
+ 'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxx', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
'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",
+ 'description' => 'Indicates whether a public IP address is created.',
+ 'enumValueTitles' => ['false' => 'false', 'true' => 'true'],
'type' => 'boolean',
'example' => 'false',
+ 'title' => '',
],
+ 'EnableENIMapping' => ['description' => 'Indicates whether resources are created in the availability zone of the specified vSwitch.'."\n"
+ ."\n"
+ .'- `true`: Resources are created in the availability zone of the specified vSwitch.'."\n"
+ ."\n"
+ .'- `false`: Resources are created in any availability zone with available resources.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'Tags' => [
- 'description' => 'The list of job tags.'."\n",
+ 'description' => 'The list of job tags.',
'type' => 'array',
'items' => [
- 'description' => 'The list of job tags.'."\n",
+ 'description' => 'A job tag.',
'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',
- ],
+ 'TagKey' => ['description' => 'The key of the job tag.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''],
+ 'TagValue' => ['description' => 'The value of the job tag.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- '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',
- ],
+ 'Level' => ['description' => 'The computing power level. Valid values:'."\n"
+ ."\n"
+ .'- `General`: General-purpose.'."\n"
+ ."\n"
+ .'- `Performance`: Compute-optimized.'."\n"
+ ."\n"
+ .'Default value: `General`', 'type' => 'string', 'example' => 'General', 'title' => ''],
+ 'Pool' => ['type' => 'string', 'example' => 'testpool', 'description' => '', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
'SecurityPolicy' => [
'type' => 'object',
@@ -3631,13 +2554,20 @@
'properties' => [
'SecurityGroupIds' => [
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'DependencyPolicy' => [
'type' => 'object',
@@ -3647,95 +2577,107 @@
'items' => [
'type' => 'object',
'properties' => [
- 'JobId' => [
- 'type' => 'string',
- ],
- 'Type' => [
- 'type' => 'string',
- ],
+ 'JobId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- '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\\"}',
- ],
+ 'CreateTime' => ['description' => 'The time when the job was submitted.', 'type' => 'string', 'example' => '2024-03-05 20:00:46', 'title' => ''],
+ 'StartTime' => ['description' => 'The time when the job started running.', 'type' => 'string', 'example' => '2024-03-05 20:00:48', 'title' => ''],
+ 'EndTime' => ['description' => 'The time when the job finished running.', 'type' => 'string', 'example' => '2024-03-05 20:01:48', 'title' => ''],
+ 'Status' => ['description' => 'The status of the job. Valid values:'."\n"
+ ."\n"
+ .'- `Pending`: The job is queued.'."\n"
+ ."\n"
+ .'- `Initing`: The job is being initialized.'."\n"
+ ."\n"
+ .'- `Succeed`: The job finished successfully.'."\n"
+ ."\n"
+ .'- `Failed`: The job failed.'."\n"
+ ."\n"
+ .'- `Running`: The job is running.'."\n"
+ ."\n"
+ .'- `Exception`: A scheduling error occurred.'."\n"
+ ."\n"
+ .'- `Retrying`: The job is being retried.'."\n"
+ ."\n"
+ .'- `Expired`: The job expired.'."\n"
+ ."\n"
+ .'- `Deleted`: The job has been deleted.'."\n"
+ ."\n"
+ .'- `Suspended`: The job is suspended.'."\n"
+ ."\n"
+ .'- `Restarting`: The job is restarting.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
+ 'AppExtraInfo' => ['description' => 'Additional information about the application.', 'type' => 'string', 'example' => '{\\"xxx\\": \\"xxxxx\\"}', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParams',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'JobNotFound',
- 'errorMessage' => 'The specified job id is not found.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job id is not found.', 'description' => 'Job ID not found'],
],
406 => [
- [
- 'errorCode' => 'DbError',
- 'errorMessage' => 'A database error occurred.',
- ],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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',
+ 'summary' => 'Retrieves job execution details.',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-28T08:25:28.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-07-30T04:10:58.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-07-29T07:28:12.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-06-12T04:36:04.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-05-09T05:40:06.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-03-13T06:52:52.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-02-20T02:20:01.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-11-13T06:50:07.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-09-18T13:48:53.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetJob'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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\\": false,\\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 \\"Pool\\": \\"testpool\\"\\n },\\n \\"SecurityPolicy\\": {\\n \\"SecurityGroup\\": {\\n \\"SecurityGroupIds\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"DependencyPolicy\\": {\\n \\"JobDependency\\": [\\n {\\n \\"JobId\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ]\\n },\\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"}]',
+ ],
+ 'GetJobRecordDuration' => [
+ 'summary' => 'Retrieves the job record retention period.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3744,318 +2686,56 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'get',
'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,
- ],
- ],
+ 'abilityTreeCode' => '219050',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
+ 'tenantRelevance' => 'publicInformation',
],
+ 'parameters' => [],
'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\\"}',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
+ 'JobRecordDuration' => ['description' => 'The job record retention period, in days. Valid values: 1 to 30. Default value: 30.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''],
],
+ 'title' => '',
+ 'description' => 'The response schema.',
+ 'example' => '',
],
],
],
'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.',
- ],
+ 403 => [
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'Invalid parameters: %s.', 'description' => 'Request parameter error:%s.'],
],
- 503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ],
+ 'title' => 'GetJobRecordDuration',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetJobRecordDuration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"JobRecordDuration\\": 30\\n}","type":"json"}]',
],
- 'DeleteJobs' => [
- 'summary' => 'Deletes one or more jobs from a specified cluster.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetPool' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4067,153 +2747,130 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219051',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- ],
+ 'abilityTreeCode' => '250272',
+ 'abilityTreeNodes' => ['FEATUREehpcKIUG5Z'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'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',
+ 'name' => 'PoolName',
'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',
- ],
+ 'schema' => ['description' => 'The name of the resource pool.'."\n"
+ ."\n"
+ .'- The name can be up to 15 characters long.'."\n"
+ ."\n"
+ .'- The name can contain letters, digits, underscores (\\_), and periods (.).', 'type' => 'string', 'required' => true, 'example' => 'PoolTest', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The response object.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
+ 'PoolInfo' => [
+ 'description' => 'The details of the resource pool.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolName' => ['description' => 'The name of the resource pool.'."\n"
+ ."\n"
+ .'- The name can be up to 15 characters long.'."\n"
+ ."\n"
+ .'- The name can contain letters, digits, underscores (\\_), and periods (.).', 'type' => 'string', 'example' => 'PoolTest', 'title' => ''],
+ 'Status' => [
+ 'description' => 'The status of the resource pool. Valid values:'."\n"
+ ."\n"
+ .'- `Creating`: The resource pool is being created.'."\n"
+ ."\n"
+ .'- `Updating`: The resource pool is being updated.'."\n"
+ ."\n"
+ .'- `Deleting`: The resource pool is being deleted.'."\n"
+ ."\n"
+ .'- `Working`: The resource pool is active.'."\n"
+ ."\n"
+ .'- `Deleted`: The resource pool has been deleted.',
+ 'enumValueTitles' => [],
+ 'type' => 'string',
+ 'example' => 'Working',
+ 'title' => '',
+ ],
+ 'IsDefault' => ['description' => 'Indicates whether the resource pool is the default resource pool. Valid values:'."\n"
+ ."\n"
+ .'- **true**'."\n"
+ ."\n"
+ .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Priority' => ['description' => 'The priority of the resource pool.'."\n"
+ ."\n"
+ .'- Valid values: 1 to 99. A larger value indicates a higher priority. Default value: 1.'."\n"
+ ."\n"
+ .'- Jobs in a resource pool with a higher priority are scheduled before pending jobs in a resource pool with a lower priority. The priority of the resource pool takes precedence over the priority of a job.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'MaxExecutorNum' => ['description' => 'The maximum number of concurrent executors per user in the resource pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'ExecutorUsage' => ['description' => 'The number of executors that are in use in the resource pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the resource pool was created.', 'type' => 'string', 'example' => '2024-12-01 20:00:00', 'title' => ''],
+ 'UpdateTime' => ['description' => 'The time when the resource pool was last updated.', 'type' => 'string', 'example' => '2024-12-01 20:00:00', 'title' => ''],
+ 'Reason' => ['description' => 'The reason for the error.', 'type' => 'string', 'example' => 'Fails to *** pool: ***.', 'title' => ''],
+ 'SchedulingPolicyId' => ['description' => 'The ID of the scheduling policy.', 'type' => 'string', 'example' => 'policy-xxx', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParams',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'JobNotFound',
- 'errorMessage' => 'The specified job id is not found.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'InDebt', 'errorMessage' => 'Your account has overdue payments.', 'description' => 'Your account has overdue payments.'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => 'You have not enabled this service'],
+ ],
+ 403 => [
+ ['errorCode' => 'GetResourceFailed', 'errorMessage' => 'Failed to get resource.', 'description' => 'Failed to get resource'],
+ ['errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', 'errorMessage' => 'The resource is out of stock.', 'description' => 'Resources are sold out'],
+ ['errorCode' => 'PoolNotFound', 'errorMessage' => 'The specified pool was not found.', 'description' => 'Resource pool does not exist'],
],
406 => [
- [
- 'errorCode' => 'DbError',
- 'errorMessage' => 'A database error occurred.',
- ],
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'The request has failed due to a temporary failure of the server.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'GetPool',
+ 'summary' => 'Retrieves the details of a specified resource pool.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetPool'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetPool',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","type":"json"}]',
- 'title' => 'DeleteJobs',
+ '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 \\"MaxExecutorNum\\": 100,\\n \\"ExecutorUsage\\": 100,\\n \\"CreateTime\\": \\"2024-12-01 20:00:00\\",\\n \\"UpdateTime\\": \\"2024-12-01 20:00:00\\",\\n \\"Reason\\": \\"Fails to *** pool: ***.\\",\\n \\"SchedulingPolicyId\\": \\"policy-xxx\\"\\n }\\n}","type":"json"}]',
],
- 'ListJobExecutors' => [
- 'summary' => 'Queries job executor information.',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListActionPlanActivities' => [
+ 'summary' => 'Queries the execution status of an execution plan.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4225,54 +2882,29 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219059',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
+ 'abilityTreeNodes' => ['FEATUREehpc11IJC9'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'ActionPlanId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the job.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'job-xxx',
- ],
+ 'schema' => ['description' => 'The ID of the execution plan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ap-hz036ubmx2qmw93k****', 'title' => ''],
],
[
- 'name' => 'TaskName',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The job name.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'task0',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'A pagination token.'."\n", 'type' => 'string', 'required' => false, 'example' => '1d2db86scXXXXXXXXXX', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number of the page to return.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ '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', 'title' => ''],
],
],
'responses' => [
@@ -4282,256 +2914,90 @@
'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",
+ 'TotalCount' => ['title' => '', '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' => '', '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 executor property.'."\n",
+ 'description' => 'The execution details of the execution plan.'."\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",
+ 'Status' => ['description' => 'The implementation status of the execution plan activity. Valid values:'."\n"
+ ."\n"
+ .'* InProcess'."\n"
+ .'* Completed'."\n"
+ .'* Failed'."\n", 'type' => 'string', 'example' => 'InProcess', 'title' => ''],
+ 'EndTime' => ['description' => 'The end time of the execution plan activity.'."\n", 'type' => 'string', 'example' => '2025-08-10 18:28:05'."\n", 'title' => ''],
+ 'CreatedCapacity' => ['description' => 'The increased capacity of this execution plan activity.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''],
+ 'Jobs' => [
+ 'description' => 'The list of Instant jobs involved in the execution plan.'."\n",
'type' => 'array',
'items' => [
- 'description' => 'The list of executor tags.'."\n",
+ 'description' => 'The information about the Instant jobs involved in the execution plan.'."\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',
- ],
+ 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
+ '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', 'title' => ''],
+ 'JobId' => ['description' => 'The ID of the job.'."\n", 'type' => 'string', 'example' => 'job-hz12dqq8y3ormo1hz49h', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
- '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',
+ 'StartTime' => ['description' => 'The start time of the implementation of the planned activity.'."\n", 'type' => 'string', 'example' => '2025-08-10 18:28:05'."\n", 'title' => ''],
+ 'ActionPlanActivityId' => ['description' => 'The activity ID of the execution plan.'."\n", 'type' => 'string', 'example' => 'et-4119e3f60eb34fc4', 'title' => ''],
+ 'DestroyCapacity' => ['description' => 'The capacity released by this execution plan activity.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'NotExisted.ActionPlan', 'errorMessage' => 'The specified action plan does not exist.', 'description' => 'The specified execution plan does not exist.'],
],
- 503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListActionPlanActivities',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListActionPlanActivities',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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",
+ '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"}]',
],
- 'ListExecutors' => [
- 'summary' => 'Querying Global Executor Information',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListActionPlans' => [
+ 'summary' => 'Queries the list of execution plans.',
+ 'path' => '',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4543,140 +3009,35 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219060',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
+ 'abilityTreeNodes' => ['FEATUREehpc11IJC9'],
],
'parameters' => [
[
- 'name' => 'Filter',
+ 'name' => 'ActionPlanIds',
'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',
- ],
- ],
+ '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", 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'PageSize',
+ 'name' => 'NextToken',
'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',
- ],
+ 'schema' => ['description' => 'A pagination token.'."\n", 'type' => 'string', 'required' => false, 'example' => '1d2db86scXXXXXXXXXX', 'title' => ''],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'MaxResults',
'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',
- ],
+ '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', 'title' => ''],
],
],
'responses' => [
@@ -4686,271 +3047,68 @@
'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",
+ 'TotalCount' => ['title' => '', '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' => '', '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' => 'Executor property.'."\n",
+ 'description' => 'The information about the prefetch plans.'."\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',
- ],
+ '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', 'title' => ''],
+ 'ActionPlanId' => ['description' => 'The ID of the execution plan.'."\n", 'type' => 'string', 'example' => 'ap-hz036ubmx2qmw93k****'."\n", 'title' => ''],
+ 'ActionPlanName' => ['description' => 'The name of the execution plan.'."\n", 'type' => 'string', 'example' => 'TestActionPlan', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the execution plan was created.'."\n", 'type' => 'string', 'example' => '2025-08-10 17:58:24 ', 'title' => ''],
+ '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", 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParams',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- ],
- 406 => [
- [
- 'errorCode' => 'DbError',
- 'errorMessage' => 'A database error occurred.',
- ],
+ ['errorCode' => 'NotExisted.ActionPlan', 'errorMessage' => 'The specified action plan does not exist.', 'description' => 'The specified execution plan does not exist.'],
],
- 503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListActionPlans',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListActionPlans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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',
+ '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"}]',
],
'ListExecutorEvents' => [
'summary' => 'Queries the running event list of one or more executers.',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4963,9 +3121,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '223066',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- ],
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
@@ -4973,26 +3129,14 @@
[
'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',
- ],
+ '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', 'title' => ''],
],
[
'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',
- ],
+ 'schema' => ['description' => 'The current page number.\\'."\n"
+ .'Starting value: 1\\'."\n"
+ .'Default value: 1'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Filter',
@@ -5002,49 +3146,26 @@
'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',
- ],
+ 'Level' => ['description' => 'The level of the running event. Valid value:'."\n"
+ ."\n"
+ .'* Normal'."\n"
+ .'* Warning'."\n"
+ .'* Error'."\n", 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''],
+ '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', 'title' => ''],
+ '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', 'title' => ''],
+ 'JobId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'job-xxxx', 'title' => ''],
'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',
- ],
+ 'items' => ['description' => 'The Executor ID. The format is JobId-TaskName-ArrayIndex.'."\n", 'type' => 'string', 'required' => false, 'example' => 'job-xxxx-Task0-1', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -5055,30 +3176,10 @@
'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',
- ],
+ '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', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''],
'ExecutorEventList' => [
'description' => 'The list of the running event.'."\n",
'type' => 'array',
@@ -5086,173 +3187,354 @@
'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',
- ],
+ 'JobId' => ['description' => 'The job ID.'."\n", 'type' => 'string', 'example' => 'job-xxxx', 'title' => ''],
+ 'ExecutorId' => ['description' => 'The ID of the executor. The format is JobId-TaskName-ArrayIndex.'."\n", 'type' => 'string', 'example' => 'job-xxxx-Task0-1', 'title' => ''],
+ 'Level' => ['description' => 'The level of the running event. Valid values:'."\n"
+ ."\n"
+ .'* Normal'."\n"
+ .'* Warning'."\n"
+ .'* Error'."\n", 'type' => 'string', 'example' => 'Normal', 'title' => ''],
+ 'Time' => ['description' => 'The event of the running event.'."\n", 'type' => 'string', 'example' => '2024-02-20 10:04:13', 'title' => ''],
+ 'Content' => ['description' => 'The content of the running event.'."\n", 'type' => 'string', 'example' => 'Executor created successfully', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParams',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'JobNotFound',
- 'errorMessage' => 'The specified job id is not found.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job id is not found.', 'description' => 'Job ID not found'],
],
406 => [
- [
- 'errorCode' => 'DbError',
- 'errorMessage' => 'A database error occurred.',
- ],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'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',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ '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"}]',
+ ],
+ 'ListExecutors' => [
+ 'summary' => 'Queries information about global executors.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219051',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
+ 'abilityTreeCode' => '219060',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
],
'parameters' => [
[
- 'name' => 'JobIds',
+ 'name' => 'Filter',
'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',
+ 'description' => 'The filter conditions for querying executors.',
+ 'type' => 'object',
+ 'properties' => [
+ 'JobName' => ['description' => 'The job name. Fuzzy queries are supported.', 'type' => 'string', 'required' => false, 'example' => 'testJob', 'title' => ''],
+ 'ExecutorIds' => [
+ 'description' => 'A list of executor IDs. You can specify up to 100 IDs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The executor ID. The format is JobId-TaskName-ArrayIndex.', 'type' => 'string', 'required' => false, 'example' => 'job-xxxx-task0-1', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'IpAddresses' => [
+ 'description' => 'A list of private IP addresses. You can specify up to 100 IP addresses.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The private IP address.', 'type' => 'string', 'required' => false, 'example' => '192.168.0.1', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Status' => [
+ 'description' => 'A list of executor statuses.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The status of the executor. Valid values:'."\n"
+ ."\n"
+ .'- Pending: The executor is waiting in a queue.'."\n"
+ ."\n"
+ .'- Initing: The executor is being initialized.'."\n"
+ ."\n"
+ .'- Succeeded: The executor ran successfully.'."\n"
+ ."\n"
+ .'- Failed: The executor failed to run.'."\n"
+ ."\n"
+ .'- Running: The executor is running.'."\n"
+ ."\n"
+ .'- Exception: A scheduling error occurred.'."\n"
+ ."\n"
+ .'- Retrying: The system is retrying the executor.'."\n"
+ ."\n"
+ .'- Expired: The executor timed out.'."\n"
+ ."\n"
+ .'- Suspended: The job is in hibernation.'."\n"
+ ."\n"
+ .'- Restarting: The job is restarting.'."\n"
+ ."\n"
+ .'- Deleted: The executor is deleted.',
+ 'enumValueTitles' => [
+ 'Succeeded' => 'Succeeded', 'Restarting' => 'Restarting', 'Failed' => 'Failed', 'Running' => 'Running', 'Expired' => 'Expired', 'Initing' => 'Initing', 'Deleted' => 'Deleted', 'Retrying' => 'Retrying', 'Suspended' => 'Suspended', 'Pending' => 'Pending',
+ 'Deleting' => 'Deleting', 'Exception' => 'Exception',
+ ],
+ 'type' => 'string',
+ 'enum' => ['Pending', 'Initing', 'Failed', 'Running', 'Exception', 'Retrying', 'Expired', 'Deleting', 'Deleted', 'Suspended', 'Restarting', 'Succeeded', 'Succeed'],
+ 'required' => false,
+ 'example' => 'Running',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TimeCreatedBefore' => ['description' => 'The jobs submitted before this time. This is a UNIX timestamp that is converted from the time in the region where the job is located. For sites in mainland China, the time is in the UTC+8 time zone.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1703820113', 'title' => ''],
+ 'TimeCreatedAfter' => ['description' => 'The jobs submitted after this time. This is a UNIX timestamp that is converted from the time in the region where the job is located. For sites in mainland China, the time is in the UTC+8 time zone.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1703819914', 'title' => ''],
+ 'VswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-xxx', 'title' => ''],
+ 'Image' => ['description' => 'The executor image.', 'type' => 'string', 'required' => false, 'example' => 'm-f8z0dfa96luxxxxx', 'title' => ''],
+ 'VpcId' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-xxx', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page for a paged query. Default value: 50. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The current page number.<br>Start value: 1<br>Default value: 1<br><br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
+ 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries in the list.', 'type' => 'string', 'example' => '40', 'title' => ''],
+ 'Executors' => [
+ 'description' => 'The list of executors.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The properties of the executor.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExecutorId' => ['description' => 'The executor ID. The format is JobId-TaskName-ArrayIndex.', 'type' => 'string', 'example' => 'job-xxxx-Task0-1', 'title' => ''],
+ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'job-hy1nggvyukuvkr******', 'title' => ''],
+ 'JobName' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'testJob', 'title' => ''],
+ 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'Task0', 'title' => ''],
+ 'ArrayIndex' => ['description' => 'The executor number.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'IpAddress' => [
+ 'description' => 'A list of private IP addresses.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The private IP address.', 'type' => 'string', 'example' => '192.168.0.1', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ExternalIpAddress' => [
+ 'description' => 'A list of public IP addresses of the node.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The list of public IP addresses for the node.', 'type' => 'string', 'example' => '116.62.100.6'."\n", 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'HostName' => [
+ 'description' => 'A list of hostnames.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The hostname.', 'type' => 'string', 'example' => 'testJob-0', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Image' => ['description' => 'The executor image.', 'type' => 'string', 'example' => 'm-f8z0dfa96luxxxxx', 'title' => ''],
+ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-02-20 10:04:10', 'title' => ''],
+ 'ExpirationTime' => ['description' => 'The expiration time.', 'type' => 'string', 'title' => '', 'example' => ''],
+ 'StartTime' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2024-02-20 10:04:13', 'title' => ''],
+ 'EndTime' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2024-02-20 10:04:18', 'title' => ''],
+ 'Status' => ['description' => 'The status of the executor. Possible values:'."\n"
+ ."\n"
+ .'- Pending: The executor is waiting in a queue.'."\n"
+ ."\n"
+ .'- Initing: The executor is being initialized.'."\n"
+ ."\n"
+ .'- Succeeded: The executor ran successfully.'."\n"
+ ."\n"
+ .'- Failed: The executor failed to run.'."\n"
+ ."\n"
+ .'- Running: The executor is running.'."\n"
+ ."\n"
+ .'- Exception: A scheduling error occurred.'."\n"
+ ."\n"
+ .'- Retrying: The system is retrying the executor.'."\n"
+ ."\n"
+ .'- Expired: The executor timed out.'."\n"
+ ."\n"
+ .'- Suspended: The job is in hibernation.'."\n"
+ ."\n"
+ .'- Restarting: The job is restarting.'."\n"
+ ."\n"
+ .'- Deleted: The executor is deleted.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'StatusReason' => ['description' => 'The description of the status reason.', 'type' => 'string', 'example' => 'ExecutorReady', 'title' => ''],
+ 'Resource' => [
+ 'description' => 'The resource information.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Cores' => ['description' => 'The number of CPU cores.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''],
+ 'Memory' => ['description' => 'The total amount of memory resources. Unit: GiB.', 'type' => 'number', 'format' => 'float', 'example' => '4', 'title' => ''],
+ 'Disks' => [
+ 'description' => 'An array of cloud disks.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'The type of the cloud disk. The following types are supported:'."\n"
+ ."\n"
+ .'- System: The system disk.'."\n"
+ ."\n"
+ .'- Data: The data disk.', 'type' => 'string', 'example' => 'System', 'title' => ''],
+ 'Size' => ['description' => 'The size of the cloud disk.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ ],
+ 'description' => 'The properties of the cloud disk.',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'InstanceType' => ['description' => 'The instance type of the runtime environment.', 'type' => 'string', 'example' => 'ecs.c7a.8xlarge', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'VswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-xxx', 'title' => ''],
+ 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'ECI', 'title' => ''],
+ 'TaskSustainable' => ['description' => 'Indicates whether the job is a long-running job.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Tags' => [
+ 'description' => 'A list of executor tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A list of executor tags.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => ['description' => 'The tag key of the executor.', 'type' => 'string', 'example' => 'TestKey'."\n", 'title' => ''],
+ 'TagValue' => ['description' => 'The tag value of the executor.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'Alphafold3', 'title' => ''],
+ 'BlockDuration' => ['description' => 'The duration for which the compute resources are reserved.', 'type' => 'integer', 'format' => 'int32', 'example' => '24', 'title' => ''],
+ 'Preemptible' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'AllocationSpec' => ['description' => 'The resource type.'."\n"
+ ."\n"
+ .'- Standard: Standard.'."\n"
+ ."\n"
+ .'- Dedicated: Dedicated. This type requires whitelisting.'."\n"
+ ."\n"
+ .'- Economic: Economy. This type requires whitelisting.', 'type' => 'string', 'example' => 'Standard', 'title' => ''],
+ 'VpcId' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-xxx', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParams',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'JobNotFound',
- 'errorMessage' => 'The specified job id is not found.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
],
406 => [
- [
- 'errorCode' => 'DbError',
- 'errorMessage' => 'A database error occurred.',
- ],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'schemes' => [
- 'https',
+ 'title' => 'ListExecutors',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-27T03:42:10.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2025-09-28T08:25:28.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-07-30T04:10:58.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-07-15T02:49:17.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-07-11T10:08:31.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2025-06-04T10:08:17.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-12-30T12:09:13.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-11-11T05:46:38.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-09-19T01:30:36.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-08-14T07:16:44.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListExecutors'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListExecutors',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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\\": false,\\n \\"AllocationSpec\\": \\"Standard\\",\\n \\"VpcId\\": \\"vpc-xxx\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListImages' => [
+ 'summary' => 'Queries the image list.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5264,71 +3546,93 @@
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '223066',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- ],
+ 'abilityTreeCode' => '219055',
+ 'abilityTreeNodes' => ['FEATUREehpcEZT3HW', 'FEATUREehpcE21063'],
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'job-xxxxxxx',
- ],
+ 'schema' => ['description' => 'The number of the page to return.\\'."\n"
+ .'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'TaskName',
+ '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', 'title' => ''],
+ ],
+ [
+ 'name' => 'ImageCategory',
'in' => 'query',
'schema' => [
- 'description' => '',
+ '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' => 'Task0',
+ 'enumValueTitles' => ['Custom' => 'Custom', 'Public' => 'Public'],
+ 'example' => 'Custom',
+ 'title' => '',
],
],
[
- 'name' => 'ArrayIndex',
+ 'name' => 'ImageType',
'in' => 'query',
'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
+ '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' => '0_1',
+ 'enumValueTitles' => ['Container' => 'Container', 'VM' => 'VM'],
+ 'example' => 'VM',
+ 'title' => '',
],
],
[
- 'name' => 'ContentEncoding',
+ 'name' => 'ImageIds',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The array of image IDs.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The image ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'm-uf6bzz76jb4ai9******', 'title' => ''],
'required' => false,
- 'example' => 'PlainText',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'LimitBytes',
+ 'name' => 'ImageNames',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'The array of image names.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of the image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'appimage', 'title' => ''],
'required' => false,
- 'example' => '1048576',
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'StartTime',
+ 'name' => 'Mode',
'in' => 'query',
'schema' => [
- 'description' => '',
+ '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,
- 'example' => '2024-09-02T16:00:00Z',
+ 'enumValueTitles' => ['Merge' => 'Merge', 'List' => 'List'],
+ 'example' => 'Merge',
+ 'title' => '',
],
],
],
@@ -5336,69 +3640,91 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'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',
+ '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', 'title' => ''],
+ 'TotalCount' => ['title' => '', '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', 'title' => ''],
+ 'ImageId' => ['description' => 'The image ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'm-bp181x855551ww5yq****', 'title' => ''],
+ 'AppId' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ci-vm-kHLPzEWun6zz****', 'title' => ''],
+ 'Name' => ['description' => 'The name of the image.'."\n", 'type' => 'string', 'example' => 'app-image', 'title' => ''],
+ 'Version' => ['description' => 'The version of the image.'."\n", 'type' => 'string', 'example' => 'v1.0', 'title' => ''],
+ 'Description' => ['description' => 'The description of the image.'."\n", 'type' => 'string', 'example' => '应用测试镜像。', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the storage resource was created.'."\n", 'type' => 'string', 'example' => '2022-12-09T07:06:34Z', 'title' => ''],
+ 'OsTag' => ['description' => 'The ID of the specific OS version.'."\n", 'type' => 'string', 'example' => 'Ubuntu 22.04 64 bit', 'title' => ''],
+ 'UpdateTime' => ['description' => 'The time when the image was updated.'."\n", 'type' => 'string', 'example' => '2024-09-25 14:15:28', 'title' => ''],
+ 'DocumentId' => ['description' => 'The document ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'Weight' => ['description' => 'The weight.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParams',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'JobNotFound',
- 'errorMessage' => 'The specified job id is not found.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'InDebt', 'errorMessage' => 'Your account has overdue payments.', 'description' => 'Your account has overdue payments.'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => 'You have not enabled this service'],
],
406 => [
- [
- 'errorCode' => 'DbError',
- 'errorMessage' => 'A database error occurred.',
- ],
+ ['errorCode' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
+ ],
+ [
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'No authorization is granted.', 'description' => 'No authorization is granted.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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',
+ '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',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListImages'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListImages',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListJobExecutors' => [
+ 'summary' => 'Retrieves information about job executors.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5407,135 +3733,208 @@
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219038',
- 'abilityTreeNodes' => [
- 'FEATUREehpcR6Y931',
- ],
+ 'abilityTreeCode' => '219059',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
],
'parameters' => [
[
'name' => 'JobId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The job ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'job-xxxxx'."\n",
- ],
+ 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => false, 'example' => 'job-xxxx', 'title' => ''],
],
[
'name' => 'TaskName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the task.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Task0'."\n",
- ],
+ 'schema' => ['description' => 'The job name.', 'type' => 'string', 'required' => false, 'example' => 'Task0', 'title' => ''],
],
[
- 'name' => 'MetricName',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The metrics of the job.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cpu_utilization'."\n",
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'ArrayIndex',
+ 'name' => 'PageNumber',
'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,
- ],
+ 'schema' => ['description' => 'The page number for the paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'Schema of Response',
'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',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
+ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'job-xxxx', 'title' => ''],
+ 'TaskName' => ['description' => 'The job name.', 'type' => 'string', 'example' => 'Task0', 'title' => ''],
+ 'PageSize' => ['description' => 'The number of entries on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'string', 'example' => '50', 'title' => ''],
+ 'Executors' => [
+ 'description' => 'A list of executors.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The properties of an executor.',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExecutorId' => ['description' => 'The ID of the executor. The format is \\`JobId-TaskName-ArrayIndex\\`.', 'type' => 'string', 'example' => 'job-xxxx-Task0-1'."\n", 'title' => ''],
+ 'ArrayIndex' => ['description' => 'The index of the executor.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'IpAddress' => [
+ 'description' => 'A list of node IP addresses.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The IP address of the node.', 'type' => 'string', 'example' => '192.168.10.11', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ExternalIpAddress' => [
+ 'description' => 'A list of public IP addresses of the nodes.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The public IP address of the node.', 'type' => 'string', 'example' => '116.62.100.6', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'HostName' => [
+ 'description' => 'An array of node hostnames.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The hostname.', 'type' => 'string', 'example' => 'compute-0', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'CreateTime' => ['description' => 'The time when the executor was created.', 'type' => 'string', 'example' => '2024-02-20 10:04:10', 'title' => ''],
+ 'StartTime' => ['description' => 'The time when the executor started.', 'type' => 'string', 'example' => '2024-02-20 10:04:13', 'title' => ''],
+ 'EndTime' => ['description' => 'The time when the executor ended.', 'type' => 'string', 'example' => '2024-02-20 10:04:18', 'title' => ''],
+ 'Status' => ['description' => 'The status of the executor. Valid values:'."\n"
+ ."\n"
+ .'- Pending: In queue'."\n"
+ ."\n"
+ .'- Initing: Initializing'."\n"
+ ."\n"
+ .'- Succeed: Succeeded'."\n"
+ ."\n"
+ .'- Failed: Failed'."\n"
+ ."\n"
+ .'- Running: Running'."\n"
+ ."\n"
+ .'- Exception: Abnormal scheduling'."\n"
+ ."\n"
+ .'- Retrying: Retrying'."\n"
+ ."\n"
+ .'- Expired: Timed out'."\n"
+ ."\n"
+ .'- Suspended: Job hibernating'."\n"
+ ."\n"
+ .'- Restarting: Job restarting'."\n"
+ ."\n"
+ .'- Deleted: Deleted', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'StatusReason' => ['description' => 'The reason for the status.', 'type' => 'string', 'example' => 'ExecutorReady', 'title' => ''],
+ 'Tags' => [
+ 'description' => 'A list of executor tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A list of executor tags.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => ['description' => 'The tag key of the executor.', 'type' => 'string', 'example' => 'TestKey'."\n", 'title' => ''],
+ 'TagValue' => ['description' => 'The tag value of the executor.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'ExpirationTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'BlockDuration' => ['description' => 'The retention period of the compute resources.', 'type' => 'integer', 'format' => 'int32', 'example' => '24', 'title' => ''],
+ 'Preemptible' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''],
+ 'AllocationSpec' => ['description' => 'The resource type.'."\n"
+ ."\n"
+ .'- Standard: Standard.'."\n"
+ ."\n"
+ .'- Dedicated: Dedicated. To use this resource type, you must be added to the whitelist.'."\n"
+ ."\n"
+ .'- Economic: Economy. To use this resource type, you must be added to the whitelist.', 'type' => 'string', 'example' => 'Standard', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
- 'DataPoints' => [
- 'description' => 'Monitoring statistics points.'."\n",
- 'type' => 'string',
- 'example' => '[{"timestamp":1709540685000,"Minimum":28.45,"Maximum":28.45,"Average":28.45}]'."\n",
+ 'ExecutorStatus' => [
+ 'description' => 'Statistics about executor statuses.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Pending' => ['description' => 'The number of executors in the Pending state.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Initing' => ['description' => 'The number of executors in the Initing state.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Running' => ['description' => 'The number of executors in the Running state.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Succeeded' => ['description' => 'The number of executors in the Succeeded state.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Failed' => ['description' => 'The number of executors in the Failed state.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Deleted' => ['description' => 'The number of executors in the Deleted state.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Exception' => ['description' => 'The number of executors in the Exception state.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Suspended' => ['description' => 'The number of executors in the Suspended state.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Restarting' => ['description' => 'The number of executors in the Restarting state.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParams',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'JobNotFound',
- 'errorMessage' => 'The specified job id is not found.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job id is not found.', 'description' => 'Job ID not found'],
],
406 => [
- [
- 'errorCode' => 'DbError',
- 'errorMessage' => 'A database error occurred.',
- ],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'The request has failed due to a temporary failure of the server.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ '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\\": false,\\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' => 'Retrieves information about job executors.',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-28T08:25:28.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-07-30T04:10:58.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-07-15T02:49:18.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2025-01-02T10:00:52.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-12-30T12:09:13.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-11-11T05:46:39.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-09-18T13:48:53.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-08-14T07:16:44.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListJobExecutors'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListJobExecutors',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- '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',
- ],
+ 'ListJobs' => [
+ 'summary' => 'Returns a list of jobs.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5547,290 +3946,412 @@
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '219041',
- 'abilityTreeNodes' => [
- 'FEATUREehpcR6Y931',
- ],
+ 'abilityTreeCode' => '219053',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
],
'parameters' => [
[
- 'name' => 'JobId',
+ 'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The job ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'job-xxxxx'."\n",
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page. The default value is 50. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''],
],
[
- 'name' => 'TaskName',
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The current page number.'."\n"
+ ."\n"
+ .'Start value: 1'."\n"
+ ."\n"
+ .'Default value: 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'Filter',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => 'The name of the task.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Task0',
+ 'description' => 'The filter conditions for querying jobs.',
+ 'type' => 'object',
+ 'properties' => [
+ 'JobName' => ['description' => 'The name of the job. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'testJob', 'title' => ''],
+ 'JobId' => ['description' => 'The ID of the job.', 'type' => 'string', 'required' => false, 'example' => 'job-xxxx', 'title' => ''],
+ 'TimeCreatedAfter' => ['description' => 'The time after which the jobs were submitted. This is a UNIX timestamp based on the local time of the region. For sites in the Chinese mainland, the time zone is UTC+8.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1703819914', 'title' => ''],
+ 'TimeCreatedBefore' => ['description' => 'The time before which the jobs were submitted. This is a UNIX timestamp based on the local time of the region. For sites in the Chinese mainland, the time zone is UTC+8.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1703820113', 'title' => ''],
+ 'Status' => ['description' => 'The status of the job. Valid values:'."\n"
+ ."\n"
+ .'- Pending: The job is in the queue.'."\n"
+ ."\n"
+ .'- Initing: The job is initializing.'."\n"
+ ."\n"
+ .'- Succeeded: The job was successful.'."\n"
+ ."\n"
+ .'- Failed: The job failed.'."\n"
+ ."\n"
+ .'- Running: The job is running.'."\n"
+ ."\n"
+ .'- Exception: A scheduling exception occurred.'."\n"
+ ."\n"
+ .'- Retrying: The job is being retried.'."\n"
+ ."\n"
+ .'- Expired: The job timed out.'."\n"
+ ."\n"
+ .'- Suspended: The job is in hibernation.'."\n"
+ ."\n"
+ .'- Restarting: The job is restarting.'."\n"
+ ."\n"
+ .'- Deleted: The job is deleted.', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ArrayIndex',
+ 'name' => 'SortBy',
'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',
+ 'description' => 'The sorting method.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Label' => ['description' => 'The field to sort by. Valid values:'."\n"
+ ."\n"
+ .'- time\\_start'."\n"
+ ."\n"
+ .'- job\\_name', 'type' => 'string', 'required' => false, 'example' => 'time_start', 'title' => ''],
+ 'Order' => ['description' => 'The sort order. Valid values:'."\n"
+ ."\n"
+ .'- ASC (default): Ascending'."\n"
+ ."\n"
+ .'- DESC: Descending', 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''],
],
- 'required' => true,
- 'docRequired' => true,
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'title' => '',
+ 'description' => 'Schema of Response',
'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",
+ 'TotalCount' => ['description' => 'The total number of entries that meet the filter conditions.'."\n"
+ .'This parameter is optional and may not be returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
+ 'PageSize' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
+ 'JobList' => [
+ 'description' => 'The list of jobs.',
'type' => 'array',
'items' => [
- 'description' => 'The details of the JobMetric.'."\n",
+ 'description' => 'The list of jobs.',
'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",
+ 'JobName' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'testJob', 'title' => ''],
+ 'JobId' => ['description' => 'The ID of the job.', 'type' => 'string', 'example' => 'job-xxx', 'title' => ''],
+ 'JobDescription' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Demo', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the job was submitted.', 'type' => 'string', 'example' => '2024-01-25 12:29:21', 'title' => ''],
+ 'OwnerUid' => ['description' => 'The UID of the user who created the job.', 'type' => 'string', 'example' => '129**********', 'title' => ''],
+ 'Status' => ['description' => 'The status of the job. Possible values:'."\n"
+ ."\n"
+ .'- Pending: The job is in the queue.'."\n"
+ ."\n"
+ .'- Initing: The job is initializing.'."\n"
+ ."\n"
+ .'- Succeeded: The job was successful.'."\n"
+ ."\n"
+ .'- Failed: The job failed.'."\n"
+ ."\n"
+ .'- Running: The job is running.'."\n"
+ ."\n"
+ .'- Exception: A scheduling exception occurred.'."\n"
+ ."\n"
+ .'- Retrying: The job is being retried.'."\n"
+ ."\n"
+ .'- Expired: The job timed out.'."\n"
+ ."\n"
+ .'- Suspended: The job is in hibernation.'."\n"
+ ."\n"
+ .'- Restarting: The job is restarting.'."\n"
+ ."\n"
+ .'- Deleted: The job is deleted.', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'TaskCount' => ['description' => 'The number of tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'ExecutorCount' => ['description' => 'The number of running nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'StartTime' => ['description' => 'The time when the job started.', 'type' => 'string', 'example' => '2024-01-25 12:29:23', 'title' => ''],
+ 'EndTime' => ['description' => 'The time when the job ended.', 'type' => 'string', 'example' => '2024-01-25 12:35:23', 'title' => ''],
+ 'TaskSustainable' => ['description' => 'Indicates whether the job is a long-running job.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Tags' => [
+ 'description' => 'The list of job tags.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The job tag.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagKey' => ['description' => 'The key of the job tag.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''],
+ 'TagValue' => ['description' => 'The value of the job tag.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
+ 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'Alphafold3', 'title' => ''],
+ 'AppExtraInfo' => ['description' => 'Additional information about the application.', 'type' => 'string', 'example' => '{\\"xxx\\": \\"xxxxx\\"}', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParams',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'JobNotFound',
- 'errorMessage' => 'The specified job id is not found.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'InDebt', 'errorMessage' => 'Your account has overdue payments.', 'description' => 'Your account has overdue payments.'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => 'You have not enabled this service'],
],
406 => [
- [
- 'errorCode' => 'DbError',
- 'errorMessage' => 'A database error occurred.',
- ],
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'The request has failed due to a temporary failure of the server.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- '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',
+ 'title' => 'ListJobs',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-09T05:40:06.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-12-30T12:09:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2024-11-11T05:46:39.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListJobs'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListJobs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'ListPools' => [
+ 'summary' => 'Lists resource pools.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '239758',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
+ 'abilityTreeCode' => '249321',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'Filter',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '资源类型',
- 'description' => 'The type of the resource. Valid values:'."\n"
- ."\n"
- .'* Job'."\n"
- .'* Executor'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Job',
- 'enum' => [],
+ 'description' => 'The filter conditions for querying resource pools.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolName' => [
+ 'description' => 'The list of resource pool names to query.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of the resource pool.'."\n"
+ ."\n"
+ .'- The name can be up to 15 characters in length.'."\n"
+ ."\n"
+ .'- It can contain digits, uppercase letters, lowercase letters, underscores (\\_), and periods (.).', 'type' => 'string', 'required' => false, 'example' => 'PoolTest', 'title' => ''],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'Status' => [
+ 'description' => 'The list of resource pool statuses to query.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The status of the resource pool. Valid values:'."\n"
+ ."\n"
+ .'- Creating: The resource pool is being created.'."\n"
+ ."\n"
+ .'- Updating: The resource pool is being updated.'."\n"
+ ."\n"
+ .'- Deleting: The resource pool is being deleted.'."\n"
+ ."\n"
+ .'- Working: The resource pool is running.'."\n"
+ ."\n"
+ .'- Deleted: The resource pool is deleted.',
+ 'enumValueTitles' => [],
+ 'type' => 'string',
+ 'enum' => ['Creating', 'Working', 'Updating', 'Deleting', 'Deleted'],
+ 'required' => false,
+ 'example' => 'Working',
+ 'title' => '',
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'TimeCreatedBefore' => ['description' => 'Returns only resource pools created before the specified time. The time must be a Unix timestamp in UTC+8.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1703820113', 'title' => ''],
+ 'TimeCreatedAfter' => ['description' => 'Returns only resource pools created after the specified time. The time must be a Unix timestamp in UTC+8.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1703819914', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'ResourceId',
+ 'name' => 'PageSize',
'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,
- ],
+ 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
- 'name' => 'Tag',
+ 'name' => 'PageNumber',
'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,
- ],
+ 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'The response body schema.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
+ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
+ 'PageSize' => ['description' => 'The number of entries returned per page. Maximum value: 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
+ 'PoolList' => [
+ 'description' => 'An array of resource pools.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details of a resource pool.',
+ 'type' => 'object',
+ 'properties' => [
+ 'PoolName' => ['description' => 'The name of the resource pool.'."\n"
+ ."\n"
+ .'- Maximum length: 15 characters.'."\n"
+ ."\n"
+ .'- Allowed characters: digits, letters, underscores (\\_), and periods (.).', 'type' => 'string', 'example' => 'PoolTest', 'title' => ''],
+ 'Status' => ['description' => 'The status of the resource pool. Valid values:'."\n"
+ ."\n"
+ .'- Creating: The resource pool is being created.'."\n"
+ ."\n"
+ .'- Updating: The resource pool is being updated.'."\n"
+ ."\n"
+ .'- Deleting: The resource pool is being deleted.'."\n"
+ ."\n"
+ .'- Working: The resource pool is operational.'."\n"
+ ."\n"
+ .'- Deleted: The resource pool has been deleted.', 'type' => 'string', 'example' => 'Working', 'title' => ''],
+ 'Priority' => ['description' => 'The priority of the resource pool.'."\n"
+ ."\n"
+ .'- Valid values: 1 to 99. Default value: 1 (lowest priority).'."\n"
+ ."\n"
+ .'- Jobs in a resource pool with a higher priority are scheduled before those in a pool with a lower priority. The pool\'s priority overrides the priority of an individual job.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'IsDefault' => ['description' => 'Indicates whether the resource pool is the default pool. Valid values:'."\n"
+ ."\n"
+ .'- **true**: The resource pool is the default pool.'."\n"
+ ."\n"
+ .'- **false**: The resource pool is not the default pool.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'MaxExecutorNum' => ['description' => 'The number of running executor nodes in the resource pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'SchedulingPolicyId' => ['description' => 'The ID of the scheduling policy.', 'type' => 'string', 'example' => 'policy-xxx', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the resource pool was created.', 'type' => 'string', 'example' => '2026-04-20 11:09:59', 'title' => ''],
+ 'UpdateTime' => ['description' => 'The time when the resource pool was last updated.', 'type' => 'string', 'example' => '2026-04-20 11:09:59', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'title' => '',
+ 'example' => '',
],
],
- 'description' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParams',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'JobNotFound',
- 'errorMessage' => 'The specified job id is not found.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'InDebt', 'errorMessage' => 'Your account has overdue payments.', 'description' => 'Your account has overdue payments.'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => 'You have not enabled this service'],
],
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' => 'GetResourceFailed', 'errorMessage' => 'Failed to get resource.', 'description' => 'Failed to get resource'],
+ ['errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', 'errorMessage' => 'The resource is out of stock.', 'description' => 'Resources are sold out'],
],
[
- [
- 'errorCode' => 'NotAuthorized',
- 'errorMessage' => 'No authorization is granted.',
- ],
+ ['errorCode' => 'ImageNotFound', 'errorMessage' => 'The specified image does not exist.', 'description' => 'The specified image does not exist. Please verify the parameter.'],
+ ],
+ 406 => [
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'The request has failed due to a temporary failure of the server.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'ListPools',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListPools'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
- 'title' => 'TagResources',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListPools',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ '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 \\"MaxExecutorNum\\": 100,\\n \\"SchedulingPolicyId\\": \\"policy-xxx\\",\\n \\"CreateTime\\": \\"2026-04-20 11:09:59\\",\\n \\"UpdateTime\\": \\"2026-04-20 11:09:59\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'translator' => 'machine',
],
'ListTagResources' => [
'summary' => 'Queries the tags that are bound to one or more Instant resources.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5843,10 +4364,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '240622',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
'autoTest' => true,
],
'parameters' => [
@@ -5862,6 +4380,7 @@
'required' => true,
'example' => 'Job',
'enum' => [],
+ 'title' => '',
],
],
[
@@ -5869,20 +4388,16 @@
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '资源ID,最多 50个子项',
+ 'title' => '',
'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',
- ],
+ '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', 'title' => ''],
'required' => false,
'maxItems' => 51,
+ 'example' => '',
],
],
[
@@ -5890,54 +4405,34 @@
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'title' => '标签列表,最多包含20个子项',
+ 'title' => '',
'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",
- ],
+ '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' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 21,
+ 'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'description' => 'A pagination token.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1d2db86scXXXXXXXXXX',
- ],
+ 'schema' => ['description' => 'A pagination token.'."\n", 'type' => 'string', 'required' => false, 'example' => '1d2db86scXXXXXXXXXX', 'title' => ''],
],
[
'name' => 'MaxResult',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of records per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['description' => 'The number of records per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
@@ -5945,270 +4440,281 @@
'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",
- ],
+ 'NextToken' => ['title' => '', '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", 'title' => ''],
'TagResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagResource' => [
- 'title' => '资源列表',
+ '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',
- ],
+ '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' => '', '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' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParams',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'JobNotFound',
- 'errorMessage' => 'The specified job id is not found.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job id is not found.', 'description' => 'Job ID not found'],
],
403 => [
- [
- 'errorCode' => 'DuplicateTagKey',
- 'errorMessage' => 'Duplicate tag key exists: %s.',
- ],
- [
- 'errorCode' => 'ExecutorNotFound',
- 'errorMessage' => 'The specified job executor was not found.',
- ],
+ ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Duplicate tag key exists: %s.', 'description' => 'Duplicate tag key exists.'],
+ ['errorCode' => 'ExecutorNotFound', 'errorMessage' => 'The specified job executor was not found.', 'description' => 'Specified Executor not found'],
],
406 => [
- [
- 'errorCode' => 'TagError',
- 'errorMessage' => 'Tag operation error.',
- ],
+ ['errorCode' => 'TagError', 'errorMessage' => 'Tag operation error.', 'description' => 'Tag operation error.'],
],
[
- [
- 'errorCode' => 'NotAuthorized',
- 'errorMessage' => 'No authorization is granted.',
- ],
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'No authorization is granted.', 'description' => 'No authorization is granted.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'The request has failed due to a temporary failure of the server.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- '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',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListTagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ '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"}]',
+ ],
+ 'RemoveImage' => [
+ 'summary' => 'Remove a custom image',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '240623',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
- 'autoTest' => true,
+ 'abilityTreeCode' => '219056',
+ 'abilityTreeNodes' => ['FEATUREehpcE21063'],
],
'parameters' => [
[
- 'name' => 'ResourceType',
+ 'name' => 'ImageType',
'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' => [],
- ],
+ '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', 'title' => ''],
],
[
- 'name' => 'ResourceId',
+ 'name' => 'ImageId',
'in' => 'query',
- 'style' => 'repeatList',
+ 'schema' => ['description' => 'The image ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'm-bp14wakr1rkxtb******', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'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"
+ '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"
- .'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",
+ .'* true'."\n"
+ .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
- 'required' => true,
- 'maxItems' => 50,
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'ImageAlreadyExists', 'errorMessage' => 'The image id already exists.', 'description' => 'Mirror already exists'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => 'You have not enabled this service'],
+ ],
+ 403 => [
+ ['errorCode' => 'ImageInUse', 'errorMessage' => 'Image is still used by jobs.', 'description' => 'Mirror still in use'],
+ ],
[
- '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",
+ ['errorCode' => 'ImageNotFound', 'errorMessage' => 'The specified image does not exist.', 'description' => 'The specified image does not exist. Please verify the parameter.'],
+ ],
+ 406 => [
+ ['errorCode' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
+ ['errorCode' => 'ServiceAPIError', 'errorMessage' => 'Failed to call the operation. Cause:%s.', 'description' => 'An error occurred while calling the API. %s.'],
+ ],
+ [
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'No authorization is granted.', 'description' => 'No authorization is granted.'],
+ ],
+ 503 => [
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveImage'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ehpc:RemoveImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
],
- 'required' => false,
- 'maxItems' => 20,
],
],
+ ],
+ ],
+ 'SynchronizeApp' => [
+ 'summary' => 'Application cross-region synchronization',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'All',
+ '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', 'title' => ''],
+ ],
+ [
+ 'name' => 'TargetRegionIds',
+ 'in' => 'query',
+ 'style' => 'json',
'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',
+ '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', 'title' => ''],
'required' => false,
- 'example' => 'False',
+ 'enumValueTitles' => [],
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
],
- 'description' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParams',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'JobNotFound',
- 'errorMessage' => 'The specified job id is not found.',
- ],
+ ['errorCode' => 'ImageAlreadyExists', 'errorMessage' => 'The image id already exists.', 'description' => 'Mirror already exists'],
],
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' => 'InvalidParams', 'errorMessage' => 'Invalid parameters: %s.', 'description' => 'Request parameter error:%s.'],
],
[
- [
- 'errorCode' => 'NotAuthorized',
- 'errorMessage' => 'No authorization is granted.',
- ],
+ ['errorCode' => 'ImageNotFound', 'errorMessage' => 'The specified image does not exist.', 'description' => 'The specified image does not exist. Please verify the parameter.'],
+ ],
+ 406 => [
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
+ ['errorCode' => 'ServiceAPIError', 'errorMessage' => 'Failed to call the operation. Cause:%s.', 'description' => 'An error occurred while calling the API. %s.'],
+ ['errorCode' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'The request has failed due to a temporary failure of the server.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ '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',
+ 'title' => 'SynchronizeApp',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ehpc:SynchronizeApp',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'TagResources' => [
+ 'summary' => 'Create and bind tags to Instant resource list',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6220,141 +4726,127 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '248937',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '239758',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
+ 'autoTest' => true,
],
'parameters' => [
[
- 'name' => 'PoolName',
+ 'name' => 'ResourceType',
'in' => 'query',
'schema' => [
- 'description' => 'The name of the resource pool.'."\n"
+ 'title' => '',
+ 'description' => 'The type of the resource. Valid values:'."\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",
+ .'* Job'."\n"
+ .'* Executor'."\n",
'type' => 'string',
'required' => true,
- 'example' => 'PoolTest',
- 'maxLength' => 32,
+ 'example' => 'Job',
+ 'enum' => [],
],
],
[
- 'name' => 'Priority',
+ 'name' => 'ResourceId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The priority of the resource pool.'."\n"
+ 'title' => '',
+ 'description' => 'The list of resource IDs. Valid values of N: 1 to 50.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The resource ID.'."\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',
+ .'* 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', 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 51,
+ 'example' => '',
],
],
[
- 'name' => 'ResourceLimits',
+ 'name' => 'Tag',
'in' => 'query',
- 'style' => 'json',
+ 'style' => 'repeatList',
'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',
+ 'title' => '',
+ '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' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'required' => false,
+ 'required' => true,
+ 'maxItems' => 21,
+ 'example' => '',
],
],
],
'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****',
- ],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job id is not found.', 'description' => 'Job ID not found'],
],
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.', 'description' => 'Duplicate tag key exists.'],
+ ['errorCode' => 'ExecutorNotFound', 'errorMessage' => 'The specified job executor was not found.', 'description' => 'Specified Executor 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.',
- ],
+ ['errorCode' => 'TagError', 'errorMessage' => 'Tag operation error.', 'description' => 'Tag operation error.'],
+ ],
+ [
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'No authorization is granted.', 'description' => 'No authorization is granted.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'The request has failed due to a temporary failure of the server.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'TagResources',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ehpc:TagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
'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',
- ],
+ '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' => [],
@@ -6363,182 +4855,163 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '257986',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
+ 'abilityTreeCode' => '240623',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PoolName',
+ 'name' => 'ResourceType',
'in' => 'query',
'schema' => [
- 'description' => 'The name of the resource pool.'."\n"
+ 'title' => '',
+ 'description' => 'The type of the resource. Valid values:'."\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",
+ .'* Job'."\n"
+ .'* Executor'."\n",
'type' => 'string',
'required' => true,
- 'example' => 'PoolTest',
+ 'example' => 'Job'."\n",
+ 'enum' => [],
],
],
[
- 'name' => 'Priority',
+ 'name' => 'ResourceId',
'in' => 'query',
+ 'style' => 'repeatList',
'schema' => [
- 'description' => 'The priority of the resource pool.'."\n"
+ 'title' => '',
+ 'description' => 'The list of resource IDs. Valid values of N: 1 to 50.'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => 'The resource ID.'."\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',
+ .'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", 'title' => ''],
+ 'required' => true,
+ 'maxItems' => 50,
+ 'example' => '',
],
],
[
- 'name' => 'ResourceLimits',
+ 'name' => 'TagKey',
'in' => 'query',
- 'style' => 'json',
+ 'style' => 'repeatList',
'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',
- ],
- ],
+ '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", 'title' => ''],
'required' => false,
+ 'maxItems' => 20,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ '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', 'title' => ''],
+ ],
],
'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",
- ],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'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' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'JobNotFound', 'errorMessage' => 'The specified job id is not found.', 'description' => 'Job ID not found'],
],
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' => 'DuplicateTagKey', 'errorMessage' => 'Duplicate tag key exists: %s.', 'description' => 'Duplicate tag key exists.'],
+ ['errorCode' => 'ExecutorNotFound', 'errorMessage' => 'The specified job executor was not found.', 'description' => 'Specified Executor 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.',
- ],
+ ['errorCode' => 'TagError', 'errorMessage' => 'Tag operation error.', 'description' => 'Tag operation error.'],
+ ],
+ [
+ ['errorCode' => 'NotAuthorized', 'errorMessage' => 'No authorization is granted.', 'description' => 'No authorization is granted.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => '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',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
+ 'title' => 'UnTagResources',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnTagResources'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ehpc:UnTagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateActionPlan' => [
+ 'summary' => 'Adjust the resource scale of the execution plan or modify the execution status',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '250272',
- 'abilityTreeNodes' => [
- 'FEATUREehpcKIUG5Z',
- ],
+ 'operationType' => 'update',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREehpc11IJC9'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'PoolName',
+ 'name' => 'ActionPlanId',
'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',
- ],
+ 'schema' => ['description' => 'The ID of the execution plan.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ap-hz036ubmx2qmw93k****', 'title' => ''],
+ ],
+ [
+ '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', 'title' => ''],
+ ],
+ [
+ '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', 'title' => ''],
],
],
'responses' => [
@@ -6548,412 +5021,102 @@
'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: ***.',
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n"],
],
+ 'example' => '',
],
],
],
'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' => 'NotExisted.ActionPlan', 'errorMessage' => 'The specified action plan does not exist.', 'description' => 'The specified execution plan does not exist.'],
],
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' => 'InvalidStatus.ActionPlan', 'errorMessage' => 'The current status of the execution plan does not support this operation. Please try again later.', 'description' => 'The current status of the execution plan does not support this operation. Please try again later.'],
],
- 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.',
- ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\"\\n}","type":"json"}]',
+ 'title' => 'UpdateActionPlan',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateActionPlan'],
],
- 503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ehpc:UpdateActionPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- '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',
- ],
+ 'UpdateJobRecordDuration' => [
+ 'summary' => 'Updates the job record duration.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
+ 'operationType' => 'update',
+ 'riskType' => 'high',
'chargeType' => 'free',
- 'abilityTreeCode' => '249321',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
+ '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',
+ 'name' => 'JobRecordDuration',
'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',
- ],
+ 'schema' => ['description' => 'The job record duration, in days. The value must be an integer from 1 to 30. Default value: 30.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30', 'title' => ''],
],
],
'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',
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****'],
],
+ 'title' => '',
+ 'description' => 'Response object.',
+ 'example' => '',
],
],
],
'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.',
- ],
+ ['errorCode' => 'InvalidParams', 'errorMessage' => 'Invalid parameters: %s.', 'description' => 'Request parameter error:%s.'],
],
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.',
- ],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpdateJobRecordDuration',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- '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',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
],
- 'DeletePool' => [
- 'summary' => 'You can execute this statement to delete a resource pool.',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdatePool' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6962,14 +5125,11 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '249322',
- 'abilityTreeNodes' => [
- 'FEATUREehpcSHKJ2Q',
- 'FEATUREehpcKIUG5Z',
- ],
+ 'abilityTreeCode' => '257986',
+ 'abilityTreeNodes' => ['FEATUREehpcSHKJ2Q', 'FEATUREehpcKIUG5Z'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -6977,159 +5137,777 @@
[
'name' => 'PoolName',
'in' => 'query',
+ 'schema' => ['description' => 'The name of the resource pool.'."\n"
+ ."\n"
+ .'- The name can be up to 15 characters long.'."\n"
+ ."\n"
+ .'- The name can contain digits, uppercase letters, lowercase letters, underscores (\\_), and periods (.).', 'type' => 'string', 'required' => true, 'example' => 'PoolTest', 'title' => ''],
+ ],
+ [
+ 'name' => 'Priority',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The priority of the resource pool.'."\n"
+ ."\n"
+ .'- Valid values: 1 to 99. The default value is 1, which specifies the lowest priority.'."\n"
+ ."\n"
+ .'- Jobs in a higher-priority resource pool are scheduled before pending jobs in lower-priority pools. A resource pool\'s priority overrides a job\'s priority.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
+ ],
+ [
+ 'name' => 'ResourceLimits',
+ 'in' => 'query',
+ 'style' => 'json',
'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',
+ 'description' => 'The limits on the resources that a user can use concurrently in the resource pool.',
+ 'type' => 'object',
+ 'properties' => [
+ 'MaxExecutorNum' => ['description' => 'The maximum number of executor nodes that a user can run concurrently in a resource pool.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
+ [
+ 'name' => 'SchedulingPolicyId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The ID of the scheduling policy.', 'type' => 'string', 'example' => 'policy-xxxx', 'title' => '', 'required' => false],
+ ],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response'."\n",
+ 'description' => 'The response body.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request'."\n",
- 'type' => 'string',
- 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n"],
],
+ 'example' => '',
],
],
],
'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' => 'InvalidParams', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter %s is invalid.'],
+ ['errorCode' => 'InDebt', 'errorMessage' => 'Your account has overdue payments.', 'description' => 'Your account has overdue payments.'],
+ ['errorCode' => 'NotEnabled', 'errorMessage' => 'You have not enabled this service.', 'description' => '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.',
- ],
+ ['errorCode' => 'GetResourceFailed', 'errorMessage' => 'Failed to get resource.', 'description' => 'Failed to get resource'],
+ ['errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', 'errorMessage' => 'The resource is out of stock.', 'description' => 'Resources are sold out'],
+ ['errorCode' => 'PoolNotFound', 'errorMessage' => 'The specified pool was not found.', 'description' => 'Resource pool does not exist'],
+ ['errorCode' => 'PoolStatusInvalid', 'errorMessage' => 'The specified pool in invalid status.', 'description' => 'Invalid Resource Pool 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.',
- ],
+ ['errorCode' => 'AliyunError', 'errorMessage' => 'An Alibaba Cloud product error occurred.', 'description' => 'Alibaba Cloud product error. %s'],
+ ['errorCode' => 'EcsError', 'errorMessage' => 'An error occurred while calling the ECS API operation.', 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['errorCode' => 'DbError', 'errorMessage' => 'A database error occurred.', 'description' => 'A database error occurred.'],
],
503 => [
- [
- 'errorCode' => 'ServiceUnavailable',
- 'errorMessage' => 'The request has failed due to a temporary failure of the server.',
- ],
+ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'The request has failed due to a temporary failure of the server.', 'description' => 'The request has failed due to a temporary failure of the server.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'UpdatePool',
+ 'summary' => 'Updates the configuration of a resource pool.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdatePool'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ehpc:UpdatePool',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]',
- 'title' => 'DeletePool',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.cn-shenzhen.aliyuncs.com', 'endpoint' => 'ehpcinstant.cn-shenzhen.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'ehpcinstant.cn-wulanchabu.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.cn-wulanchabu.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.cn-beijing.aliyuncs.com', 'endpoint' => 'ehpcinstant.cn-beijing.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.ap-northeast-2.aliyuncs.com', 'endpoint' => 'ehpcinstant.ap-northeast-2.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.ap-northeast-2.aliyuncs.com'],
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.ap-northeast-1.aliyuncs.com', 'endpoint' => 'ehpcinstant.ap-northeast-1.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.cn-chengdu.aliyuncs.com', 'endpoint' => 'ehpcinstant.cn-chengdu.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.cn-chengdu.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.cn-shanghai.aliyuncs.com', 'endpoint' => 'ehpcinstant.cn-shanghai.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.cn-guangzhou.aliyuncs.com', 'endpoint' => 'ehpcinstant.cn-guangzhou.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.cn-guangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.cn-hongkong.aliyuncs.com', 'endpoint' => 'ehpcinstant.cn-hongkong.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.cn-heyuan.aliyuncs.com', 'endpoint' => 'ehpcinstant.cn-heyuan.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.cn-heyuan.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.ap-southeast-1.aliyuncs.com', 'endpoint' => 'ehpcinstant.ap-southeast-1.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.ap-southeast-3.aliyuncs.com', 'endpoint' => 'ehpcinstant.ap-southeast-3.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.ap-southeast-3.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.ap-southeast-5.aliyuncs.com', 'endpoint' => 'ehpcinstant.ap-southeast-5.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ehpcinstant.cn-hangzhou.aliyuncs.com', 'endpoint' => 'ehpcinstant.cn-hangzhou.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ehpcinstant.eu-central-1.aliyuncs.com', 'endpoint' => 'ehpcinstant.eu-central-1.aliyuncs.com', 'vpc' => 'ehpcinstant-vpc.eu-central-1.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AliyunError', 'message' => 'An Alibaba Cloud product error occurred.', 'http_code' => 406, 'description' => 'Alibaba Cloud product error. %s'],
+ ['code' => 'AppInstanceNotFound', 'message' => 'The specified application instance %s does not exist.', 'http_code' => 404, 'description' => 'The specified application instance does not exist. Please verify the parameter.'],
+ ['code' => 'AppNotFound', 'message' => 'The specified application %s does not exist.', 'http_code' => 404, 'description' => 'The specified application does not exist. Please verify the parameter.'],
+ ['code' => 'DbError', 'message' => 'A database error occurred.', 'http_code' => 406, 'description' => 'A database error occurred.'],
+ ['code' => 'DuplicateTagKey', 'message' => 'Duplicate tag key exists: %s.', 'http_code' => 403, 'description' => 'Duplicate tag key exists.'],
+ ['code' => 'EcsError', 'message' => 'An error occurred while calling the ECS API operation.', 'http_code' => 406, 'description' => 'An error occurred while calling the ECS API operation.'],
+ ['code' => 'EntityNotExist.Role', 'message' => 'AliyunServiceRoleForEHPCManagedNetwork is not authorized by your account.', 'http_code' => 407, 'description' => 'Your account is not authorized to E-HPC the Instant product system role: AliyunServiceRoleForEHPCManagedNetwork, please authorize the role according to the document.'],
+ ['code' => 'ExecutorNotFound', 'message' => 'The specified job executor was not found.', 'http_code' => 403, 'description' => 'Specified Executor not found'],
+ ['code' => 'GetResourceFailed', 'message' => 'Failed to get resource.', 'http_code' => 403, 'description' => 'Failed to get resource'],
+ ['code' => 'ImageAlreadyExists', 'message' => 'The image id already exists.', 'http_code' => 400, 'description' => 'Mirror already exists'],
+ ['code' => 'ImageInUse', 'message' => 'Image is still used by jobs.', 'http_code' => 403, 'description' => 'Mirror still in use'],
+ ['code' => 'ImageNotFound', 'message' => 'The specified image does not exist.', 'http_code' => 404, 'description' => 'The specified image does not exist. Please verify the parameter.'],
+ ['code' => 'InDebt', 'message' => 'Your account has overdue payments.', 'http_code' => 400, 'description' => 'Your account has overdue payments.'],
+ ['code' => 'InvalidParams', 'message' => 'The specified parameter %s is invalid.', 'http_code' => 400, 'description' => 'The specified parameter %s is invalid.'],
+ ['code' => 'InvalidParams', 'message' => 'Invalid parameters: %s.', 'http_code' => 403, 'description' => 'Request parameter error:%s.'],
+ ['code' => 'InvalidStatus.ActionPlan', 'message' => 'The current status of the execution plan does not support this operation. Please try again later.', 'http_code' => 403, 'description' => 'The current status of the execution plan does not support this operation. Please try again later.'],
+ ['code' => 'JobNotFound', 'message' => 'The specified job id is not found.', 'http_code' => 400, 'description' => 'Job ID not found'],
+ ['code' => 'NotAuthorized', 'message' => 'No authorization is granted.', 'http_code' => 407, 'description' => 'No authorization is granted.'],
+ ['code' => 'NotEnabled', 'message' => 'You have not enabled this service.', 'http_code' => 400, 'description' => 'You have not enabled this service'],
+ ['code' => 'NotExisted.ActionPlan', 'message' => 'The specified action plan does not exist.', 'http_code' => 400, 'description' => 'The specified execution plan does not exist.'],
+ ['code' => 'PoolAlreadyExists', 'message' => 'The pool already exists.', 'http_code' => 400, 'description' => 'Pool already exists'],
+ ['code' => 'PoolInUse', 'message' => 'The specified pool is in use.', 'http_code' => 403, 'description' => 'Resource pool is in use.'],
+ ['code' => 'PoolNotFound', 'message' => 'The specified pool was not found.', 'http_code' => 403, 'description' => 'Resource pool does not exist'],
+ ['code' => 'PoolStatusInvalid', 'message' => 'The specified pool in invalid status.', 'http_code' => 403, 'description' => 'Invalid Resource Pool Status'],
+ ['code' => 'QuotaError', 'message' => 'Quota error: %s.', 'http_code' => 406, 'description' => 'Quota error: %s.'],
+ ['code' => 'QuotaExceeded.ActionPlan', 'message' => 'The number of action plans in the current account has exceeded quota.', 'http_code' => 406, 'description' => 'The number of execution plans under the current account exceeds the limit of execution plans under the user account.'],
+ ['code' => 'QuotaExceeded.JobQuota', 'message' => 'The number of jobs or executors in the current region exceeds the limit.', 'http_code' => 406, 'description' => 'The number of jobs or executors in the current region exceeds the limit.'],
+ ['code' => 'QuotaExceeded.PrivateIpAddress', 'message' => 'Insufficient private IP addresses in vSwitch: %s.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'QuotaExceeded.Resource', 'message' => 'Insufficient resource quota.', 'http_code' => 403, 'description' => 'Insufficient resource quota'],
+ ['code' => 'RecommendEmpty.InstanceTypeSoldOut', 'message' => 'The resource is out of stock.', 'http_code' => 403, 'description' => 'Resources are sold out'],
+ ['code' => 'SecurityGroupInstanceLimitExceed', 'message' => 'The maximum number of instances in a security group is exceeded.', 'http_code' => 403, 'description' => 'The number of instances in the security group has reached the maximum limit.'],
+ ['code' => 'SecurityGroupNotExists', 'message' => 'The security group does not exist.', 'http_code' => 404, 'description' => 'The security group does not exist.'],
+ ['code' => 'ServiceAPIError', 'message' => 'Failed to call the operation. Cause:%s.', 'http_code' => 406, 'description' => 'An error occurred while calling the API. %s.'],
+ ['code' => 'ServiceUnavailable', 'message' => 'The request has failed due to a temporary failure of the server.', 'http_code' => 503, 'description' => 'The request has failed due to a temporary failure of the server.'],
+ ['code' => 'TagError', 'message' => 'Tag operation error.', 'http_code' => 406, 'description' => 'Tag operation error.'],
+ ['code' => 'PoolAccessDenied', 'message' => 'The account does not have permission to access the specified pool.', 'http_code' => 403, 'description' => 'The sub-account does not have permission to operate the specified resource pool. Please contact the main account for authorization.'],
+ ['code' => 'QuotaExceeded.Executor', 'message' => 'Insufficient pool executor quota.', 'http_code' => 403, 'description' => 'The resource pool execution node quota is insufficient.'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListExecutors'],
+ ],
+ 'createdAt' => '2025-11-27T03:42:21.000Z',
+ 'description' => '',
+ ],
[
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'ehpcinstant.cn-beijing.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetJob'],
+ ['description' => 'Response parameters changed', 'api' => 'ListJobs'],
+ ],
+ 'createdAt' => '2025-05-09T05:40:13.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'ehpcinstant.cn-wulanchabu.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateJob'],
+ ['description' => 'Response parameters changed', 'api' => 'GetJob'],
+ ],
+ 'createdAt' => '2025-03-13T06:53:01.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'ehpcinstant.cn-hangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateJob'],
+ ['description' => 'Response parameters changed', 'api' => 'GetJob'],
+ ],
+ 'createdAt' => '2025-02-20T02:20:10.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'ehpcinstant.cn-shanghai.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListJobExecutors'],
+ ],
+ 'createdAt' => '2025-01-02T10:01:00.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'ehpcinstant.cn-shenzhen.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateJob'],
+ ],
+ 'createdAt' => '2024-12-30T12:12:19.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-heyuan',
- 'endpoint' => 'ehpcinstant.cn-heyuan.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListExecutors'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListJobExecutors'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListJobs'],
+ ],
+ 'createdAt' => '2024-12-30T12:09:21.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-guangzhou',
- 'endpoint' => 'ehpcinstant.cn-guangzhou.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'CreateJob'],
+ ],
+ 'createdAt' => '2024-12-19T08:47:21.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'ehpcinstant.cn-chengdu.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListImages'],
+ ],
+ 'createdAt' => '2024-12-18T06:59:41.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'ehpcinstant.cn-hongkong.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetImage'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListImages'],
+ ],
+ 'createdAt' => '2024-12-05T05:46:07.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'ehpcinstant.ap-northeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListImages'],
+ ],
+ 'createdAt' => '2024-11-18T03:06:09.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'ehpcinstant.ap-southeast-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetJob'],
+ ],
+ 'createdAt' => '2024-11-13T06:50:15.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'ehpcinstant.ap-southeast-5.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateJob'],
+ ['description' => 'Response parameters changed', 'api' => 'ListExecutors'],
+ ['description' => 'Response parameters changed', 'api' => 'ListJobExecutors'],
+ ['description' => 'Response parameters changed', 'api' => 'ListJobs'],
+ ],
+ 'createdAt' => '2024-11-11T05:47:50.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'ehpcinstant.eu-central-1.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'AddImage'],
+ ['description' => 'Request parameters changed', 'api' => 'RemoveImage'],
+ ],
+ 'createdAt' => '2024-10-23T07:38:33.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-northeast-2',
- 'endpoint' => 'ehpcinstant.ap-northeast-2.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListExecutors'],
+ ],
+ 'createdAt' => '2024-09-19T01:30:44.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'ehpcinstant.ap-southeast-3.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateJob'],
+ ['description' => 'Response parameters changed', 'api' => 'GetJob'],
+ ['description' => 'Response parameters changed', 'api' => 'ListJobExecutors'],
+ ],
+ 'createdAt' => '2024-09-18T13:49:01.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListExecutors'],
+ ['description' => 'Response parameters changed', 'api' => 'ListJobExecutors'],
+ ],
+ 'createdAt' => '2024-08-14T07:16:50.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'RemoveImage'],
+ ],
+ 'createdAt' => '2024-07-09T09:28:15.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateJob'],
+ ],
+ 'createdAt' => '2024-05-14T06:29:00.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed, Request parameters changed, Response parameters changed', 'api' => 'GetImage'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListImages'],
+ ],
+ 'createdAt' => '2024-05-14T03:59:04.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed, Response parameters changed', 'api' => 'CreateJob'],
+ ],
+ 'createdAt' => '2024-05-11T08:41:53.000Z',
+ 'description' => '',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateActionPlan'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdatePool'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetJob'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetPool'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListImages'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListExecutors'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteActionPlan'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListActionPlans'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAppVersions'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeJobMetricLast'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateJob'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListPools'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SynchronizeApp'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveImage'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateActionPlan'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetActionPlan'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnTagResources'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeJobMetricData'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddImage'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePool'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetImage'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListJobExecutors'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePool'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListActionPlanActivities'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteJobs'],
+ ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListJobs'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'Ehpc',
+ 'productName' => 'Elastic High Performance Computing',
+ 'ramCodes' => ['ehpc'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'AddImage',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ehpc:AddImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListExecutors',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListExecutors',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListActionPlans',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListActionPlans',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreatePool',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ehpc:CreatePool',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetImage',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetActionPlan',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetActionPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListJobs',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListJobs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListJobExecutors',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListJobExecutors',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateActionPlan',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ehpc:UpdateActionPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTagResources',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListTagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListActionPlanActivities',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListActionPlanActivities',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetPool',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetPool',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteActionPlan',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ehpc:DeleteActionPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteJobs',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:DeleteJobs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListPools',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListPools',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeletePool',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ehpc:DeletePool',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'TagResources',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ehpc:TagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeJobMetricLast',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'ehpc:DescribeJobMetricLast',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListExecutorEvents',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListExecutorEvents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SynchronizeApp',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ehpc:SynchronizeApp',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetJob',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeJobResults',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:DescribeJobResults',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeJobMetricData',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:DescribeJobMetricData',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetJobRecordDuration',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetJobRecordDuration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdatePool',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'ehpc:UpdatePool',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateActionPlan',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ehpc:CreateActionPlan',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RemoveImage',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ehpc:RemoveImage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAppVersions',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:GetAppVersions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteJobRecords',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ehpc:DeleteJobRecords',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListImages',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'ehpc:ListImages',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateJob',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'ehpc:CreateJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UnTagResources',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'ehpc:UnTagResources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Ehpc', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];