文档

ListProductsAsAdmin - 管理员查询产品列表

更新时间:
一键部署

管理员调用ListProductsAsAdmin接口查询产品列表。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
PortfolioIdstring

产品组合 ID。

port-bp1yt7582g****
Filtersobject []

过滤条件。

Keystring

过滤条件的名称。取值:

  • ProductName:按产品名称查找,完整匹配(忽略大小写)。
  • FullTextSearch:全文检索,按产品名称、产品提供者、产品描述查找,模糊匹配。
ProductName
Valuestring

过滤条件的值。

DEMO-创建ECS
SortBystring

排序字段。

取值为 CreateTime,表示产品创建时间。

CreateTime
SortOrderstring

排序方式。取值:

  • Asc:正序。
  • Desc:倒序。
Desc
PageNumberinteger

页码。

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

1
PageSizeinteger

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

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

10
Scopestring

查询范围。取值:

  • Local(默认值):在当前账号中创建的产品。
  • Imported:从其他账号导入的产品。
  • All:所有可以使用的产品。
Local

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

0FEEF92D-4052-5202-87D0-3D8EC16F81BF
ProductDetailsobject []

产品列表。

ProductArnstring

产品 ARN。

acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****
Descriptionstring

产品描述。

这是一个产品描述
CreateTimestring

产品创建时间。

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

2022-04-12T06:10:37Z
ProductIdstring

产品 ID。

prod-bp18r7q127****
ProductNamestring

产品名称。

DEMO-创建ECS
ProviderNamestring

产品提供者。

IT团队
ProductTypestring

产品类型。

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

Ros
TemplateTypestring

产品模板类型。取值:

  • RosTerraformTemplate:表示阿里云资源编排服务(ROS)支持的 Terraform 模板。
  • RosStandardTemplate:表示阿里云资源编排服务(ROS)标准模板。
RosTerraformTemplate
TotalCountinteger

总数据行数。

2
PageNumberinteger

页码。

1
PageSizeinteger

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

10

示例

正常返回示例

JSON格式

{
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "ProductDetails": [
    {
      "ProductArn": "acs:servicecatalog:cn-hangzhou:146611588617****:product/prod-bp18r7q127****",
      "Description": "这是一个产品描述",
      "CreateTime": "2022-04-12T06:10:37Z",
      "ProductId": "prod-bp18r7q127****",
      "ProductName": "DEMO-创建ECS",
      "ProviderName": "IT团队",
      "ProductType": "Ros",
      "TemplateType": "RosTerraformTemplate"
    }
  ],
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-02-27OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈