文档首页/ 资源编排服务 RFS/ API参考（吉隆坡区域）/ API/ 执行计划/ 列举执行计划
更新时间：2024-12-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

列举执行计划

功能介绍

列举执行计划（ListExecutionPlans）

列举当前局点下用户指定资源栈下所有的执行计划

  • 默认按照生成时间降序排序，最新生成的在最前
  • 注意：目前暂时返回全量执行计划信息，即不支持分页
  • 如果指定的资源栈下没有任何执行计划，则返回空list
  • 如果指定的资源栈不存在，则返回404

ListExecutionPlans返回的只有摘要信息（具体摘要信息见ListExecutionPlansResponseBody），如果用户需要详细的执行计划元数据请调用GetExecutionPlanMetadata

URI

GET /v1/{project_id}/stacks/{stack_name}/execution-plans

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，可以从调用API处获取，也可以从控制台获取。

项目ID获取方式

最小长度：3

最大长度：64

stack_name

是

String

资源栈的名称。此名字在domain_id+区域+project_id下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

最小长度：1

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

stack_id

否

String

资源栈（stack）的唯一Id。

此Id由资源编排服务在生成资源栈的时候生成，为UUID。

由于资源栈名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈，删除，再重新创建一个同名资源栈。

对于团队并行开发，用户可能希望确保，当前我操作的资源栈就是我认为的那个，而不是其他队友删除后创建的同名资源栈。因此，使用ID就可以做到强匹配。

资源编排服务保证每次创建的资源栈所对应的ID都不相同，更新不会影响ID。如果给予的stack_id和当前资源栈的ID不一致，则返回400

最小长度：36

最大长度：36

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Client-Request-Id

是

String

用户指定的，对于此请求的唯一ID，用于定位某个请求，推荐使用UUID

最小长度：36

最大长度：128

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

execution_plans

Array of ExecutionPlan objects

执行计划列表。默认按照生成时间降序排序，最新生成的在最前
表5 ExecutionPlan

参数

参数类型

描述

stack_name

String

资源栈的名称。此名字在domain_id+区域+project_id下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

最小长度：1

最大长度：128

stack_id

String

资源栈（stack）的唯一Id。

此Id由资源编排服务在生成资源栈的时候生成，为UUID。

由于资源栈名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的资源栈，删除，再重新创建一个同名资源栈。

对于团队并行开发，用户可能希望确保，当前我操作的资源栈就是我认为的那个，而不是其他队友删除后创建的同名资源栈。因此，使用ID就可以做到强匹配。

资源编排服务保证每次创建的资源栈所对应的ID都不相同，更新不会影响ID。如果给予的stack_id和当前资源栈的ID不一致，则返回400

最小长度：36

最大长度：36

execution_plan_id

String

执行计划（execution_plan）的唯一Id。

此Id由资源编排服务在生成执行计划的时候生成，为UUID。

由于执行计划名仅仅在同一时间下唯一，即用户允许先生成一个叫HelloWorld的执行计划，删除，再重新创建一个同名执行计划。

对于团队并行开发，用户可能希望确保，当前我操作的执行计划就是我认为的那个，而不是其他队友删除后创建的同名执行计划。因此，使用ID就可以做到强匹配。

资源编排服务保证每次创建的执行计划所对应的ID都不相同，更新不会影响ID。如果给予的execution_plan_id和当前执行计划的ID不一致，则返回400

注意：

  • 创建执行计划后，资源编排服务持久化请求并立即返回，客户端不等待请求最终处理完成，用户无法实时感知请求处理结果
  • 资源编排服务最终会将异步部署请求排队，在服务端空闲的情况下逐个处理。用户最大等待时长为1小时

最小长度：36

最大长度：36

execution_plan_name

String

执行计划的名称。此名字在domain_id+区域+project_id+stack_id下应唯一，可以使用中文、大小写英文、数字、下划线、中划线。首字符需为中文或者英文，区分大小写。

最小长度：1

最大长度：128

description

String

执行计划的描述。可用于客户识别自己的执行计划。

最小长度：0

最大长度：1024

status

String

执行计划的状态 * CREATION_IN_PROGRESS - 正在创建，请等待 * CREATION_FAILED - 创建失败，请从status_message获取错误信息汇总 * AVAILABLE - 创建完成，可以调用ApplyExecutionPlan API进行执行 * APPLY_IN_PROGRESS - 执行中，可通过GetStackMetadata查询资源栈状态，通过ListStackEvents获取执行过程中产生的资源栈事件 * APPLIED - 已执行

枚举值：

  • CREATION_IN_PROGRESS
  • CREATION_FAILED
  • AVAILABLE
  • APPLY_IN_PROGRESS
  • APPLIED

status_message

String

当执行计划的状态为创建失败状态（即为 CREATION_FAILED 时），将会展示简要的错误信息总结以供debug

create_time

String

执行计划的生成时间，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z

apply_time

String

执行计划的执行时间，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 429

表10 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

响应码

最小长度：11

最大长度：11

error_msg

String

响应消息

encoded_authorization_message

String

包含有关未经授权请求的信息。

请求示例

  • 列举用户指定资源栈下的所有的执行计划 
    GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/execution-plans
  • 列举用户指定资源栈下的所有的执行计划，并提供资源栈id以校验是否与当前资源栈匹配 
    GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/execution-plans?stack_id=f689e9fd-97e7-4185-bd8a-7d5f708d45d7

响应示例

状态码： 200

列举执行计划成功

{
  "execution_plans" : [ {
    "stack_name" : "my_hello_world_stack",
    "stack_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7",
    "execution_plan_id" : "b3e7e15f-f96b-4190-94f4-bb8120f8c4dc",
    "execution_plan_name" : "my_third_execution_plan",
    "description" : "my third execution plan",
    "status" : "AVAILABLE",
    "create_time" : "2023-05-15T15:39:25Z"
  }, {
    "stack_name" : "my_hello_world_stack",
    "stack_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7",
    "execution_plan_id" : "3ca87537-8d5c-4c9d-9292-d19068aaacbb",
    "execution_plan_name" : "my_second_execution_plan",
    "description" : "my second execution plan",
    "status" : "APPLIED",
    "create_time" : "2023-05-15T15:32:45Z"
  }, {
    "stack_name" : "my_hello_world_stack",
    "stack_id" : "f689e9fd-97e7-4185-bd8a-7d5f708d45d7",
    "execution_plan_id" : "8c1fb31d-9eec-4ce3-a4e6-fd07059cec83",
    "execution_plan_name" : "my_first_execution_plan",
    "description" : "my first execution plan",
    "status" : "CREATION_FAILED",
    "status_message" : "Failed to init workflow due to bad template. Error: Invalid variable name A name must start with a letter or underscore and may contain only letters, digits, underscores, and dashes.",
    "create_time" : "2023-05-15T12:23:38Z"
  } ]
}

状态码

状态码

描述

200

列举执行计划成功

400

用户请求非法

401

用户身份认证失败

403

用户无权限调用此API

404

资源栈不存在

429

请求数量过多

500

服务器内部错误
父主题： 执行计划