From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- data/zh_cn/ehpcinstant/2023-07-01/api-docs.php | 7173 ++++++++++++++++++++++++ 1 file changed, 7173 insertions(+) create mode 100644 data/zh_cn/ehpcinstant/2023-07-01/api-docs.php (limited to 'data/zh_cn/ehpcinstant/2023-07-01') diff --git a/data/zh_cn/ehpcinstant/2023-07-01/api-docs.php b/data/zh_cn/ehpcinstant/2023-07-01/api-docs.php new file mode 100644 index 0000000..d8af2ef --- /dev/null +++ b/data/zh_cn/ehpcinstant/2023-07-01/api-docs.php @@ -0,0 +1,7173 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'EhpcInstant', + 'version' => '2023-07-01', + ], + 'directories' => [ + [ + 'id' => 380391, + 'title' => '执行计划', + 'type' => 'directory', + 'children' => [ + 'CreateActionPlan', + 'UpdateActionPlan', + 'ListActionPlans', + 'ListActionPlanActivities', + 'GetActionPlan', + 'DeleteActionPlan', + ], + ], + [ + 'id' => 380398, + 'title' => '镜像', + 'type' => 'directory', + 'children' => [ + 'AddImage', + 'GetImage', + 'ListImages', + 'RemoveImage', + 'GetAppVersions', + 'SynchronizeApp', + ], + ], + [ + 'id' => 380405, + 'title' => '作业', + 'type' => 'directory', + 'children' => [ + 'CreateJob', + 'GetJob', + 'ListJobs', + 'DeleteJobs', + 'ListJobExecutors', + 'ListExecutors', + 'ListExecutorEvents', + 'DeleteJobRecords', + 'DescribeJobResults', + ], + ], + [ + 'id' => 380415, + 'title' => '监控', + 'type' => 'directory', + 'children' => [ + 'DescribeJobMetricData', + 'DescribeJobMetricLast', + ], + ], + [ + 'id' => 380418, + 'title' => '标签', + 'type' => 'directory', + 'children' => [ + 'TagResources', + 'ListTagResources', + 'UnTagResources', + ], + ], + [ + 'id' => 380422, + 'title' => '资源池', + 'type' => 'directory', + 'children' => [ + 'CreatePool', + 'UpdatePool', + 'GetPool', + 'ListPools', + 'DeletePool', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateActionPlan' => [ + 'summary' => '创建一个E-HPC的执行计划。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREehpc11IJC9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ActionPlanName', + 'in' => 'query', + 'schema' => [ + 'title' => '执行计划的名称。', + 'description' => '执行计划的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestActionPlan', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ci-vm-rYfypJKwlN9Y', + ], + ], + [ + 'name' => 'Script', + 'in' => 'query', + 'schema' => [ + 'title' => '运行作业脚本。需Base64编码。', + 'description' => '运行作业脚本。需Base64编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==', + ], + ], + [ + 'name' => 'PrologScript', + 'in' => 'query', + 'schema' => [ + 'title' => '前处理脚本。需Base64编码。', + 'description' => '前处理脚本。需Base64编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '执行目标资源类型：vCPU容量或者执行节点数。取值范围如下：'."\n" + ."\n" + .'- VCpuCapacity：vCPU容量'."\n" + ."\n" + .'- ExecutorCapacity：执行节点数', + 'description' => '执行目标资源类型：vCPU容量或者执行节点数。取值范围如下：'."\n" + ."\n" + .'- VCpuCapacity：vCPU容量'."\n" + ."\n" + .'- ExecutorCapacity：执行节点数', + 'type' => 'string', + 'required' => false, + 'example' => 'VCpuCapacity', + 'enum' => [ + 'VCpuCapacity', + 'ExecutorCapacity', + ], + ], + ], + [ + 'name' => 'DesiredCapacity', + 'in' => 'query', + 'schema' => [ + 'title' => '执行计划期望的资源规模。如果ResourceType是VcpuCapacity的话，该字段表示执行计划希望保有10000vCPU。', + 'description' => '执行计划期望的资源规模。如果ResourceType是VcpuCapacity的话，该字段表示执行计划希望保有10000vCPU。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Resources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '执行计划运行环境的资源配置列表。资源配置支持 1 ～ 10个。', + 'description' => '执行计划运行环境的资源配置列表。资源配置支持 1 ～ 10个。', + 'type' => 'array', + 'items' => [ + 'title' => '执行计划运行环境的资源配置列表。资源配置支持 1 ～ 10个。', + 'description' => '执行计划运行环境的资源配置。', + 'type' => 'object', + 'properties' => [ + 'Cores' => [ + 'title' => '运行环境的CPU数。', + 'description' => '运行环境的CPU数。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '2', + ], + 'Memory' => [ + 'title' => '运行环境的内存大小。单位是GiB。', + 'description' => '运行环境的内存大小。单位是GiB。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '4', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Regions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '执行计划运行环境的地域资源配置列表。', + 'description' => '执行计划运行环境的地域资源配置列表。', + 'type' => 'array', + 'items' => [ + 'title' => '执行计划运行环境的地域资源配置列表。', + 'description' => '执行计划运行环境的地域资源配置。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'title' => '地域ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'VSwitchIds' => [ + 'title' => '交换机ID，您可以通过[DescribeVSwitches接口](https://api.aliyun.com/document/Vpc/2016-04-28/DescribeVSwitches)查询可用交换机信息。', + 'description' => '执行计划在该地域可用的交换机列表。交换机支持0～5个。', + 'type' => 'array', + 'items' => [ + 'title' => '交换机ID，您可以通过[DescribeVSwitches接口](https://api.aliyun.com/document/Vpc/2016-04-28/DescribeVSwitches)查询可用交换机信息。', + 'description' => '交换机ID，您可以通过[DescribeVSwitches接口](https://api.aliyun.com/document/Vpc/2016-04-28/DescribeVSwitches)查询可用交换机信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-8vb4m54nq1hwtxxda****', + ], + 'required' => false, + ], + 'SecurityGroupId' => [ + 'title' => '交换机ID列表，您可以通过[DescribeSecurityGroups接口](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups)查询可用交换机信息。', + 'description' => '执行计划在该地域可用的安全组列表。安全组支持0～5个。', + 'type' => 'array', + 'items' => [ + 'title' => '交换机ID，您可以通过[DescribeSecurityGroups接口](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups)查询可用交换机信息。', + 'description' => '交换机ID，您可以通过[DescribeSecurityGroups接口](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups)查询可用交换机信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-2zeh9711f6c04bkr****', + ], + 'required' => false, + ], + 'SecurityGroupIds' => [ + 'title' => '交换机ID列表，您可以通过[DescribeSecurityGroups接口](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups)查询可用交换机信息。', + 'type' => 'array', + 'items' => [ + 'title' => '交换机ID，您可以通过[DescribeSecurityGroups接口](https://api.aliyun.com/document/Ecs/2014-05-26/DescribeSecurityGroups)查询可用交换机信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-uf6j4pp39x9k3x05c3vw', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'AllocationSpec', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型。'."\n" + .'- Standard：标准型。', + 'description' => '资源类型。'."\n" + .'- Standard：标准型。'."\n" + .'- Dedicated：专属型，需开通白名单使用。'."\n" + .'- Economic：经济型，需开通白名单使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + ], + ], + [ + 'name' => 'Level', + 'in' => 'query', + 'schema' => [ + 'title' => '算力等级，仅在资源类型为经济型时有效。支持以下类型：'."\n" + .'- General：通用型。'."\n" + .'- Performance：性能型。'."\n" + ."\n" + .'默认值：General', + 'description' => '算力等级，仅在资源类型为经济型时有效。支持以下类型：'."\n" + .'- General：通用型。'."\n" + .'- Performance：性能型。'."\n" + ."\n" + .'默认值：General', + 'type' => 'string', + 'required' => false, + 'example' => 'General', + ], + ], + [ + 'name' => 'IntervalMinutes', + 'in' => 'query', + 'schema' => [ + 'title' => '执行计划的定时周期。单位分钟，取值范围：10 ～ 10080，默认值60。', + 'description' => '执行计划的定时周期。单位分钟，取值范围：10 ～ 10080，默认值60。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'ActionPlanId' => [ + 'title' => '执行计划 ID。', + 'description' => '执行计划 ID。', + 'type' => 'string', + 'example' => 'ap-hz036ubmx2qmw93k****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 406 => [ + [ + 'errorCode' => 'QuotaExceeded.ActionPlan', + 'errorMessage' => 'The number of action plans in the current account has exceeded quota.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"ActionPlanId\\": \\"ap-hz036ubmx2qmw93k****\\"\\n}","type":"json"}]', + 'title' => '创建执行计划', + 'description' => '**请确保在使用该接口前，已充分了解E-HPC Instnat产品的收费方式和[价格](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)。**', + ], + 'UpdateActionPlan' => [ + 'summary' => '调整执行计划资源规模或执行修改状态', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREehpc11IJC9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ActionPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '执行计划 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-hz036ubmx2qmw93k****', + ], + ], + [ + 'name' => 'DesiredCapacity', + 'in' => 'query', + 'schema' => [ + 'description' => '执行计划期望的资源规模。如果ResourceType是VcpuCapacity的话，该字段表示执行计划希望保有10000vCPU。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用执行计划。取值范围：'."\n" + ."\n" + .'- true: 启用执行计划。'."\n" + ."\n" + .'- false：停用执行计划。'."\n" + .'>执行计划停用后，已经创建的Instant作业将不会被执行计划自动管理。>', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IntervalMinutes', + 'in' => 'query', + 'schema' => [ + 'title' => '执行计划的定时周期。单位分钟，取值范围：10 ～ 10080，默认值60。', + 'description' => '执行计划的定时周期。单位分钟，取值范围：10 ～ 10080，默认值60。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '60', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExisted.ActionPlan', + 'errorMessage' => 'The specified action plan does not exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidStatus.ActionPlan', + 'errorMessage' => 'The current status of the execution plan does not support this operation. Please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\"\\n}","type":"json"}]', + 'title' => '更新执行计划。', + ], + 'ListActionPlans' => [ + 'summary' => '查询执行计划列表。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREehpc11IJC9', + ], + ], + 'parameters' => [ + [ + 'name' => 'ActionPlanIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待查询的执行计划 ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待查询的执行计划 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-hz036ubmx2qmw93k****'."\n", + ], + 'required' => false, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始 Token。', + 'type' => 'string', + 'required' => false, + 'example' => '1d2db86scXXXXXXXXXX', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：1~100。'."\n" + ."\n" + .'默认值：20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n", + ], + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'required' => true, + 'example' => '1d2db86scXXXXXXXXXX', + ], + 'MaxResults' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => 'MaxResults本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'ActionPlans' => [ + 'description' => '执行计划结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '执行计划信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '执行计划状态，可能值如下：'."\n" + ."\n" + .'- Active：生效状态。处于生效状态的执行计划才会动态管理Instant任务。'."\n" + ."\n" + .'- Inactive：失效状态。失效状态的执行计划不再管理Instant任务。'."\n" + ."\n" + .'- Deleting：执行计划正在删除中。该状态下执行计划不支持修改参数。', + 'type' => 'string', + 'example' => 'Active', + ], + 'ActionPlanId' => [ + 'description' => '执行计划 ID。', + 'type' => 'string', + 'example' => 'ap-hz036ubmx2qmw93k****'."\n", + ], + 'ActionPlanName' => [ + 'description' => '执行计划的名称。', + 'type' => 'string', + 'example' => 'TestActionPlan', + ], + 'CreateTime' => [ + 'description' => '执行计划的创建时间。', + 'type' => 'string', + 'example' => '2025-08-10 17:58:24 ', + ], + 'UpdateTime' => [ + 'description' => '执行计划的上次修改时间。以ISO 8601为标准，并使用UTC+0时间，格式为yyyy-MM-ddTHH：mmZ。', + 'type' => 'string', + 'example' => '2025-08-10 17:58:24 '."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExisted.ActionPlan', + 'errorMessage' => 'The specified action plan does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 10,\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\",\\n \\"NextToken\\": \\"1d2db86scXXXXXXXXXX\\",\\n \\"MaxResults\\": 20,\\n \\"ActionPlans\\": [\\n {\\n \\"Status\\": \\"Active\\",\\n \\"ActionPlanId\\": \\"ap-hz036ubmx2qmw93k****\\\\n\\",\\n \\"ActionPlanName\\": \\"TestActionPlan\\",\\n \\"CreateTime\\": \\"2025-08-10 17:58:24\\\\t\\",\\n \\"UpdateTime\\": \\"2025-08-10 17:58:24\\\\t\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询执行计划列表。', + ], + 'ListActionPlanActivities' => [ + 'summary' => '查询执行计划的执行情况。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREehpc11IJC9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ActionPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '执行计划 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-hz036ubmx2qmw93k****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始 Token。', + 'type' => 'string', + 'required' => false, + 'example' => '1d2db86scXXXXXXXXXX', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的最大数据条数。'."\n" + ."\n" + .'取值范围：1~100。'."\n" + ."\n" + .'默认值：20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'description' => '表示当前调用返回读取到的位置，空代表数据已经读取完毕', + 'type' => 'string', + 'required' => true, + 'example' => '1d2db86scXXXXXXXXXX', + ], + 'MaxResults' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => 'MaxResults本次请求所返回的最大记录条数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'ActionPlanActivities' => [ + 'description' => '执行计划执行详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '执行计划执行详情。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '执行计划活动实施状态。取值范围：'."\n" + ."\n" + .'- InProcess：进行中；'."\n" + ."\n" + .'- Completed：已完成；'."\n" + ."\n" + .'- Failed：失败；', + 'type' => 'string', + 'example' => 'InProcess', + ], + 'EndTime' => [ + 'description' => '执行计划活动实施结束时间。', + 'type' => 'string', + 'example' => '2025-08-10 18:28:05'."\n", + ], + 'CreatedCapacity' => [ + 'description' => '本次执行计划活动增加的容量。', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'Jobs' => [ + 'description' => '本次执行计划执行涉及到的Instant作业信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '本次执行计划执行涉及到的Instant作业信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'JobOperationType' => [ + 'description' => '本次执行计划活动对作业的操作类型，可能值如下：'."\n" + ."\n" + .'- Create：创建Instant作业；'."\n" + ."\n" + .'- Delete：删除作业；', + 'type' => 'string', + 'example' => 'Create', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'job-hz12dqq8y3ormo1hz49h', + ], + ], + ], + ], + 'StartTime' => [ + 'description' => '执行计划活动实施开始时间。', + 'type' => 'string', + 'example' => '2025-08-10 18:28:05'."\n", + ], + 'ActionPlanActivityId' => [ + 'description' => '执行计划的活动 ID。', + 'type' => 'string', + 'example' => 'et-4119e3f60eb34fc4', + ], + 'DestroyCapacity' => [ + 'description' => '本次执行计划活动释放的容量。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExisted.ActionPlan', + 'errorMessage' => 'The specified action plan does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 40,\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"NextToken\\": \\"1d2db86scXXXXXXXXXX\\",\\n \\"MaxResults\\": 100,\\n \\"ActionPlanActivities\\": [\\n {\\n \\"Status\\": \\"InProcess\\",\\n \\"EndTime\\": \\"2025-08-10 18:28:05\\\\n\\",\\n \\"CreatedCapacity\\": 100,\\n \\"Jobs\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"JobOperationType\\": \\"Create\\",\\n \\"JobId\\": \\"job-hz12dqq8y3ormo1hz49h\\"\\n }\\n ],\\n \\"StartTime\\": \\"2025-08-10 18:28:05\\\\n\\",\\n \\"ActionPlanActivityId\\": \\"et-4119e3f60eb34fc4\\",\\n \\"DestroyCapacity\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询执行计划的执行情况。', + ], + 'GetActionPlan' => [ + 'summary' => '查询执行计划详情', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREehpc11IJC9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ActionPlanId', + 'in' => 'query', + 'schema' => [ + 'title' => '执行计划 ID。', + 'description' => '执行计划 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-hz036ubmx2qmw93k****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'ActionPlanId' => [ + 'title' => '执行计划 ID。', + 'description' => '执行计划 ID。', + 'type' => 'string', + 'example' => 'ap-hz036ubmx2qmw93k****', + ], + 'ActionPlanName' => [ + 'title' => '执行计划的名称。', + 'description' => '执行计划的名称。', + 'type' => 'string', + 'example' => 'TestActionPlan', + ], + 'CreateTime' => [ + 'title' => '执行计划的创建时间。', + 'description' => '执行计划的创建时间。', + 'type' => 'string', + 'example' => '2025-08-10 18:28:05', + ], + 'UpdateTime' => [ + 'title' => '执行计划的上次修改时间。', + 'description' => '执行计划的上次修改时间。', + 'type' => 'string', + 'example' => '2025-08-10 18:28:05'."\n", + ], + 'AppId' => [ + 'title' => '应用 ID。', + 'description' => '应用 ID。', + 'type' => 'string', + 'example' => 'ci-vm-rYfypJKwlN9Y', + ], + 'PrologScript' => [ + 'title' => '前处理脚本。需Base64编码。', + 'description' => '前处理脚本。需Base64编码。', + 'type' => 'string', + 'example' => 'bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==', + ], + 'ResourceType' => [ + 'title' => '执行目标资源类型：vCPU容量或者执行节点数。取值范围如下：'."\n" + ."\n" + .'- VCpuCapacity：vCPU容量'."\n" + ."\n" + .'- ExecutorCapacity：执行节点数', + 'description' => '执行目标资源类型：vCPU容量或者执行节点数。取值范围如下：'."\n" + ."\n" + .'- VCpuCapacity：vCPU容量'."\n" + ."\n" + .'- ExecutorCapacity：执行节点数', + 'type' => 'string', + 'example' => 'VCpuCapacity', + ], + 'DesiredCapacity' => [ + 'title' => '执行计划期望的资源规模。如果ResourceType是VcpuCapacity的话，该字段表示执行计划希望保有10000vCPU。', + 'description' => '执行计划期望的资源规模。如果ResourceType是VcpuCapacity的话，该字段表示执行计划希望保有10000vCPU。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1000', + ], + 'TotalCapacity' => [ + 'title' => '执行计划当前管理的资源规模。', + 'description' => '执行计划当前管理的资源规模。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1000', + ], + 'Status' => [ + 'title' => '执行计划状态，可能值如下：'."\n" + ."\n" + .'- Active：生效状态。处于生效状态的执行计划才会动态管理Instant任务。'."\n" + ."\n" + .'- Inactive：失效状态。失效状态的执行计划不再管理Instant任务。'."\n" + ."\n" + .'- Deleting：执行计划正在删除中。该状态下执行计划不支持修改参数。', + 'description' => '执行计划状态，可能值如下：'."\n" + ."\n" + .'- Active：生效状态。处于生效状态的执行计划才会动态管理Instant任务。'."\n" + ."\n" + .'- Inactive：失效状态。失效状态的执行计划不再管理Instant任务。'."\n" + ."\n" + .'- Deleting：执行计划正在删除中。该状态下执行计划不支持修改参数。', + 'type' => 'string', + 'example' => 'Active', + ], + 'Resources' => [ + 'title' => '执行计划运行环境的资源配置。', + 'description' => '执行计划运行环境的资源配置列表。', + 'type' => 'array', + 'items' => [ + 'title' => '执行计划运行环境的资源配置。', + 'description' => '执行计划运行环境的资源配置。', + 'type' => 'object', + 'properties' => [ + 'Cores' => [ + 'title' => '运行环境的CPU数。', + 'description' => '运行环境的CPU数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '64', + ], + 'Memory' => [ + 'title' => '运行环境的内存大小。单位是GiB。', + 'description' => '运行环境的内存大小。单位是GiB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '128', + ], + ], + ], + ], + 'Regions' => [ + 'title' => '执行计划运行环境的地域资源配置。', + 'description' => '执行计划运行环境的地域资源配置列表。', + 'type' => 'array', + 'items' => [ + 'title' => '执行计划运行环境的地域资源配置。', + 'description' => '执行计划运行环境的地域资源配置。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'title' => '地域ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VSwitchIds' => [ + 'title' => '交换机 ID。', + 'description' => '执行计划在该地域可用的交换机列表。', + 'type' => 'array', + 'items' => [ + 'title' => '交换机 ID。', + 'description' => '交换机 ID。', + 'type' => 'string', + 'example' => 'vsw-bp14v5eikr8wrgoqje7hr', + ], + ], + 'SecurityGroupIds' => [ + 'title' => '交换机ID。', + 'description' => '执行计划在该地域可用的安全组列表。', + 'type' => 'array', + 'items' => [ + 'title' => '交换机ID。', + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'sg-uf6j4pp39x9k3x05c3vw', + ], + ], + ], + ], + ], + 'AllocationSpec' => [ + 'title' => '资源类型。', + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'Level' => [ + 'title' => '算力等级。', + 'description' => '算力等级。', + 'type' => 'string', + 'example' => 'General', + ], + 'IntervalMinutes' => [ + 'title' => '执行计划的定时周期，单位分钟。', + 'description' => '执行计划的定时周期，单位分钟。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExisted.ActionPlan', + 'errorMessage' => 'The specified action plan does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"ActionPlanId\\": \\"ap-hz036ubmx2qmw93k****\\",\\n \\"ActionPlanName\\": \\"TestActionPlan\\",\\n \\"CreateTime\\": \\"2025-08-10 18:28:05\\",\\n \\"UpdateTime\\": \\"2025-08-10 18:28:05\\\\n\\",\\n \\"AppId\\": \\"ci-vm-rYfypJKwlN9Y\\",\\n \\"PrologScript\\": \\"bHMgLWFsCmxzIC1hbGggfCB3YyAtbA==\\",\\n \\"ResourceType\\": \\"VCpuCapacity\\",\\n \\"DesiredCapacity\\": 1000,\\n \\"TotalCapacity\\": 1000,\\n \\"Status\\": \\"Active\\",\\n \\"Resources\\": [\\n {\\n \\"Cores\\": 64,\\n \\"Memory\\": 128\\n }\\n ],\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VSwitchIds\\": [\\n \\"vsw-bp14v5eikr8wrgoqje7hr\\"\\n ],\\n \\"SecurityGroupIds\\": [\\n \\"sg-uf6j4pp39x9k3x05c3vw\\"\\n ]\\n }\\n ],\\n \\"AllocationSpec\\": \\"Standard\\",\\n \\"Level\\": \\"General\\",\\n \\"IntervalMinutes\\": 60\\n}","type":"json"}]', + 'title' => '查询执行计划详情。', + ], + 'DeleteActionPlan' => [ + 'summary' => '删除执行计划', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREehpc11IJC9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ActionPlanId', + 'in' => 'query', + 'schema' => [ + 'description' => '执行计划 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-hz036ubmx2qmw93k****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotExisted.ActionPlan', + 'errorMessage' => 'The specified action plan does not exist.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidStatus.ActionPlan', + 'errorMessage' => 'The current status of the execution plan does not support this operation. Please try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\"\\n}","type":"json"}]', + 'title' => '删除执行计划。', + 'description' => '**请确保在使用该接口前，已充分了解E-HPC Instnat产品的收费方式和[价格](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" + .'该接口会将ActionPlanId管理的Instant作业全部停止。', + ], + 'AddImage' => [ + 'summary' => '添加用户自定义镜像。', + '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' => '镜像类型。取值范围：'."\n" + ."\n" + .'- VM：虚拟机镜像'."\n" + .'- Container：容器镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'VM', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'app-image'."\n", + ], + ], + [ + 'name' => 'ImageVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'V1.0', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'Test image'."\n", + ], + ], + [ + 'name' => 'ContainerImageSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '容器镜像配置。', + 'type' => 'object', + 'properties' => [ + 'RegistryUrl' => [ + 'description' => '容器镜像访问链接。', + 'type' => 'string', + 'required' => false, + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest'."\n", + ], + 'IsACRRegistry' => [ + 'description' => '是否为阿里云镜像仓库。'."\n" + ."\n" + .'- True：是。'."\n" + .'- False：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + 'IsACREnterprise' => [ + 'description' => '是否为阿里云镜像仓库企业版。'."\n" + ."\n" + .'- True：是。'."\n" + .'- False：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + 'RegistryCriId' => [ + 'description' => '企业版镜像仓库 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cri-xyz795ygf8k9****'."\n", + ], + 'RegistryCredential' => [ + 'description' => '私有镜像仓库鉴权。', + 'type' => 'object', + 'properties' => [ + 'Server' => [ + 'description' => '镜像仓库的注册地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com'."\n", + ], + 'UserName' => [ + 'description' => '登录用户名。', + 'type' => 'string', + 'required' => false, + 'example' => 'username', + ], + 'Password' => [ + 'description' => '登录密码。', + 'type' => 'string', + 'required' => false, + 'example' => 'userpassword', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'VMImageSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '虚拟机镜像配置。', + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'description' => '镜像 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'm-bp1akkkr1rkxtb******'."\n", + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。取值范围：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'ImageId' => [ + 'title' => 'Id of the request', + 'description' => '镜像 ID。', + 'type' => 'string', + 'example' => 'm-bp1akkkr1rkxtb******'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'ImageAlreadyExists', + 'errorMessage' => 'The image id already exists.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ImageInUse', + 'errorMessage' => 'Image is still used by jobs.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\",\\n \\"Success\\": true,\\n \\"ImageId\\": \\"m-bp1akkkr1rkxtb******\\\\n\\"\\n}","type":"json"}]', + 'title' => '添加镜像', + ], + 'GetImage' => [ + 'summary' => '获取镜像详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219057', + 'abilityTreeNodes' => [ + 'FEATUREehpcEZT3HW', + 'FEATUREehpcE21063', + ], + ], + 'parameters' => [ + [ + 'name' => 'ImageCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像来源。取值范围：'."\n" + .'- Public：阿里云提供的公共镜像。'."\n" + .'- Custom：您添加的自定义镜像。', + 'type' => 'string', + 'required' => false, + 'example' => 'Custom', + ], + ], + [ + 'name' => 'ImageType', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像类型。取值范围：'."\n" + ."\n" + .'- VM：虚拟机镜像。'."\n" + .'- Container：容器镜像。'."\n" + ."\n" + .'默认值：VM', + 'type' => 'string', + 'required' => false, + 'example' => 'VM', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'm-2ze74g5mvy4pjg*****', + ], + ], + [ + 'name' => 'AdditionalRegionIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE73368'."\n", + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。取值范围：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Image' => [ + 'title' => 'Image', + 'description' => '镜像详情。', + 'type' => 'object', + 'properties' => [ + 'ImageType' => [ + 'description' => '镜像类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'VM', + ], + 'AppId' => [ + 'type' => 'string', + ], + 'Name' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'app-image', + ], + 'Version' => [ + 'description' => '版本。', + 'type' => 'string', + 'example' => 'v1.0', + ], + 'Description' => [ + 'description' => '镜像描述。', + 'type' => 'string', + 'example' => '应用测试镜像。', + ], + 'Size' => [ + 'description' => '镜像大小。单位：GiB。', + 'type' => 'string', + 'example' => '40 GiB', + ], + 'CreateTime' => [ + 'description' => '镜像创建时间。', + 'type' => 'string', + 'example' => '2022-12-23T09:51:39Z', + ], + 'Status' => [ + 'type' => 'string', + ], + 'ContainerImageSpec' => [ + 'description' => '容器镜像配置详情。', + 'type' => 'object', + 'properties' => [ + 'RegistryUrl' => [ + 'description' => '容器镜像访问链接。', + 'type' => 'string', + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest', + ], + 'IsACRRegistry' => [ + 'description' => '是否为阿里云镜像仓库。'."\n" + ."\n" + .'- True：是。'."\n" + .'- False：否。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'IsACREnterprise' => [ + 'description' => '是否为阿里云镜像仓库企业版。'."\n" + ."\n" + .'- True：是。'."\n" + .'- False：否。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'RegistryCriId' => [ + 'description' => '企业版镜像仓库ID。', + 'type' => 'string', + 'example' => 'cri-xyz795ygf8k9****', + ], + 'RegistryCredential' => [ + 'description' => '私有镜像仓库鉴权。', + 'type' => 'object', + 'properties' => [ + 'Server' => [ + 'description' => '镜像仓库的注册地址。', + 'type' => 'string', + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com', + ], + 'UserName' => [ + 'description' => '登录用户名。', + 'type' => 'string', + 'example' => 'username', + ], + 'Password' => [ + 'description' => '登录用户密码。', + 'type' => 'string', + 'example' => 'userpassword', + ], + ], + ], + 'OsTag' => [ + 'type' => 'string', + ], + 'Platform' => [ + 'type' => 'string', + ], + 'Architecture' => [ + 'type' => 'string', + ], + ], + ], + 'VMImageSpec' => [ + 'description' => '虚拟机镜像配置详情。', + 'type' => 'object', + 'properties' => [ + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'm-uf60twafjtaart******', + ], + 'OsTag' => [ + 'description' => 'OS具体版本标识。', + 'type' => 'string', + 'example' => 'CentOS 7.6 64 bit', + ], + 'Platform' => [ + 'description' => '平台类型。', + 'type' => 'string', + 'example' => 'CentOS', + ], + 'Architecture' => [ + 'description' => '架构类型。', + 'type' => 'string', + 'example' => 'x86_64', + ], + ], + ], + 'DocumentInfo' => [ + 'type' => 'object', + 'properties' => [ + 'DocumentId' => [ + 'type' => 'string', + ], + 'EncodingMode' => [ + 'type' => 'string', + ], + 'Document' => [ + 'type' => 'string', + ], + ], + ], + 'AdditionalRegionsInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'ImageId' => [ + 'type' => 'string', + ], + 'RegionId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + ], + 404 => [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\\\n\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 10,\\n \\"Image\\": {\\n \\"ImageType\\": \\"VM\\",\\n \\"AppId\\": \\"\\",\\n \\"Name\\": \\"app-image\\",\\n \\"Version\\": \\"v1.0\\",\\n \\"Description\\": \\"应用测试镜像。\\",\\n \\"Size\\": \\"40 GiB\\",\\n \\"CreateTime\\": \\"2022-12-23T09:51:39Z\\",\\n \\"Status\\": \\"\\",\\n \\"ContainerImageSpec\\": {\\n \\"RegistryUrl\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com/ehpc_open/nginx:latest\\",\\n \\"IsACRRegistry\\": true,\\n \\"IsACREnterprise\\": true,\\n \\"RegistryCriId\\": \\"cri-xyz795ygf8k9****\\",\\n \\"RegistryCredential\\": {\\n \\"Server\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com\\",\\n \\"UserName\\": \\"username\\",\\n \\"Password\\": \\"userpassword\\"\\n },\\n \\"OsTag\\": \\"\\",\\n \\"Platform\\": \\"\\",\\n \\"Architecture\\": \\"\\"\\n },\\n \\"VMImageSpec\\": {\\n \\"ImageId\\": \\"m-uf60twafjtaart******\\",\\n \\"OsTag\\": \\"CentOS 7.6 64 bit\\",\\n \\"Platform\\": \\"CentOS\\",\\n \\"Architecture\\": \\"x86_64\\"\\n },\\n \\"DocumentInfo\\": {\\n \\"DocumentId\\": \\"\\",\\n \\"EncodingMode\\": \\"\\",\\n \\"Document\\": \\"\\"\\n },\\n \\"AdditionalRegionsInfo\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"ImageId\\": \\"\\",\\n \\"RegionId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '获取镜像详情', + ], + 'ListImages' => [ + 'summary' => '查询镜像列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219055', + 'abilityTreeNodes' => [ + 'FEATUREehpcEZT3HW', + 'FEATUREehpcE21063', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。 '."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页条数。 '."\n" + .'默认值：20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ImageCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像来源。取值范围：'."\n" + .'- Public：阿里云提供的公共镜像。'."\n" + .'- Custom：您添加的自定义镜像。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Custom' => 'Custom', + 'Public' => 'Public', + ], + 'example' => 'Custom', + ], + ], + [ + 'name' => 'ImageType', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像类型。取值范围：'."\n" + ."\n" + .'- VM：虚拟机镜像。'."\n" + .'- Container：容器镜像。'."\n" + ."\n" + .'默认值：VM', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Container' => 'Container', + 'VM' => 'VM', + ], + 'example' => 'VM', + ], + ], + [ + 'name' => 'ImageIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '镜像ID数组。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'm-uf6bzz76jb4ai9******', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ImageNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '镜像名称数组。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'appimage', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'description' => '查询模式。取值范围：'."\n" + ."\n" + .'- List：查询对应所有镜像版本列表。'."\n" + .'- Merge：归并查询各镜像最新版本列表。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Merge' => 'Merge', + 'List' => 'List', + ], + 'example' => 'Merge', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。取值范围：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '每页条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Images' => [ + 'title' => 'Images', + 'description' => '镜像信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像信息。', + 'type' => 'object', + 'properties' => [ + 'ImageType' => [ + 'description' => '镜像类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'VM', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'm-bp181x855551ww5yq****', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ci-vm-kHLPzEWun6zz****', + ], + 'Name' => [ + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'app-image', + ], + 'Version' => [ + 'description' => '镜像版本。', + 'type' => 'string', + 'example' => 'v1.0', + ], + 'Description' => [ + 'description' => '镜像描述。', + 'type' => 'string', + 'example' => '应用测试镜像。', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-12-09T07:06:34Z', + ], + 'OsTag' => [ + 'description' => 'OS具体版本标识。', + 'type' => 'string', + 'example' => 'Ubuntu 22.04 64 bit', + ], + 'UpdateTime' => [ + 'description' => '镜像更新时间。', + 'type' => 'string', + 'example' => '2024-09-25 14:15:28', + ], + 'DocumentId' => [ + 'description' => '文档ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Weight' => [ + 'description' => '权重。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '70', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Images\\": [\\n {\\n \\"ImageType\\": \\"VM\\",\\n \\"ImageId\\": \\"m-bp181x855551ww5yq****\\",\\n \\"AppId\\": \\"ci-vm-kHLPzEWun6zz****\\",\\n \\"Name\\": \\"app-image\\",\\n \\"Version\\": \\"v1.0\\",\\n \\"Description\\": \\"应用测试镜像。\\",\\n \\"CreateTime\\": \\"2022-12-09T07:06:34Z\\",\\n \\"OsTag\\": \\"Ubuntu 22.04 64 bit\\",\\n \\"UpdateTime\\": \\"2024-09-25 14:15:28\\",\\n \\"DocumentId\\": 30,\\n \\"Weight\\": 70\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询镜像列表', + ], + 'RemoveImage' => [ + 'summary' => '移除用户自定义镜像', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219056', + 'abilityTreeNodes' => [ + 'FEATUREehpcE21063', + ], + ], + 'parameters' => [ + [ + 'name' => 'ImageType', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像类型。取值范围：'."\n" + ."\n" + .'- VM：虚拟机镜像'."\n" + .'- Container：容器镜像', + 'type' => 'string', + 'required' => false, + 'example' => 'VM', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'm-bp14wakr1rkxtb******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。取值范围：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'ImageAlreadyExists', + 'errorMessage' => 'The image id already exists.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + ], + 403 => [ + [ + 'errorCode' => 'ImageInUse', + 'errorMessage' => 'Image is still used by jobs.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + [ + 'errorCode' => 'ServiceAPIError', + 'errorMessage' => 'Failed to call the operation. Cause:%s.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '移除镜像', + ], + 'GetAppVersions' => [ + 'summary' => '获取应用版本列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '255311', + 'abilityTreeNodes' => [ + 'FEATUREehpcEZT3HW', + 'FEATUREehpcE21063', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页条数。'."\n" + .'默认值：20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ImageCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像来源。取值范围：'."\n" + ."\n" + .'Public：阿里云提供的公共镜像。'."\n" + ."\n" + .'Custom：您添加的自定义镜像。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Custom' => 'Custom', + 'Public' => 'Public', + ], + 'example' => 'Public', + ], + ], + [ + 'name' => 'ImageType', + 'in' => 'query', + 'schema' => [ + 'description' => '镜像类型。取值范围：'."\n" + ."\n" + .'VM：虚拟机镜像'."\n" + ."\n" + .'Container：容器镜像', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Container' => 'Container', + 'VM' => 'VM', + ], + 'example' => 'VM', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'V-Ray', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n", + ], + 'Success' => [ + 'description' => '执行命令并获取结果的过程是否成功。取值范围：'."\n" + ."\n" + .'true：成功。'."\n" + ."\n" + .'false：失败。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'title' => 'PageSize', + 'description' => '每页条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'PageNumber' => [ + 'title' => 'PageNumber', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AppVersions' => [ + 'title' => 'Images', + 'description' => '应用版本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用版本信息。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'V-Ray', + ], + 'Version' => [ + 'description' => '应用版本。', + 'type' => 'string', + 'example' => 'v1.0', + ], + 'ImageId' => [ + 'description' => '应用镜像ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'm-f8z0dfa96luomqly****', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + ], + 406 => [ + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"AppVersions\\": [\\n {\\n \\"Name\\": \\"V-Ray\\",\\n \\"Version\\": \\"v1.0\\",\\n \\"ImageId\\": \\"m-f8z0dfa96luomqly****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取应用版本列表', + ], + 'SynchronizeApp' => [ + 'summary' => '应用跨地域同步', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREehpcEZT3HW', + 'FEATUREehpcE21063', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ci-vm-rYfypJKwlN9Y', + ], + ], + [ + 'name' => 'TargetRegionIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '同步至指定地域的数组列表。若包含\'all\'，则默认同步至所有其它未同步地域。', + 'type' => 'array', + 'items' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + 'required' => false, + 'enumValueTitles' => [], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ImageAlreadyExists', + 'errorMessage' => 'The image id already exists.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'Invalid parameters: %s.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + [ + 'errorCode' => 'ServiceAPIError', + 'errorMessage' => 'Failed to call the operation. Cause:%s.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]', + 'title' => '同步应用', + ], + 'CreateJob' => [ + 'summary' => '创建一个E-HPC Instant 作业。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '219052', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobName', + 'in' => 'query', + 'schema' => [ + 'description' => '作业名称。长度为 2~64 个字符，支持英文、中文和数字。可以包含短划线（-）和下划线（_）。', + 'type' => 'string', + 'required' => true, + 'example' => 'testjob', + ], + ], + [ + 'name' => 'JobDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '作业描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'Demo', + ], + ], + [ + 'name' => 'Tasks', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务列表，当前仅支持1个任务。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'TaskName' => [ + 'description' => '任务名称。长度为 2~32个字符，支持英文、中文和数字。可以包含短划线（-）和下划线（_）。', + 'type' => 'string', + 'required' => false, + 'example' => 'task0', + ], + 'TaskSpec' => [ + 'description' => '任务规格详情。', + 'type' => 'object', + 'properties' => [ + 'TaskExecutor' => [ + 'description' => '任务执行配置。', + 'type' => 'array', + 'items' => [ + 'description' => '任务执行配置。', + 'type' => 'object', + 'properties' => [ + 'Container' => [ + 'description' => '使用容器环境。', + 'type' => 'object', + 'properties' => [ + 'Image' => [ + 'description' => '容器镜像。', + 'type' => 'string', + 'required' => true, + 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/ehpc/hpl:latest', + ], + 'WorkingDir' => [ + 'description' => '容器工作目录。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/', + ], + 'Command' => [ + 'description' => '容器启动命令列表。最多20个命令，单个命令最长256个字符。 '."\n" + .'> 1. 若启动命令包含空格（例如：`sleep 60s`），传入的JSON格式参数为`["sleep", "60s"]`。'."\n" + .'> 2. 若启动命令较复杂，参数格式可以采用`Command: ["/bin/bash"]`和`Arg:["-c", ""]`组合的方式。其中``为用户自定义的命令组合，可包含空格等字符。', + 'type' => 'array', + 'items' => [ + 'description' => '容器启动命令内容。每个命令最多包含256个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'sleep', + ], + 'required' => false, + ], + 'EnvironmentVars' => [ + 'description' => '容器的环境变量。最多20组。', + 'type' => 'array', + 'items' => [ + 'description' => '容器的环境变量。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '环境变量名。长度为 1~128 位。格式要求：[0-9a-zA-Z]，以及下划线，不能以数字开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'PATH', + ], + 'Value' => [ + 'description' => '环境变量值。长度为 0~256 位。', + 'type' => 'string', + 'required' => false, + 'example' => '/usr/local/bin', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'AppId' => [ + 'description' => '容器应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ci-vm-32k6LXAi3cOG', + ], + 'ImageRegistryOptions' => [ + 'title' => '镜像仓库配置信息', + 'type' => 'string', + 'required' => false, + ], + 'Arg' => [ + 'description' => '容器启动命令对应的参数。最多 10 组。', + 'type' => 'array', + 'items' => [ + 'description' => '容器启动命令对应的参数。', + 'type' => 'string', + 'required' => false, + 'example' => '60s', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'VM' => [ + 'description' => '使用虚拟机环境。', + 'type' => 'object', + 'properties' => [ + 'Image' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'm-xxxx', + ], + 'PrologScript' => [ + 'description' => '前处理脚本。需Base64编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'ZWNobyBoZWxsbyBlY3Mh', + ], + 'Script' => [ + 'description' => '运行作业脚本。需Base64编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'ZWNobyBoZWxsbyBlY3Mh', + ], + 'AppId' => [ + 'description' => '虚拟机应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ci-vm-9jc58Pm5Leky', + ], + 'Password' => [ + 'description' => '虚拟机环境登录密码。长度为 8 至 30 个字符，必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是：'."\n" + ."\n" + .'()`~!@#$%^&*-_+=|{}[]:;\'<>,.?/'."\n" + .'其中，Windows环境不能以正斜线（/）为密码首字符。'."\n" + ."\n" + .'> 如果传入Password参数，建议您使用 HTTPS 协议发送请求，避免密码泄露。', + 'type' => 'string', + 'required' => false, + 'example' => 'EHPC@1234', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + 'VolumeMount' => [ + 'description' => '任务挂载的数据卷列表。最多10组。', + 'type' => 'array', + 'items' => [ + 'description' => '任务挂载的数据卷列表。', + 'type' => 'object', + 'properties' => [ + 'MountPath' => [ + 'description' => '任务挂载数据卷的目录。'."\n" + ."\n" + .'> 挂载目录下的内容会被Volume的内容直接覆盖，请谨慎使用。', + 'type' => 'string', + 'required' => false, + 'example' => '/mnt', + ], + 'VolumeDriver' => [ + 'description' => '当前支持的数据卷类型。'."\n" + .'- alicloud/nas: 挂载 NAS。'."\n" + .'- alicloud/oss: 挂载OSS。', + 'type' => 'string', + 'required' => false, + 'example' => 'alicloud/nas', + ], + 'MountOptions' => [ + 'description' => '数据卷挂载参数列表。为KV形式，采用JSON传递。'."\n" + .'- 挂载NAS参考格式：{"server":"xxxxx-xxxxx.cn-heyuan.nas.aliyuncs.com","vers":"3","path":"/data","options":"nolock,tcp,noresvport"}'."\n" + .'> server表示NAS的挂载点地址；path表示NAS路径下的子目录，以 / 开头，要求目录必须已存在；vers表示挂载NAS的NFS协议版本号，推荐使用v3；options表示挂载NAS时定制化参数，格式为"xxx,xxx,xxx"。'."\n" + ."\n" + .'- 挂载OSS参考格式：{"bucket":"xxxxx", "url":"oss-cn-heyuan-internal.aliyuncs.com","path":"/data","akId":"xxxxx","akSecret":"xxxxx"}'."\n" + .'> bucket表示OSS Bucket的名称；url表示OSS Bucket的访问域名（Endpoint），可以登录OSS管理控制台，在目标Bucket的概览页面获取；path表示挂载时相对Bucket根文件的目录结构，默认为/，要求目录必须已存在；akId表示使用AccessKey直接授权时，对应的AccessKey ID；akSecret表示使用AccessKey直接授权时，对应的AccessKey Secret。', + 'type' => 'string', + 'required' => false, + 'example' => '{"server":"xxxxx-xxxxx.cn-heyuan.nas.aliyuncs.com","vers":"3","path":"/data","options":"nolock,tcp,noresvport"}', + ], + 'ReadOnly' => [ + 'description' => '数据卷是否只读。默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Resource' => [ + 'description' => '运行环境资源信息。', + 'type' => 'object', + 'properties' => [ + 'Cores' => [ + 'description' => '运行环境的CPU个数。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '2', + ], + 'EnableHT' => [ + 'description' => '运行环境是否开启超线程。默认值：true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Memory' => [ + 'description' => '运行环境的内存大小。单位为GiB。', + 'type' => 'number', + 'format' => 'float', + 'required' => false, + 'example' => '4', + ], + 'Disks' => [ + 'description' => '云盘数组。', + 'type' => 'array', + 'items' => [ + 'description' => '云盘数组。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '云盘类型。目前仅支持System，表示系统盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'System', + ], + 'Size' => [ + 'description' => '云盘大小。单位为GiB。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '40', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'HostNamePrefix' => [ + 'description' => '运行环境主机名前缀。限制说明如下：'."\n" + ."\n" + .'- 半角句号（.）和短划线（-）不能作为首尾字符，更不能连续使用。'."\n" + .'- Windows环境：字符长度不超过10，不支持半角句号（.），不能全是数字。允许包含大小写英文字母、数字和短划线（-）。'."\n" + .'- Linux环境：字符长度不超过32，支持多个半角句号（.），点之间为一段，每段允许包含大小写英文字母、数字和短划线（-）。', + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + 'InstanceTypes' => [ + 'description' => '运行环境的实例规格。最多5组。', + 'type' => 'array', + 'items' => [ + 'description' => '运行环境的实例规格。'."\n" + .'> 该参数仅在`DeploymentPolicy. AllocationSpec`取值为`Standard`时生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c7a.8xlarge', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'RetryPolicy' => [ + 'description' => '任务重试策略。', + 'type' => 'object', + 'properties' => [ + 'RetryCount' => [ + 'description' => '重试次数。取值范围：1～10。默认值：3。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + 'ExitCodeActions' => [ + 'description' => '重试规则。最多10组。', + 'type' => 'array', + 'items' => [ + 'description' => '重试规则。', + 'type' => 'object', + 'properties' => [ + 'ExitCode' => [ + 'description' => '任务退出码，配合 Action 组成作业重试规则。取值范围：0～255。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + 'Action' => [ + 'description' => '任务下一步行为。'."\n" + ."\n" + .'- Retry：当命中特定退出码时，作业开始新一轮重试。'."\n" + ."\n" + .'- Exit：当命中特定退出码时，作业退出。', + 'type' => 'string', + 'required' => true, + 'example' => 'Retry', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'ExecutorPolicy' => [ + 'description' => '任务执行策略。', + 'type' => 'object', + 'properties' => [ + 'MaxCount' => [ + 'description' => '作业运行最大节点数。'."\n" + .'> 需遵循计算公式：`MaxCount = (IndexEnd - IndexStart) / IndexStep + 1`', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ArraySpec' => [ + 'description' => '数组作业详情。子作业索引值通过环境变量传递到运行环境中，支持用户业务程序引用。环境变量包括：'."\n" + .'- EHPC_JOB_NAME：作业名称，对应参数JobName。'."\n" + .'- EHPC_JOB_ID：作业ID。'."\n" + .'- EHPC_TASK_NAME：任务名称，对应参数TaskName。'."\n" + .'- EHPC_EXECUTOR_ID：执行单元ID。'."\n" + .'- EHPC_ARRAY_TASK_ID：子作业索引值。'."\n" + .'- EHPC_ARRAY_TASK_COUNT：子作业总数量。'."\n" + .'- EHPC_ARRAY_TASK_MAX：子作业索引最大值，对应参数IndexStart。'."\n" + .'- EHPC_ARRAY_TASK_MIN：子作业索引最小值，对应参数IndexEnd。'."\n" + .'- EHPC_ARRAY_TASK_STEP：子作业索引步长，对应参数IndexStep。', + 'type' => 'object', + 'properties' => [ + 'IndexStart' => [ + 'description' => '数组作业索引的起始值。取值范围：0~4999。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'IndexEnd' => [ + 'description' => '数组作业索引的结束值。取值范围：0~4999，且大于等于IndexStart。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '9', + ], + 'IndexStep' => [ + 'description' => '数组作业索引的间隔。'."\n" + .'> 若数组作业属性为IndexStart=1,IndexEnd=5,IndexStep=2，则该数组作业包含三个子作业，子作业索引值分别为1,3,5，用户业务程序可以通过环境变量方式访问。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'TaskSustainable' => [ + 'description' => '是否是长时间运行的作业。'."\n" + .'- true： 后台服务作业。'."\n" + .'- false： 批处理作业。'."\n" + ."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'false' => 'false', + 'true' => 'true', + ], + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => true, + 'minItems' => 1, + ], + ], + [ + 'name' => 'DeploymentPolicy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '资源部署策略。', + 'type' => 'object', + 'properties' => [ + 'AllocationSpec' => [ + 'description' => '资源类型。'."\n" + .'- Standard：标准型。'."\n" + .'- Dedicated：专属型，需开通白名单使用。'."\n" + .'- Economic：经济型，需开通白名单使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'Dedicated', + ], + 'Network' => [ + 'description' => '网络配置信息。', + 'type' => 'object', + 'properties' => [ + 'Vswitch' => [ + 'description' => '交换机数组。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-xxxx', + ], + 'required' => false, + ], + 'EnableExternalIpAddress' => [ + 'description' => '作业是否创建公网IP。'."\n" + .'- true：创建公网IP。'."\n" + .'- false： 不创建公网IP。'."\n" + ."\n" + .'默认值：false', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'false' => 'false', + 'true' => 'true', + ], + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'Tag' => [ + 'description' => '作业标签信息。最多20组。', + 'type' => 'array', + 'items' => [ + 'description' => '作业标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '作业标签键。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或 https://。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '作业标签值。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能包含 http://或者 https://。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + 'Pool' => [ + 'description' => '作业资源池。', + 'type' => 'string', + 'required' => false, + 'example' => 'compute', + ], + 'Priority' => [ + 'description' => '作业优先级。取值越大，作业调度优先级越高。取值范围：1～100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Level' => [ + 'description' => '算力等级，仅在资源类型为经济型时有效。支持以下类型：'."\n" + .'- General：通用型。'."\n" + .'- Performance：性能型。'."\n" + ."\n" + .'默认值：General', + 'type' => 'string', + 'required' => false, + 'example' => 'General', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SecurityPolicy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '安全策略。', + 'type' => 'object', + 'properties' => [ + 'SecurityGroup' => [ + 'description' => '安全组。', + 'type' => 'object', + 'properties' => [ + 'SecurityGroupIds' => [ + 'description' => '安全组ID数组。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-xxxxxxxxxxxxxxx', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DependencyPolicy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '依赖策略。', + 'type' => 'object', + 'properties' => [ + 'JobDependency' => [ + 'description' => '作业依赖。最多10组。', + 'type' => 'array', + 'items' => [ + 'description' => '作业依赖。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'job-bjxxxxxxxxxxxx', + ], + 'Type' => [ + 'description' => '依赖类型。取值范围：'."\n" + ."\n" + .'- AfterSucceeded：所依赖作业或数组作业**所有子任务**运行成功（退出码为0）。'."\n" + .'- AfterFailed：所依赖作业或数组作业**任一子任务**运行失败（退出码非0）。'."\n" + .'- AfterAny：所依赖作业运行结束（成功或失败）。'."\n" + .'- AfterCorresponding：所依赖数组作业对应的子任务运行成功（退出码为0）。'."\n" + ."\n" + .'默认值：AfterSucceeded。', + 'type' => 'string', + 'required' => false, + 'example' => 'AfterSucceeded', + 'enum' => [ + 'AfterSucceeded', + 'AfterFailed', + 'AfterAny', + 'AfterCorresponding', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'job-xxxx', + ], + 'Tasks' => [ + 'description' => '任务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务列表详情。', + 'type' => 'object', + 'properties' => [ + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'task0', + ], + 'ExecutorIds' => [ + 'description' => '任务包含的Executor ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Executor ID。格式为JobId-TaskName-ArrayIndex。', + 'type' => 'string', + 'example' => '[\\"job-xxxx-task0_11-2\\"]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + ], + 403 => [ + [ + 'errorCode' => 'GetResourceFailed', + 'errorMessage' => 'Failed to get resource.', + ], + [ + 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', + 'errorMessage' => 'The resource is out of stock.', + ], + [ + 'errorCode' => 'DuplicateTagKey', + 'errorMessage' => 'Duplicate tag key exists: %s.', + ], + [ + 'errorCode' => 'PoolNotFound', + 'errorMessage' => 'The specified pool was not found.', + ], + [ + 'errorCode' => 'PoolStatusInvalid', + 'errorMessage' => 'The specified pool in invalid status.', + ], + [ + 'errorCode' => 'QuotaExceeded.PrivateIpAddress', + 'errorMessage' => 'Insufficient private IP addresses in vSwitch: %s.', + ], + [ + 'errorCode' => 'SecurityGroupInstanceLimitExceed', + 'errorMessage' => 'The maximum number of instances in a security group is exceeded.', + ], + [ + 'errorCode' => 'QuotaExceeded.Resource', + 'errorMessage' => 'Insufficient resource quota.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + [ + 'errorCode' => 'SecurityGroupNotExists', + 'errorMessage' => 'The security group does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"JobId\\": \\"job-xxxx\\",\\n \\"Tasks\\": [\\n {\\n \\"TaskName\\": \\"task0\\",\\n \\"ExecutorIds\\": [\\n \\"[\\\\\\\\\\\\\\"job-xxxx-task0_11-2\\\\\\\\\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '创建作业', + ], + 'GetJob' => [ + 'summary' => '获取执行作业详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219050', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'JobInfo' => [ + 'description' => '作业详细信息。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'job-xxxx', + ], + 'JobName' => [ + 'description' => '作业名称。', + 'type' => 'string', + 'example' => 'testJob', + ], + 'JobDescription' => [ + 'description' => '作业描述。', + 'type' => 'string', + 'example' => 'Demo', + ], + 'Tasks' => [ + 'description' => '任务列表，当前仅支持1个任务。', + 'type' => 'array', + 'items' => [ + 'description' => '任务列表，当前仅支持1个任务。', + 'type' => 'object', + 'properties' => [ + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'task0', + ], + 'TaskSpec' => [ + 'description' => '任务规格详情。', + 'type' => 'object', + 'properties' => [ + 'TaskExecutor' => [ + 'description' => '任务执行配置。', + 'type' => 'array', + 'items' => [ + 'description' => '任务执行配置。', + 'type' => 'object', + 'properties' => [ + 'VM' => [ + 'description' => '使用ECS实例。', + 'type' => 'object', + 'properties' => [ + 'Image' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'm-xxxx', + ], + 'PrologScript' => [ + 'description' => '前处理脚本。需Base64编码。', + 'type' => 'string', + 'example' => 'ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg', + ], + 'Script' => [ + 'description' => '运行作业脚本。需Base64编码。', + 'type' => 'string', + 'example' => 'ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg', + ], + ], + ], + ], + ], + ], + 'VolumeMount' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MountPath' => [ + 'type' => 'string', + ], + 'VolumeDriver' => [ + 'type' => 'string', + ], + 'MountOptions' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Resource' => [ + 'description' => '资源信息。', + 'type' => 'object', + 'properties' => [ + 'Cores' => [ + 'description' => '运行作业的CPU个数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'EnableHT' => [ + 'type' => 'boolean', + ], + 'Memory' => [ + 'description' => '内存资源总量。单位：GiB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Disks' => [ + 'description' => '云盘数组。', + 'type' => 'array', + 'items' => [ + 'description' => '云盘数组。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '云盘类型。支持以下类型：'."\n" + ."\n" + .'- System：系统盘。'."\n" + .'- Data：数据盘。', + 'type' => 'string', + 'example' => 'System', + ], + 'Size' => [ + 'description' => '云盘大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + 'HostNamePrefix' => [ + 'type' => 'string', + ], + 'InstanceTypes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + 'RetryPolicy' => [ + 'type' => 'object', + 'properties' => [ + 'RetryCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ExitCodeActions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Action' => [ + 'type' => 'string', + ], + 'ExitCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + 'ExecutorPolicy' => [ + 'description' => '任务执行策略。', + 'type' => 'object', + 'properties' => [ + 'MaxCount' => [ + 'description' => '作业运行最大节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ArraySpec' => [ + 'description' => '数组作业详情。', + 'type' => 'object', + 'properties' => [ + 'IndexStart' => [ + 'description' => '数组作业索引的起始值。取值范围：0~4999。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IndexEnd' => [ + 'description' => '数组作业索引的结束值。取值范围：0~4999，且大于等于IndexStart。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'IndexStep' => [ + 'description' => '数组作业索引的间隔。'."\n" + .'> 若数组作业属性为IndexStart=1,IndexEnd=5,IndexStep=2，则该数组作业包含三个子任务，子任务索引分别为1,3,5。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'TaskSustainable' => [ + 'description' => '是否是长期运行的作业。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ExecutorStatus' => [ + 'description' => '任务执行状态。', + 'type' => 'array', + 'items' => [ + 'description' => '任务执行状态。', + 'type' => 'object', + 'properties' => [ + 'ArrayId' => [ + 'description' => '子作业ID', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Status' => [ + 'description' => '作业状态。', + 'type' => 'string', + 'example' => 'Running', + ], + 'StatusReason' => [ + 'description' => '状态原因描述。', + 'type' => 'string', + 'example' => 'Creating executor', + ], + 'CreateTime' => [ + 'description' => '作业创建时间。', + 'type' => 'string', + 'example' => '2024-02-04 13:54:10', + ], + 'StartTime' => [ + 'description' => '作业开始时间。', + 'type' => 'string', + 'example' => '2024-02-04 13:54:10', + ], + 'EndTime' => [ + 'description' => '作业结束时间。', + 'type' => 'string', + 'example' => '2024-02-04 13:54:10', + ], + ], + ], + ], + ], + ], + ], + 'DeploymentPolicy' => [ + 'description' => '资源部署策略。', + 'type' => 'object', + 'properties' => [ + 'AllocationSpec' => [ + 'description' => '资源类型。当前仅支持Dedicated，需开通白名单使用。', + 'type' => 'string', + 'example' => 'Dedicated', + ], + 'Network' => [ + 'description' => '网络配置信息。', + 'type' => 'object', + 'properties' => [ + 'Vswitch' => [ + 'description' => '交换机数组。', + 'type' => 'array', + 'items' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-xxx', + ], + ], + 'EnableExternalIpAddress' => [ + 'description' => '是否创建公网IP。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'false' => 'false', + 'true' => 'true', + ], + 'example' => 'false', + ], + 'EnableENIMapping' => [ + 'description' => '资源是否创建在传入交换机参数对应的可用区下。'."\n" + ."\n" + .'- true：资源创建在传入交换机参数对应的可用区下。'."\n" + ."\n" + .'- false：资源创建在任何有资源的可用区下。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'Tags' => [ + 'description' => '作业标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '作业标签列表。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '作业标签键。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'TagValue' => [ + 'description' => '作业标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + 'Level' => [ + 'description' => '算力等级。支持以下类型：'."\n" + .'- General：通用型。'."\n" + .' - Performance：性能型。'."\n" + ."\n" + .'默认值：General', + 'type' => 'string', + 'example' => 'General', + ], + ], + ], + 'SecurityPolicy' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityGroup' => [ + 'type' => 'object', + 'properties' => [ + 'SecurityGroupIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'DependencyPolicy' => [ + 'type' => 'object', + 'properties' => [ + 'JobDependency' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'type' => 'string', + ], + 'Type' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '作业提交时间。', + 'type' => 'string', + 'example' => '2024-03-05 20:00:46', + ], + 'StartTime' => [ + 'description' => '作业开始时间。', + 'type' => 'string', + 'example' => '2024-03-05 20:00:48', + ], + 'EndTime' => [ + 'description' => '作业结束时间。', + 'type' => 'string', + 'example' => '2024-03-05 20:01:48', + ], + 'Status' => [ + 'description' => '作业状态。取值范围：'."\n" + ."\n" + .'- Pending：作业排队中'."\n" + .'- Initing：作业初始化中'."\n" + .'- Succeed：作业运行成功'."\n" + .'- Failed：作业运行失败'."\n" + .'- Running：作业运行中'."\n" + .'- Exception：调度异常'."\n" + .'- Retrying：作业重试中'."\n" + .'- Expired：作业超时'."\n" + .'- Deleted：作业删除完成'."\n" + .'- Suspended：作业休眠'."\n" + .'- Restarting：作业重启中', + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'AppExtraInfo' => [ + 'description' => '应用附加信息。', + 'type' => 'string', + 'example' => '{\\"xxx\\": \\"xxxxx\\"}', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job id is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"JobInfo\\": {\\n \\"JobId\\": \\"job-xxxx\\",\\n \\"JobName\\": \\"testJob\\",\\n \\"JobDescription\\": \\"Demo\\",\\n \\"Tasks\\": [\\n {\\n \\"TaskName\\": \\"task0\\",\\n \\"TaskSpec\\": {\\n \\"TaskExecutor\\": [\\n {\\n \\"VM\\": {\\n \\"Image\\": \\"m-xxxx\\",\\n \\"PrologScript\\": \\"ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg\\",\\n \\"Script\\": \\"ZWNobyAiMTIzNCIgPiBgZGF0ZSArJXNg\\"\\n }\\n }\\n ],\\n \\"VolumeMount\\": [\\n {\\n \\"MountPath\\": \\"\\",\\n \\"VolumeDriver\\": \\"\\",\\n \\"MountOptions\\": \\"\\"\\n }\\n ],\\n \\"Resource\\": {\\n \\"Cores\\": 1,\\n \\"EnableHT\\": true,\\n \\"Memory\\": 4,\\n \\"Disks\\": [\\n {\\n \\"Type\\": \\"System\\",\\n \\"Size\\": 100\\n }\\n ],\\n \\"HostNamePrefix\\": \\"\\",\\n \\"InstanceTypes\\": [\\n \\"\\"\\n ]\\n },\\n \\"RetryPolicy\\": {\\n \\"RetryCount\\": 0,\\n \\"ExitCodeActions\\": [\\n {\\n \\"Action\\": \\"\\",\\n \\"ExitCode\\": 0\\n }\\n ]\\n }\\n },\\n \\"ExecutorPolicy\\": {\\n \\"MaxCount\\": 10,\\n \\"ArraySpec\\": {\\n \\"IndexStart\\": 0,\\n \\"IndexEnd\\": 9,\\n \\"IndexStep\\": 1\\n }\\n },\\n \\"TaskSustainable\\": true,\\n \\"ExecutorStatus\\": [\\n {\\n \\"ArrayId\\": 0,\\n \\"Status\\": \\"Running\\",\\n \\"StatusReason\\": \\"Creating executor\\",\\n \\"CreateTime\\": \\"2024-02-04 13:54:10\\",\\n \\"StartTime\\": \\"2024-02-04 13:54:10\\",\\n \\"EndTime\\": \\"2024-02-04 13:54:10\\"\\n }\\n ]\\n }\\n ],\\n \\"DeploymentPolicy\\": {\\n \\"AllocationSpec\\": \\"Dedicated\\",\\n \\"Network\\": {\\n \\"Vswitch\\": [\\n \\"vsw-xxx\\"\\n ],\\n \\"EnableExternalIpAddress\\": false,\\n \\"EnableENIMapping\\": false\\n },\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"Level\\": \\"General\\"\\n },\\n \\"SecurityPolicy\\": {\\n \\"SecurityGroup\\": {\\n \\"SecurityGroupIds\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"DependencyPolicy\\": {\\n \\"JobDependency\\": [\\n {\\n \\"JobId\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n ]\\n },\\n \\"JobScheduler\\": \\"HPC\\",\\n \\"CreateTime\\": \\"2024-03-05 20:00:46\\",\\n \\"StartTime\\": \\"2024-03-05 20:00:48\\",\\n \\"EndTime\\": \\"2024-03-05 20:01:48\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"AppExtraInfo\\": \\"{\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"xxxxx\\\\\\\\\\\\\\"}\\"\\n }\\n}","type":"json"}]', + 'title' => '获取作业详情', + ], + 'ListJobs' => [ + 'summary' => '查询作业列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219053', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的本页条数。 默认50，最大100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。'."\n" + ."\n" + .'起始值：1'."\n" + ."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询作业过滤条件。', + 'type' => 'object', + 'properties' => [ + 'JobName' => [ + 'description' => '作业名称。支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'testJob', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxx', + ], + 'TimeCreatedAfter' => [ + 'description' => '在此时间之后提交的作业，以所在地域的时间转化为（国内站为东八区）Unix时间戳。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1703819914', + ], + 'TimeCreatedBefore' => [ + 'description' => '在此时间之前提交的作业，以所在地域的时间转化为（国内站为东八区）Unix时间戳。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1703820113', + ], + 'Status' => [ + 'description' => '作业状态。取值范围：'."\n" + ."\n" + .'- Pending：作业排队中'."\n" + .'- Initing：作业初始化中'."\n" + .'- Succeeded：作业运行成功'."\n" + .'- Failed：作业运行失败'."\n" + .'- Running：作业运行中'."\n" + .'- Exception：调度异常'."\n" + .'- Retrying：作业重试中'."\n" + .'- Expired：作业超时'."\n" + .'- Suspended：作业休眠'."\n" + .'- Restarting：作业重启中'."\n" + .'- Deleted：作业删除完成', + 'type' => 'string', + 'required' => false, + 'example' => 'Running', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '排序方式。', + 'type' => 'object', + 'properties' => [ + 'Label' => [ + 'description' => '排序标签。取值范围：'."\n" + ."\n" + .'- time_start'."\n" + .'- job_name', + 'type' => 'string', + 'required' => false, + 'example' => 'time_start', + ], + 'Order' => [ + 'description' => '排序顺序。取值范围：'."\n" + ."\n" + .'- ASC（默认值）：升序'."\n" + .'- DESC：降序', + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量，此参数为可选参数，默认可不返回', + 'description' => '本次请求条件下的数据总量。'."\n" + .'此参数为可选参数，默认可不返回。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'PageSize' => [ + 'description' => '分页查询时设置的本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'title' => 'MaxResults本次请求所返回的最大记录条数', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'JobList' => [ + 'description' => '作业列表。', + 'type' => 'array', + 'items' => [ + 'description' => '作业列表。', + 'type' => 'object', + 'properties' => [ + 'JobName' => [ + 'description' => '作业名称。', + 'type' => 'string', + 'example' => 'testJob', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'job-xxx', + ], + 'JobDescription' => [ + 'description' => '作业描述。', + 'type' => 'string', + 'example' => 'Demo', + ], + 'CreateTime' => [ + 'description' => '作业提交时间。', + 'type' => 'string', + 'example' => '2024-01-25 12:29:21', + ], + 'OwnerUid' => [ + 'description' => '创建人UID。', + 'type' => 'string', + 'example' => '129**********', + ], + 'Status' => [ + 'description' => '作业状态。可能值：'."\n" + .'- Pending：作业排队中'."\n" + .'- Initing：作业初始化中'."\n" + .'- Succeeded：作业运行成功'."\n" + .'- Failed：作业运行失败'."\n" + .'- Running：作业运行中'."\n" + .'- Exception：调度异常'."\n" + .'- Retrying：作业重试中'."\n" + .'- Expired：作业超时'."\n" + .'- Suspended：作业休眠'."\n" + .'- Restarting：作业重启中'."\n" + .'- Deleted：作业删除完成', + 'type' => 'string', + 'example' => 'Running', + ], + 'TaskCount' => [ + 'description' => '任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ExecutorCount' => [ + 'description' => '运行节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'StartTime' => [ + 'description' => '作业开始时间。', + 'type' => 'string', + 'example' => '2024-01-25 12:29:23', + ], + 'EndTime' => [ + 'description' => '作业结束时间。', + 'type' => 'string', + 'example' => '2024-01-25 12:35:23', + ], + 'TaskSustainable' => [ + 'description' => '是否是长时间运行的作业。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tags' => [ + 'description' => '作业标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '作业标签。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '作业标签键。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'TagValue' => [ + 'description' => '作业标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'Alphafold3', + ], + 'AppExtraInfo' => [ + 'description' => '应用附加信息。', + 'type' => 'string', + 'example' => '{\\"xxx\\": \\"xxxxx\\"}', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"JobList\\": [\\n {\\n \\"JobName\\": \\"testJob\\",\\n \\"JobId\\": \\"job-xxx\\",\\n \\"JobDescription\\": \\"Demo\\",\\n \\"CreateTime\\": \\"2024-01-25 12:29:21\\",\\n \\"OwnerUid\\": \\"129**********\\",\\n \\"Status\\": \\"Running\\",\\n \\"TaskCount\\": 1,\\n \\"ExecutorCount\\": 1,\\n \\"StartTime\\": \\"2024-01-25 12:29:23\\",\\n \\"EndTime\\": \\"2024-01-25 12:35:23\\",\\n \\"TaskSustainable\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"AppName\\": \\"Alphafold3\\",\\n \\"AppExtraInfo\\": \\"{\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"xxxxx\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询作业列表', + ], + 'DeleteJobs' => [ + 'summary' => '删除指定集群中一个或多个作业。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219051', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobSpec', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '待删除作业信息。', + 'type' => 'array', + 'items' => [ + 'description' => '待删除作业信息。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '待删除的作业ID。 '."\n" + .'您可以调用ListJobs查询作业ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxx'."\n", + ], + 'TaskSpec' => [ + 'description' => '待删除作业的任务详情。', + 'type' => 'array', + 'items' => [ + 'description' => '待删除作业的任务详情。', + 'type' => 'object', + 'properties' => [ + 'TaskName' => [ + 'description' => '待删除的任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'task0', + ], + 'ArrayIndex' => [ + 'description' => '待删除的数组作业索引列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数组作业索引。', + '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' => 'Executor ID列表，最大支持100条。', + 'type' => 'array', + 'items' => [ + 'description' => 'Executor ID。格式为JobId-TaskName-ArrayIndex。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxx-Task0-1'."\n", + ], + 'required' => false, + ], + ], + [ + 'name' => 'JobScheduler', + 'in' => 'query', + 'schema' => [ + 'description' => '作业调度器类型。'."\n" + ."\n" + .'- HPC'."\n" + ."\n" + .'- K8S'."\n" + ."\n" + .'默认值：HPC', + 'type' => 'string', + 'required' => false, + 'example' => 'HPC', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job id is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\"\\n}","type":"json"}]', + 'title' => '删除作业', + ], + 'ListJobExecutors' => [ + 'summary' => '查询作业Executor信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219059', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxx', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '作业名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Task0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'job-xxxx', + ], + 'TaskName' => [ + 'description' => '作业名称。', + 'type' => 'string', + 'example' => 'Task0', + ], + 'PageSize' => [ + 'description' => '每页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'string', + 'example' => '50', + ], + 'Executors' => [ + 'description' => 'Executor列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Executor属性。', + 'type' => 'object', + 'properties' => [ + 'ExecutorId' => [ + 'description' => 'Executor ID。格式为 JobId-TaskName-ArrayIndex。', + 'type' => 'string', + 'example' => 'job-xxxx-Task0-1'."\n", + ], + 'ArrayIndex' => [ + 'description' => 'Executor索引号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IpAddress' => [ + 'description' => '节点IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点IP地址。', + 'type' => 'string', + 'example' => '192.168.10.11', + ], + ], + 'ExternalIpAddress' => [ + 'description' => '节点公网IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点公网IP地址。', + 'type' => 'string', + 'example' => '116.62.100.6', + ], + ], + 'HostName' => [ + 'description' => '节点主机名数组。', + 'type' => 'array', + 'items' => [ + 'description' => '主机名。', + 'type' => 'string', + 'example' => 'compute-0', + ], + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-02-20 10:04:10', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2024-02-20 10:04:13', + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2024-02-20 10:04:18', + ], + 'Status' => [ + 'description' => 'Executor状态。可能值：'."\n" + .'- Pending：排队中'."\n" + .'- Initing：初始化中'."\n" + .'- Succeed：运行成功'."\n" + .'- Failed：运行失败'."\n" + .'- Running：运行中'."\n" + .'- Exception：调度异常'."\n" + .'- Retrying：重试中'."\n" + .'- Expired：运行超时'."\n" + .'- Suspended：作业休眠'."\n" + .'- Restarting：作业重启中'."\n" + .'- Deleted：删除完成', + 'type' => 'string', + 'example' => 'Running', + ], + 'StatusReason' => [ + 'description' => '状态原因描述。', + 'type' => 'string', + 'example' => 'ExecutorReady', + ], + 'Tags' => [ + 'description' => 'Executor标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Executor标签列表。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => 'Executor标签键。', + 'type' => 'string', + 'example' => 'TestKey'."\n", + ], + 'TagValue' => [ + 'description' => 'Executor标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + 'ExpirationTime' => [ + 'type' => 'string', + ], + 'BlockDuration' => [ + 'description' => '计算资源保留时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'Preemptible' => [ + 'type' => 'boolean', + ], + 'AllocationSpec' => [ + 'description' => '资源类型。'."\n" + ."\n" + .'- Standard：标准型。'."\n" + .'- Dedicated：专属型，需开通白名单使用。'."\n" + .'- Economic：经济型，需开通白名单使用。', + 'type' => 'string', + 'example' => 'Standard', + ], + ], + ], + ], + 'ExecutorStatus' => [ + 'description' => 'Executor状态统计。', + 'type' => 'object', + 'properties' => [ + 'Pending' => [ + 'description' => '排队状态的Executor数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Initing' => [ + 'description' => '初始化状态的Executor数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Running' => [ + 'description' => '运行中状态的Executor数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Succeeded' => [ + 'description' => '运行成功状态的Executor数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Failed' => [ + 'description' => '运行失败状态的Executor数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Deleted' => [ + 'description' => '删除状态的Executor数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Exception' => [ + 'description' => '异常状态的Executor数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Suspended' => [ + 'description' => '休眠状态的Executor数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Restarting' => [ + 'description' => '重启中状态的Executor数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job id is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"JobId\\": \\"job-xxxx\\",\\n \\"TaskName\\": \\"Task0\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": \\"50\\",\\n \\"Executors\\": [\\n {\\n \\"ExecutorId\\": \\"job-xxxx-Task0-1\\\\n\\",\\n \\"ArrayIndex\\": 0,\\n \\"IpAddress\\": [\\n \\"192.168.10.11\\"\\n ],\\n \\"ExternalIpAddress\\": [\\n \\"116.62.100.6\\"\\n ],\\n \\"HostName\\": [\\n \\"compute-0\\"\\n ],\\n \\"CreateTime\\": \\"2024-02-20 10:04:10\\",\\n \\"StartTime\\": \\"2024-02-20 10:04:13\\",\\n \\"EndTime\\": \\"2024-02-20 10:04:18\\",\\n \\"Status\\": \\"Running\\",\\n \\"StatusReason\\": \\"ExecutorReady\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\\\n\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"ExpirationTime\\": \\"\\",\\n \\"BlockDuration\\": 24,\\n \\"Preemptible\\": true,\\n \\"AllocationSpec\\": \\"Standard\\"\\n }\\n ],\\n \\"ExecutorStatus\\": {\\n \\"Pending\\": 1,\\n \\"Initing\\": 1,\\n \\"Running\\": 1,\\n \\"Succeeded\\": 1,\\n \\"Failed\\": 1,\\n \\"Deleted\\": 1,\\n \\"Exception\\": 1,\\n \\"Suspended\\": 1,\\n \\"Restarting\\": 1\\n }\\n}","type":"json"}]', + 'title' => '查询作业Executor信息', + 'description' => '查询作业Executor信息。', + ], + 'ListExecutors' => [ + 'summary' => '查询全局Executor信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219060', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询Executor过滤条件。', + 'type' => 'object', + 'properties' => [ + 'JobName' => [ + 'description' => '作业名称，支持模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'testJob', + ], + 'ExecutorIds' => [ + 'description' => 'Executor ID列表，最大支持100条。', + 'type' => 'array', + 'items' => [ + 'description' => 'Executor ID。格式为JobId-TaskName-ArrayIndex。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxx-task0-1', + ], + 'required' => false, + ], + 'IpAddresses' => [ + 'description' => '内网IP地址列表，最大支持100条。', + 'type' => 'array', + 'items' => [ + 'description' => '内网IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.1', + ], + 'required' => false, + ], + 'Status' => [ + 'description' => 'Executor状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Executor状态。取值范围：'."\n" + .'- Pending：排队中'."\n" + .'- Initing：初始化中'."\n" + .'- Succeeded：运行成功'."\n" + .'- Failed：运行失败'."\n" + .'- Running：运行中'."\n" + .'- Exception：调度异常'."\n" + .'- Retrying：重试中'."\n" + .'- Expired：超时'."\n" + .'- Suspended：作业休眠'."\n" + .'- Restarting：作业重启中'."\n" + .'- Deleted：删除完成', + 'type' => 'string', + 'required' => false, + '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', + ], + 'example' => 'Running', + 'enum' => [ + 'Pending', + 'Initing', + 'Failed', + 'Running', + 'Exception', + 'Retrying', + 'Expired', + 'Deleting', + 'Deleted', + 'Suspended', + 'Restarting', + 'Succeeded', + 'Succeed', + ], + ], + 'required' => false, + ], + 'TimeCreatedBefore' => [ + 'description' => '在此时间之前提交的作业，以所在地域的时间转化为（国内站为东八区）Unix时间戳。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1703820113', + ], + 'TimeCreatedAfter' => [ + 'description' => '在此时间之后提交的作业，以所在地域的时间转化为（国内站为东八区）Unix时间戳。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1703819914', + ], + 'VswitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-xxx', + ], + 'Image' => [ + 'description' => 'Executor镜像。', + 'type' => 'string', + 'required' => false, + 'example' => 'm-f8z0dfa96luxxxxx', + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-xxx', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的本页条数。 默认50，最大100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。 '."\n" + .'起始值：1 '."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'PageSize' => [ + 'description' => '分页查询时设置的本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'string', + 'example' => '40', + ], + 'Executors' => [ + 'description' => 'Executor列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Executor属性。', + 'type' => 'object', + 'properties' => [ + 'ExecutorId' => [ + 'description' => 'Executor ID。格式为JobId-TaskName-ArrayIndex。', + 'type' => 'string', + 'example' => 'job-xxxx-Task0-1', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'job-hy1nggvyukuvkr******', + ], + 'JobName' => [ + 'description' => '作业名称。', + 'type' => 'string', + 'example' => 'testJob', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'Task0', + ], + 'ArrayIndex' => [ + 'description' => 'Executor编号。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IpAddress' => [ + 'description' => '内网IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '内网IP地址。', + 'type' => 'string', + 'example' => '192.168.0.1', + ], + ], + 'ExternalIpAddress' => [ + 'description' => '节点公网IP地址列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点公网IP地址列表。', + 'type' => 'string', + 'example' => '116.62.100.6'."\n", + ], + ], + 'HostName' => [ + 'description' => '主机名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '主机名。', + 'type' => 'string', + 'example' => 'testJob-0', + ], + ], + 'Image' => [ + 'description' => 'Executor镜像。', + 'type' => 'string', + 'example' => 'm-f8z0dfa96luxxxxx', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-02-20 10:04:10', + ], + 'ExpirationTime' => [ + 'description' => '过期时间。', + 'type' => 'string', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2024-02-20 10:04:13', + ], + 'EndTime' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2024-02-20 10:04:18', + ], + 'Status' => [ + 'description' => 'Executor状态。可能值：'."\n" + .'- Pending：排队中'."\n" + .'- Initing：初始化中'."\n" + .'- Succeeded：运行成功'."\n" + .'- Failed：运行失败'."\n" + .'- Running：运行中'."\n" + .'- Exception：调度异常'."\n" + .'- Retrying：重试中'."\n" + .'- Expired：运行超时'."\n" + .'- Suspended：作业休眠'."\n" + .'- Restarting：作业重启中'."\n" + .'- Deleted：删除完成', + 'type' => 'string', + 'example' => 'Running', + ], + 'StatusReason' => [ + 'description' => '状态原因描述。', + 'type' => 'string', + 'example' => 'ExecutorReady', + ], + 'Resource' => [ + 'description' => '资源信息。', + 'type' => 'object', + 'properties' => [ + 'Cores' => [ + 'description' => '运行的CPU个数。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'Memory' => [ + 'description' => '内存资源总量。单位：GiB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '4', + ], + 'Disks' => [ + 'description' => '云盘数组。', + 'type' => 'array', + 'items' => [ + 'description' => '云盘属性。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '云盘类型。支持以下类型：'."\n" + ."\n" + .'- System：系统盘。'."\n" + .'- Data：数据盘。', + 'type' => 'string', + 'example' => 'System', + ], + 'Size' => [ + 'description' => '云盘大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + 'InstanceType' => [ + 'description' => '运行环境的实例规格。', + 'type' => 'string', + 'example' => 'ecs.c7a.8xlarge', + ], + ], + ], + 'VswitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-xxx', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'ECI', + ], + 'TaskSustainable' => [ + 'description' => '是否是长时间运行的作业。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Tags' => [ + 'description' => 'Executor标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Executor标签列表。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => 'Executor标签键。', + 'type' => 'string', + 'example' => 'TestKey'."\n", + ], + 'TagValue' => [ + 'description' => 'Executor标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'Alphafold3', + ], + 'BlockDuration' => [ + 'description' => '计算资源保留时长。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '24', + ], + 'Preemptible' => [ + 'type' => 'boolean', + ], + 'AllocationSpec' => [ + 'description' => '资源类型。'."\n" + .'- Standard：标准型。'."\n" + .'- Dedicated：专属型，需开通白名单使用。'."\n" + .'- Economic：经济型，需开通白名单使用。', + 'type' => 'string', + 'example' => 'Standard', + ], + 'VpcId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-xxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"PageSize\\": 50,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": \\"40\\",\\n \\"Executors\\": [\\n {\\n \\"ExecutorId\\": \\"job-xxxx-Task0-1\\",\\n \\"JobId\\": \\"job-hy1nggvyukuvkr******\\",\\n \\"JobName\\": \\"testJob\\",\\n \\"TaskName\\": \\"Task0\\",\\n \\"ArrayIndex\\": 0,\\n \\"IpAddress\\": [\\n \\"192.168.0.1\\"\\n ],\\n \\"ExternalIpAddress\\": [\\n \\"116.62.100.6\\\\n\\"\\n ],\\n \\"HostName\\": [\\n \\"testJob-0\\"\\n ],\\n \\"Image\\": \\"m-f8z0dfa96luxxxxx\\",\\n \\"CreateTime\\": \\"2024-02-20 10:04:10\\",\\n \\"ExpirationTime\\": \\"\\",\\n \\"StartTime\\": \\"2024-02-20 10:04:13\\",\\n \\"EndTime\\": \\"2024-02-20 10:04:18\\",\\n \\"Status\\": \\"Running\\",\\n \\"StatusReason\\": \\"ExecutorReady\\",\\n \\"Resource\\": {\\n \\"Cores\\": 1,\\n \\"Memory\\": 4,\\n \\"Disks\\": [\\n {\\n \\"Type\\": \\"System\\",\\n \\"Size\\": 10\\n }\\n ],\\n \\"InstanceType\\": \\"ecs.c7a.8xlarge\\"\\n },\\n \\"VswitchId\\": \\"vsw-xxx\\",\\n \\"ResourceType\\": \\"ECI\\",\\n \\"TaskSustainable\\": true,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\\\n\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ],\\n \\"AppName\\": \\"Alphafold3\\",\\n \\"BlockDuration\\": 24,\\n \\"Preemptible\\": true,\\n \\"AllocationSpec\\": \\"Standard\\",\\n \\"VpcId\\": \\"vpc-xxx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询全局Executor信息', + ], + 'ListExecutorEvents' => [ + 'summary' => '查询一个或多个Executor的运行事件列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '223066', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时设置的本页条数。 默认 50，最大 100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。 '."\n" + .'起始值：1 '."\n" + .'默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询Executor过滤条件。', + 'type' => 'object', + 'properties' => [ + 'Level' => [ + 'description' => '运行事件等级。取值范围：'."\n" + .'- Normal'."\n" + .'- Warning'."\n" + .'- Error', + 'type' => 'string', + 'required' => false, + 'example' => 'Normal', + ], + 'TimeAfter' => [ + 'description' => '在此时间之后发生的事件，以所在地域的时间（国内站为东八区）转化为Unix 时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1703820113', + ], + 'TimeBefore' => [ + 'description' => '在此时间之前发生的事件，以所在地域的时间（国内站为东八区）转化为Unix 时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1703819914', + ], + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxx', + ], + 'ExecutorIds' => [ + 'description' => 'Executor ID 列表，最大支持 100 条。', + 'type' => 'array', + 'items' => [ + 'description' => 'Executor ID。格式为 JobId-TaskName-ArrayIndex。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxx-Task0-1', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'PageSize' => [ + 'description' => '分页查询时设置的本页条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'PageNumber' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '40', + ], + 'ExecutorEventList' => [ + 'description' => '运行事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '运行事件属性。', + 'type' => 'object', + 'properties' => [ + 'JobId' => [ + 'description' => '作业ID。', + 'type' => 'string', + 'example' => 'job-xxxx', + ], + 'ExecutorId' => [ + 'description' => 'Executor ID。格式为JobId-TaskName-ArrayIndex。', + 'type' => 'string', + 'example' => 'job-xxxx-Task0-1', + ], + 'Level' => [ + 'description' => '运行事件等级。取值范围：'."\n" + .'- Normal'."\n" + .'- Warning'."\n" + .'- Error', + 'type' => 'string', + 'example' => 'Normal', + ], + 'Time' => [ + 'description' => '运行事件发生的事件。', + 'type' => 'string', + 'example' => '2024-02-20 10:04:13', + ], + 'Content' => [ + 'description' => '运行事件内容。', + 'type' => 'string', + 'example' => 'Executor created successfully', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job id is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"PageSize\\": 50,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 40,\\n \\"ExecutorEventList\\": [\\n {\\n \\"JobId\\": \\"job-xxxx\\",\\n \\"ExecutorId\\": \\"job-xxxx-Task0-1\\",\\n \\"Level\\": \\"Normal\\",\\n \\"Time\\": \\"2024-02-20 10:04:13\\",\\n \\"Content\\": \\"Executor created successfully\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询Executor运行事件', + 'description' => '查询作业Executor信息。', + ], + 'DeleteJobRecords' => [ + 'summary' => '删除指定集群中一个或多个处于终态的作业记录。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219051', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '作业ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待删除记录的作业ID。'."\n" + ."\n" + .'您可以调用ListJobs查询作业ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxx', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job id is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]', + 'title' => '删除作业记录', + ], + 'DescribeJobResults' => [ + 'summary' => '查询作业日志', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '223066', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '作业 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxxxxx', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Task0', + ], + ], + [ + 'name' => 'ArrayIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'Executor编号', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0_1', + ], + ], + [ + 'name' => 'ContentEncoding', + 'in' => 'query', + 'schema' => [ + 'description' => '设置返回数据中`CommandContent`字段和`Output`字段的编码方式。取值范围：'."\n" + .'- PlainText：返回原始脚本内容和输出信息。'."\n" + .'- Base64：返回Base64编码后的脚本内容和输出信息。'."\n" + ."\n" + .'默认值为Base64。', + 'type' => 'string', + 'required' => false, + 'example' => 'PlainText', + ], + ], + [ + 'name' => 'LimitBytes', + 'in' => 'query', + 'schema' => [ + 'description' => '日志总大小的限制。单位为Byte，取值范围为1~1048576（1 MB）。', + 'type' => 'string', + 'required' => false, + 'example' => '1048576', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'UTC 时间，RFC3339 标准。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-09-02T16:00:00Z', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'BABC742E-04D7-5BA5-8A5F-7D9461D37B19', + ], + 'Output' => [ + 'description' => '命令执行后的输出信息。若ContentEncoding指定PlainText，返回原始输出信息。若ContentEncoding指定Base64，返回Base64编码后的输出信息。', + 'type' => 'string', + 'example' => 'MTU6MzA6MDEK', + ], + 'ExitCode' => [ + 'description' => '命令的退出码。'."\n" + ."\n" + .'- Linux实例为Shell命令的退出码。'."\n" + .'- Windows实例为Bat或者PowerShell命令的退出码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job id is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BABC742E-04D7-5BA5-8A5F-7D9461D37B19\\",\\n \\"Output\\": \\"MTU6MzA6MDEK\\",\\n \\"ExitCode\\": 0\\n}","type":"json"}]', + 'title' => '查询作业日志', + ], + 'DescribeJobMetricData' => [ + 'summary' => '通过指定特定作业数组索引及查询监控项参数，查询作业的监控时序数据集。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219038', + 'abilityTreeNodes' => [ + 'FEATUREehpcR6Y931', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '作业 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'job-xxxxx'."\n", + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Task0'."\n", + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '作业监控项。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cpu_utilization'."\n", + ], + ], + [ + 'name' => 'ArrayIndex', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数组作业索引列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数组作业索引。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n", + ], + 'Period' => [ + 'description' => '监控数据的统计周期。取值：15、60、900 和 3600。单位：秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'DataPoints' => [ + 'description' => '监控统计数据点。', + 'type' => 'string', + 'example' => '[{"timestamp":1709540685000,"Minimum":28.45,"Maximum":28.45,"Average":28.45}]'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job id is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\",\\n \\"Period\\": 15,\\n \\"DataPoints\\": \\"[{\\\\\\"timestamp\\\\\\":1709540685000,\\\\\\"Minimum\\\\\\":28.45,\\\\\\"Maximum\\\\\\":28.45,\\\\\\"Average\\\\\\":28.45}]\\\\n\\"\\n}","type":"json"}]', + 'title' => '查询作业监控项的监控数据', + ], + 'DescribeJobMetricLast' => [ + 'summary' => '通过指定特定的作业数组索引列表，查询作业数组列表下的所有即时监控指标。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219041', + 'abilityTreeNodes' => [ + 'FEATUREehpcR6Y931', + ], + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'description' => '作业 ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'job-xxxxx'."\n", + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Task0', + ], + ], + [ + 'name' => 'ArrayIndex', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '数组作业索引列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数组作业索引。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n", + ], + 'Metrics' => [ + 'description' => 'JobMetric 信息详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'JobMetric 信息详情。', + 'type' => 'object', + 'properties' => [ + 'ArrayIndex' => [ + 'description' => '数组作业索引。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Metric' => [ + 'description' => '数组作业索引对应的监控项信息。', + 'type' => 'string', + 'example' => '{"memory_utilization": 37.42,"cpu_utilization": 1.008, "disk_utilization": 3.562}'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job id is not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\",\\n \\"Metrics\\": [\\n {\\n \\"ArrayIndex\\": 1,\\n \\"Metric\\": \\"{\\\\\\"memory_utilization\\\\\\": 37.42,\\\\\\"cpu_utilization\\\\\\": 1.008, \\\\\\"disk_utilization\\\\\\": 3.562}\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询作业监控项的即时监控数据', + ], + 'TagResources' => [ + 'summary' => '为Instant资源列表统一创建并绑定标签', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '239758', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型定义。取值范围：'."\n" + .'- Job'."\n" + .'- Executor', + 'type' => 'string', + 'required' => true, + 'example' => 'Job', + 'enum' => [], + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID列表。N 的取值范围为：1~50', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。'."\n" + .'- 若ResourceType为`Job`，资源ID传入Job ID'."\n" + .'- 若ResourceType为`Executor`，资源ID传入Executor ID', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxxxxxx', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '标签列表，最多包含20个子项。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或 https://。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能包含 http://或者 https://。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job id is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'DuplicateTagKey', + 'errorMessage' => 'Duplicate tag key exists: %s.', + ], + [ + 'errorCode' => 'ExecutorNotFound', + 'errorMessage' => 'The specified job executor was not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'TagError', + 'errorMessage' => 'Tag operation error.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]', + 'title' => '创建并绑定标签', + ], + 'ListTagResources' => [ + 'summary' => '查询一个或多个Instant资源已经绑定的标签列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240622', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型定义。取值范围：'."\n" + ."\n" + .'- Job'."\n" + .'- Executor', + 'type' => 'string', + 'required' => true, + 'example' => 'Job', + 'enum' => [], + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID列表。N 的取值范围为：1~50', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。'."\n" + ."\n" + .'- 若ResourceType为`Job`，资源ID传入Job ID'."\n" + .'- 若ResourceType为`Executor`，资源ID传入Executor ID', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxxxxxx', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表，最多包含20个子项', + 'description' => '标签列表，最多包含20个子项。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键', + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '下一个查询开始 Token。', + 'type' => 'string', + 'required' => false, + 'example' => '1d2db86scXXXXXXXXXX', + ], + ], + [ + 'name' => 'MaxResult', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'title' => '下一个查询开始Token，NextToken为空说明没有下一个', + 'description' => '下一个查询开始Token，NextToken为空说明没有下一个。', + 'type' => 'string', + 'example' => '1d2db86scXXXXXXXXXX', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n", + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'title' => '资源列表', + 'description' => '资源列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'title' => '资源类型', + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'Job', + ], + 'TagValue' => [ + 'title' => '标签值', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + 'ResourceId' => [ + 'title' => '资源ID', + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'job-xxxxxxxx'."\n", + ], + 'TagKey' => [ + 'title' => '标签键', + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'TestKey', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job id is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'DuplicateTagKey', + 'errorMessage' => 'Duplicate tag key exists: %s.', + ], + [ + 'errorCode' => 'ExecutorNotFound', + 'errorMessage' => 'The specified job executor was not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'TagError', + 'errorMessage' => 'Tag operation error.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"1d2db86scXXXXXXXXXX\\",\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"Job\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"job-xxxxxxxx\\\\n\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询已经绑定的标签列表', + ], + 'UnTagResources' => [ + 'summary' => '为Instant资源列表统一解绑标签。解绑后，如果该标签没有绑定其他任何资源，会被自动删除。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240623', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型定义。取值范围：'."\n" + ."\n" + .'- Job'."\n" + .'- Executor', + 'type' => 'string', + 'required' => true, + 'example' => 'Job'."\n", + 'enum' => [], + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID列表。N 的取值范围为：1~50', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。'."\n" + ."\n" + .'若ResourceType为`Job`，资源ID传入Job ID'."\n" + .'若ResourceType为`Executor`，资源ID传入Executor ID', + 'type' => 'string', + 'required' => false, + 'example' => 'job-xxxxxxxx'."\n", + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键列表，最多包含20个子项。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey'."\n", + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除目标资源的所有标签，仅TagKey.N为空时生效。默认 False', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'JobNotFound', + 'errorMessage' => 'The specified job id is not found.', + ], + ], + 403 => [ + [ + 'errorCode' => 'DuplicateTagKey', + 'errorMessage' => 'Duplicate tag key exists: %s.', + ], + [ + 'errorCode' => 'ExecutorNotFound', + 'errorMessage' => 'The specified job executor was not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'TagError', + 'errorMessage' => 'Tag operation error.', + ], + ], + [ + [ + 'errorCode' => 'NotAuthorized', + 'errorMessage' => 'No authorization is granted.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]', + 'title' => '统一解绑标签', + ], + 'CreatePool' => [ + 'summary' => '创建资源池。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '248937', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源池名称。'."\n" + .'- 长度不超过15个字符。'."\n" + .'- 可包含数字、大写字母、小写字母、下划线（_）和点（.）。', + 'type' => 'string', + 'required' => true, + 'example' => 'PoolTest', + 'maxLength' => 32, + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '资源池的优先级。'."\n" + ."\n" + .'- 优先级可设置范围：1~99。默认值为1，即最低优先级。'."\n" + .'- 提交到具有较高优先级层级值的资源池的作业将在较低优先级层级值的资源池中的挂起作业之前进行调度，资源池的优先级层级优先于作业的优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceLimits', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户在一个资源池内允许并发使用的资源配额限制。', + 'type' => 'object', + 'properties' => [ + 'MaxExectorNum' => [ + 'description' => '用户在一个资源池内允许并发执行节点数量限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2000', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + [ + 'errorCode' => 'PoolAlreadyExists', + 'errorMessage' => 'The pool already exists.', + ], + ], + 403 => [ + [ + 'errorCode' => 'GetResourceFailed', + 'errorMessage' => 'Failed to get resource.', + ], + [ + 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', + 'errorMessage' => 'The resource is out of stock.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]', + 'title' => '创建资源池', + ], + 'UpdatePool' => [ + 'summary' => '更新资源池配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '257986', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源池名称。'."\n" + .'- 长度不超过15个字符。'."\n" + .'- 可包含数字、大写字母、小写字母、下划线（_）和点（.）。', + 'type' => 'string', + 'required' => true, + 'example' => 'PoolTest', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'description' => '资源池的优先级。'."\n" + ."\n" + .'- 优先级可设置范围：1~99。默认值为1，即最低优先级。'."\n" + .'- 提交到具有较高优先级层级值的资源池的作业将在较低优先级层级值的资源池中的挂起作业之前进行调度，资源池的优先级层级优先于作业的优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ResourceLimits', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户在一个资源池内允许并发使用的资源配额限制。', + 'type' => 'object', + 'properties' => [ + 'MaxExectorNum' => [ + 'description' => '用户在一个资源池内允许并发执行节点数量限制。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2000', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '04F0F334-1335-436C-A1D7-6C044FE7****'."\n", + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + ], + 403 => [ + [ + 'errorCode' => 'GetResourceFailed', + 'errorMessage' => 'Failed to get resource.', + ], + [ + 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', + 'errorMessage' => 'The resource is out of stock.', + ], + [ + 'errorCode' => 'PoolNotFound', + 'errorMessage' => 'The specified pool was not found.', + ], + [ + 'errorCode' => 'PoolStatusInvalid', + 'errorMessage' => 'The specified pool in invalid status.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE7****\\\\n\\"\\n}","type":"json"}]', + 'title' => '更新资源池配置', + ], + 'GetPool' => [ + 'summary' => '获取资源池详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250272', + 'abilityTreeNodes' => [ + 'FEATUREehpcKIUG5Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源池名称。'."\n" + .'- 长度不超过15个字符。'."\n" + .'- 可包含数字、大写字母、小写字母、下划线（_）和点（.）。', + 'type' => 'string', + 'required' => true, + 'example' => 'PoolTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'PoolInfo' => [ + 'description' => '资源池信息。', + 'type' => 'object', + 'properties' => [ + 'PoolName' => [ + 'description' => '资源池名称。'."\n" + .'- 长度不超过15个字符。'."\n" + .'- 可包含数字、大写字母、小写字母、下划线（_）和点（.）。', + 'type' => 'string', + 'example' => 'PoolTest', + ], + 'Status' => [ + 'description' => '资源池状态。取值范围：'."\n" + ."\n" + .'- Creating：资源池创建中'."\n" + .'- Updating：资源池更新中'."\n" + .'- Deleting：资源池删除中'."\n" + .'- Working：资源池工作中'."\n" + .'- Deleted：资源池删除完成', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Working', + ], + 'IsDefault' => [ + 'description' => '是否是默认资源池。取值说明：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Priority' => [ + 'description' => '资源池的优先级。'."\n" + ."\n" + .'- 优先级可设置范围：1~99。默认值为1，即最低优先级。'."\n" + .'- 提交到具有较高优先级层级值的资源池的作业将在较低优先级层级值的资源池中的挂起作业之前进行调度，资源池的优先级层级优先于作业的优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'MaxExectorNum' => [ + 'description' => '用户在一个资源池内允许并发运行的执行节点数量限制。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + 'ExectorUsage' => [ + 'description' => '在一个资源池内正在运行的执行节点用量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreateTime' => [ + 'description' => '资源池创建时间。', + 'type' => 'string', + 'example' => '2024-12-01 20:00:00', + ], + 'UpdateTime' => [ + 'description' => '资源池更新时间。', + 'type' => 'string', + 'example' => '2024-12-01 20:00:00', + ], + 'Reason' => [ + 'description' => '错误原因。', + 'type' => 'string', + 'example' => 'Fails to *** pool: ***.', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + ], + 403 => [ + [ + 'errorCode' => 'GetResourceFailed', + 'errorMessage' => 'Failed to get resource.', + ], + [ + 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', + 'errorMessage' => 'The resource is out of stock.', + ], + [ + 'errorCode' => 'PoolNotFound', + 'errorMessage' => 'The specified pool was not found.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"PoolInfo\\": {\\n \\"PoolName\\": \\"PoolTest\\",\\n \\"Status\\": \\"Working\\",\\n \\"IsDefault\\": true,\\n \\"Priority\\": 1,\\n \\"MaxExectorNum\\": 2000,\\n \\"ExectorUsage\\": 1,\\n \\"CreateTime\\": \\"2024-12-01 20:00:00\\",\\n \\"UpdateTime\\": \\"2024-12-01 20:00:00\\",\\n \\"Reason\\": \\"Fails to *** pool: ***.\\"\\n }\\n}","type":"json"}]', + 'title' => '获取资源池详情', + ], + 'ListPools' => [ + 'summary' => '查询资源池列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249321', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询资源池过滤条件。', + 'type' => 'object', + 'properties' => [ + 'PoolName' => [ + 'description' => '查询资源池名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源池名称。'."\n" + .'- 长度不超过15个字符。'."\n" + .'- 可包含数字、大写字母、小写字母、下划线（_）和点（.）。', + 'type' => 'string', + 'required' => false, + 'example' => 'PoolTest', + ], + 'required' => false, + ], + 'Status' => [ + 'description' => '查询资源池状态列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源池状态。取值范围：'."\n" + ."\n" + .'- Creating：资源池创建中'."\n" + .'- Updating：资源池更新中'."\n" + .'- Deleting：资源池删除中'."\n" + .'- Working：资源池工作中'."\n" + .'- Deleted：资源池删除完成', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Working', + 'enum' => [ + 'Creating', + 'Working', + 'Updating', + 'Deleting', + 'Deleted', + ], + ], + 'required' => false, + ], + 'TimeCreatedBefore' => [ + 'description' => '在此时间之前创建的节点池，以所在地域的时间转化为（国内站为东八区）Unix时间戳。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1703820113', + ], + 'TimeCreatedAfter' => [ + 'description' => '在此时间之后创建的节点池，以所在地域的时间转化为（国内站为东八区）Unix时间戳。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1703819914', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询时每页的行数，最大值为50，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + 'PageSize' => [ + 'description' => '分页查询时每页的行数，最大值为50，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => '当前页码。默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalCount' => [ + 'description' => '列表条目总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'PoolList' => [ + 'description' => '查询资源池列表。', + 'type' => 'array', + 'items' => [ + 'description' => '列表中单个资源池信息。', + 'type' => 'object', + 'properties' => [ + 'PoolName' => [ + 'description' => '资源池名称。'."\n" + .'- 长度不超过15个字符。'."\n" + .'- 可包含数字、大写字母、小写字母、下划线（_）和点（.）。', + 'type' => 'string', + 'example' => 'PoolTest', + ], + 'Status' => [ + 'description' => '资源池状态。取值范围：'."\n" + ."\n" + .'- Creating：资源池创建中'."\n" + .'- Updating：资源池更新中'."\n" + .'- Deleting：资源池删除中'."\n" + .'- Working：资源池工作中'."\n" + .'- Deleted：资源池删除完成', + 'type' => 'string', + 'example' => 'Working', + ], + 'Priority' => [ + 'description' => '资源池的优先级。'."\n" + ."\n" + .'- 优先级可设置范围：1~99。默认值为1，即最低优先级。'."\n" + .'- 提交到具有较高优先级层级值的资源池的作业将在较低优先级层级值的资源池中的挂起作业之前进行调度，资源池的优先级层级优先于作业的优先级。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsDefault' => [ + 'description' => '是否是默认资源池。取值说明：'."\n" + ."\n" + .'- **true**：是'."\n" + .'- **false**：否', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MaxExectorNum' => [ + 'description' => '用户在一个资源池内允许并发运行的执行节点数量限制。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2000', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + ], + 403 => [ + [ + 'errorCode' => 'GetResourceFailed', + 'errorMessage' => 'Failed to get resource.', + ], + [ + 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', + 'errorMessage' => 'The resource is out of stock.', + ], + ], + [ + [ + 'errorCode' => 'ImageNotFound', + 'errorMessage' => 'The specified image does not exist.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 2,\\n \\"PoolList\\": [\\n {\\n \\"PoolName\\": \\"PoolTest\\",\\n \\"Status\\": \\"Working\\",\\n \\"Priority\\": 1,\\n \\"IsDefault\\": true,\\n \\"MaxExectorNum\\": 2000\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询资源池列表', + ], + 'DeletePool' => [ + 'summary' => '删除资源池。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249322', + 'abilityTreeNodes' => [ + 'FEATUREehpcSHKJ2Q', + 'FEATUREehpcKIUG5Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源池名称。'."\n" + .'- 长度不超过15个字符。'."\n" + .'- 可包含数字、大写字母、小写字母、下划线（_）和点（.）。', + 'type' => 'string', + 'required' => true, + 'example' => 'PoolTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '896D338C-E4F4-41EC-A154-D605E5DE****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParams', + 'errorMessage' => 'The specified parameter %s is invalid.', + ], + [ + 'errorCode' => 'InDebt', + 'errorMessage' => 'Your account has overdue payments.', + ], + [ + 'errorCode' => 'NotEnabled', + 'errorMessage' => 'You have not enabled this service.', + ], + ], + 403 => [ + [ + 'errorCode' => 'GetResourceFailed', + 'errorMessage' => 'Failed to get resource.', + ], + [ + 'errorCode' => 'RecommendEmpty.InstanceTypeSoldOut', + 'errorMessage' => 'The resource is out of stock.', + ], + [ + 'errorCode' => 'PoolNotFound', + 'errorMessage' => 'The specified pool was not found.', + ], + [ + 'errorCode' => 'PoolStatusInvalid', + 'errorMessage' => 'The specified pool in invalid status.', + ], + [ + 'errorCode' => 'PoolInUse', + 'errorMessage' => 'The specified pool is in use.', + ], + ], + 406 => [ + [ + 'errorCode' => 'AliyunError', + 'errorMessage' => 'An Alibaba Cloud product error occurred.', + ], + [ + 'errorCode' => 'EcsError', + 'errorMessage' => 'An error occurred while calling the ECS API operation.', + ], + [ + 'errorCode' => 'DbError', + 'errorMessage' => 'A database error occurred.', + ], + ], + 503 => [ + [ + 'errorCode' => 'ServiceUnavailable', + 'errorMessage' => 'The request has failed due to a temporary failure of the server.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"896D338C-E4F4-41EC-A154-D605E5DE****\\"\\n}","type":"json"}]', + 'title' => '删除资源池', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'ehpcinstant.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'ehpcinstant.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'ehpcinstant.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'ehpcinstant.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'ehpcinstant.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'ehpcinstant.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'ehpcinstant.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'ehpcinstant.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'ehpcinstant.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'ehpcinstant.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ehpcinstant.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'ehpcinstant.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'ehpcinstant.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'ehpcinstant.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'ehpcinstant.ap-southeast-3.aliyuncs.com', + ], + ], +]; -- cgit v1.2.3