文档

ListProvisionedProducts - 查询实例列表

更新时间:
一键部署

查询实例列表。

调试

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

授权信息

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

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

请求参数

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

过滤条件。

Keystring

过滤条件的名称。取值:

  • ProvisionedProductName:按实例名称查找,完整匹配(忽略大小写)。
  • FullTextSearch:全文检索,按实例名称查找,模糊匹配。
ProvisionedProductName
Valuestring

过滤条件的值。

DEMO-ECS实例
SortBystring

排序字段。

取值为 CreateTime,表示实例创建时间。

CreateTime
SortOrderstring

排序方式。取值:

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

页码。

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

1
PageSizeinteger

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

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

10
AccessLevelFilterstring

访问过滤器。取值:

  • User(默认值):用户。
  • Account:账号。
User

返回参数

名称类型描述示例值
object

返回参数。

ProvisionedProductDetailsobject []

实例列表。

ProvisionedProductNamestring

实例名称。

DEMO-ECS实例
ProvisionedProductIdstring

实例 ID。

pp-bp1ddg1n2a****
ProvisionedProductArnstring

实例 ARN。

acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****
ProductIdstring

产品 ID。

prod-bp18r7q127****
ProductNamestring

产品名称。

DEMO-创建ECS
ProductVersionIdstring

产品版本 ID。

pv-bp15e79d26****
ProductVersionNamestring

产品版本名称。

1.0
LastTaskIdstring

上一次执行的任务 ID。

task-bp1dmg242c****
LastProvisioningTaskIdstring

上一次执行的实例操作任务 ID。

实例操作包括:

  • LaunchProduct:启动产品。
  • UpdateProvisionedProduct:更新实例。
  • TerminateProvisionedProduct:终止实例。
task-bp1dmg242c****
LastSuccessfulProvisioningTaskIdstring

上一次成功执行的实例操作任务 ID。

实例操作包括:

  • LaunchProduct:启动产品。
  • UpdateProvisionedProduct:更新实例。
  • TerminateProvisionedProduct:终止实例。
task-bp1dmg242c****
OwnerPrincipalTypestring

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

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

实例归属人的 RAM 实体 ID。

24477111603637****
Statusstring

实例状态。取值:

  • Available:可用。
  • UnderChange:变更中。
  • Error:异常。
Available
StatusMessagestring

实例状态说明。

说明 仅在实例状态为 Error 时,返回该参数。
Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...
CreateTimestring

实例创建时间。

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

2022-05-23T09:46:27Z
PortfolioIdstring

产品组合 ID。

port-bp1yt7582g****
StackIdstring

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

137e31df-3754-40b4-be2f-c793ad84****
StackRegionIdstring

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

cn-hangzhou
ProvisionedProductTypestring

实例类型。

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

RosStack
RequestIdstring

请求 ID。

0FEEF92D-4052-5202-87D0-3D8EC16F81BF
TotalCountinteger

总数据行数。

2
PageNumberinteger

页码。

1
PageSizeinteger

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

10

示例

正常返回示例

JSON格式

{
  "ProvisionedProductDetails": [
    {
      "ProvisionedProductName": "DEMO-ECS实例",
      "ProvisionedProductId": "pp-bp1ddg1n2a****",
      "ProvisionedProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:provisionedproduct/pp-bp1ddg1n2a****",
      "ProductId": "prod-bp18r7q127****",
      "ProductName": "DEMO-创建ECS",
      "ProductVersionId": "pv-bp15e79d26****",
      "ProductVersionName": "1.0",
      "LastTaskId": "task-bp1dmg242c****",
      "LastProvisioningTaskId": "task-bp1dmg242c****",
      "LastSuccessfulProvisioningTaskId": "task-bp1dmg242c****",
      "OwnerPrincipalType": "RamUser",
      "OwnerPrincipalId": "24477111603637****",
      "Status": "Available",
      "StatusMessage": "Resource CREATE failed: terraform stack sc-146611588617****-pp-bp1ddg1n2a**** failure...",
      "CreateTime": "2022-05-23T09:46:27Z",
      "PortfolioId": "port-bp1yt7582g****",
      "StackId": "137e31df-3754-40b4-be2f-c793ad84****",
      "StackRegionId": "cn-hangzhou",
      "ProvisionedProductType": "RosStack"
    }
  ],
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10
}

错误码

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

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