文档

ListProvisionedProductPlans - 查询计划列表

更新时间:
一键部署

查询计划列表。可分用户维度和审批维度进行查询。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
servicecatalog:ListProvisionedProductPlansList
  • ProvisionedProduct
    acs:servicecatalog:{#regionId}:{#accountId}:provisionedproduct/*
  • servicecatalog:UserLevel
  • servicecatalog:ApprovalActor

请求参数

名称类型必填描述示例值
Filtersobject []

过滤条件。

Keystring

过滤条件的名称。取值:

  • ProvisionedProductPlanName:按计划名称查找,完整匹配(忽略大小写)。
  • ProvisionedProductPlanApprover:按审批人精确查找,格式为RamUser/RamRole:<审批人名称>,可多选。
  • ProvisionedProductPlanApproverName:按审批人名称查找,直接输入审批人的 RAM 实体名称,可多选。
  • ProvisionedProductPlanStatus:按计划状态查找,直接输入计划状态,可多选。
  • ProvisionedProductPlanOwnerUid:按计划归属云账号 ID 精确查找。
  • FullTextSearch:全文检索,按计划名称查找,模糊匹配。
FullTextSearch
Valuestring

过滤条件的值。

ECS
SortBystring

排序字段。

取值为 CreateTime,表示计划创建时间。

CreateTime
SortOrderstring

排序方式。取值:

  • Asc:正序。
  • Desc(默认值):倒序。
Desc
PageNumberinteger

页码。

起始值:1。默认值:1。

1
PageSizeinteger

分页时每页显示的数据行数。

取值范围:1~100。起始值:1。默认值:10。

10
AccessLevelFilterstring

访问过滤器。取值:

  • User(默认值):用户。
  • Account:账号。
  • ResourceDirectory:资源目录。
User
ApprovalFilterstring

审批维度访问过滤器。取值:

  • ReceivedRequests:待我审批。
  • ApprovalHistory:审批历史。
  • AccountRequests:账号级别全部审批。
  • ResourceDirectoryRequests:资源目录级别全部审批。
ReceivedRequests
ProvisionedProductIdstring

实例 ID。

pp-bp1ddg1n2a****

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

0FEEF92D-4052-5202-87D0-3D8EC16F****
PlanDetailsobject []

计划列表。

PlanIdstring

计划 ID。

plan-bp18mmdh2u****
PlanNamestring

计划名称。

DEMO-创建ECS-637****
PlanTypestring

计划类型。

取值为 Ros,表示阿里云资源编排服务(ROS)。

Ros
PortfolioIdstring

产品组合 ID。

port-bp1438kf2j****
ProductIdstring

产品 ID。

prod-bp1rtrnh2c****
ProductVersionIdstring

产品版本 ID。

pv-bp19udk22v****
ProvisionedProductIdstring

实例 ID。

pp-bp1c35162d****
Parametersobject []

用户输入的模板参数。

ParameterKeystring

模板中定义的参数名称。

role_name
ParameterValuestring

用户输入的模板参数值。

Test-8
ProvisionedProductNamestring

实例名称。

rds-MYSQL-875****
StackIdstring

阿里云资源编排服务(ROS)资源栈 ID。

2599090a-309e-4306-b989-17ba66a9****
StackRegionIdstring

阿里云资源编排服务(ROS)资源栈所属的地域 ID。

cn-hangzhou
Statusstring

计划状态。取值:

  • PreviewInProgress:预检中。
  • PreviewSuccess:预检成功。
  • PreviewFailed:预检失败。
  • ApplicationInProgress:审批中。
  • ApplicationApproved:审批通过。
  • ApplicationRejected:审批被拒绝。
  • ExecuteInProgress:执行中。
  • ExecuteSuccess:执行成功。
  • ExecuteFailed:执行失败。
  • Canceled:已取消。
PreviewSuccess
StatusMessagestring

计划状态信息。

说明 仅在计划状态为 PreviewFailed 或 ExecuteFailed 时,返回该参数。
Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...
CreateTimestring

计划创建时间。

按照 ISO8601 标准表示,使用 UTC 时间,格式:YYYY-MM-DDThh:mm:ssZ。

2022-09-13T02:01:22Z
UpdateTimestring

计划最后更新时间。

按照 ISO8601 标准表示,使用 UTC 时间,格式:YYYY-MM-DDThh:mm:ssZ。

2022-07-18T06:02:35.075Z
Tagsobject []

用户自定义标签列表。

Keystring

用户自定义标签键。

k1
Valuestring

用户自定义标签值。

v1
OperationTypestring

计划操作类型。取值:

  • LaunchProduct(默认):启动产品。
  • UpdateProvisionedProduct:更新实例。
  • TerminateProvisionedProduct:终止实例。
LaunchProduct
AssignedApproversobject []

计划审批人列表。

PrincipalTypestring

计划审批人的 RAM 实体类型。取值:

  • RamUser:RAM 用户。
  • RamRole:RAM 角色。
RamUser
PrincipalNamestring

计划审批人的 RAM 实体名称。

endUser
ProductNamestring

产品名称。

创建ECS
Descriptionstring

计划描述。

开发团队使用
OwnerPrincipalTypestring

计划归属人的 RAM 实体类型。取值:

  • RamUser:RAM 用户。
  • RamRole:RAM 角色。
RamUser
OwnerPrincipalIdstring

计划归属人的 RAM 实体 ID。

24477111603637****
OwnerPrincipalNamestring

计划归属人的 RAM 实体名称。

enduser
Uidstring

计划归属人的云账号 ID。

146611588617****
TotalCountinteger

总记录数。

16
PageNumberinteger

页码。

起始值:1。默认值:1。

1
PageSizeinteger

分页时每页显示的数据行数。

取值范围:1~100。起始值:1。默认值:10。

10

示例

正常返回示例

JSON格式

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F****",
  "PlanDetails": [
    {
      "PlanId": "plan-bp18mmdh2u****",
      "PlanName": "DEMO-创建ECS-637****",
      "PlanType": "Ros",
      "PortfolioId": "port-bp1438kf2j****",
      "ProductId": "prod-bp1rtrnh2c****",
      "ProductVersionId": "pv-bp19udk22v****",
      "ProvisionedProductId": "pp-bp1c35162d****",
      "Parameters": [
        {
          "ParameterKey": "role_name",
          "ParameterValue": "Test-8"
        }
      ],
      "ProvisionedProductName": "rds-MYSQL-875****",
      "StackId": "2599090a-309e-4306-b989-17ba66a9****",
      "StackRegionId": "cn-hangzhou",
      "Status": "PreviewSuccess",
      "StatusMessage": "Create stack failed: Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
      "CreateTime": "2022-09-13T02:01:22Z",
      "UpdateTime": "2022-07-18T06:02:35.075Z",
      "Tags": [
        {
          "Key": "k1",
          "Value": "v1"
        }
      ],
      "OperationType": "LaunchProduct",
      "AssignedApprovers": [
        {
          "PrincipalType": "RamUser",
          "PrincipalName": "endUser"
        }
      ],
      "ProductName": "创建ECS",
      "Description": "开发团队使用",
      "OwnerPrincipalType": "RamUser",
      "OwnerPrincipalId": "24477111603637****\n",
      "OwnerPrincipalName": "enduser",
      "Uid": "146611588617****"
    }
  ],
  "TotalCount": 16,
  "PageNumber": 1,
  "PageSize": 10
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorA system error occurred.内部错误。

访问错误中心查看更多错误码。