All Products
Search

This Product

    Service Catalog:ListPortfolios

    Document Center

    Service Catalog:ListPortfolios

    Last Updated:Nov 05, 2025

    Queries a list of portfolios.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    servicecatalog:ListPortfolios

    get

    *Portfolio

    acs:servicecatalog:{#regionId}:{#accountId}:portfolio/*

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    ProductId

    string

    No

    The product ID.

    prod-bp18r7q127****

    Filters

    array<object>

    No

    The filters.

    object

    No

    Key

    string

    No

    The filter key. Valid values:

    • PortfolioName: Searches by portfolio name. An exact, case-insensitive match is performed.

    • FullTextSearch: Performs a fuzzy, full-text search on the portfolio name, provider, and description.

    PortfolioName

    Value

    string

    No

    The filter value.

    DEMO-IT

    SortBy

    string

    No

    The field to sort by.

    Set the value to CreateTime to sort the results by creation time.

    CreateTime

    SortOrder

    string

    No

    The ordering. Valid values:

    • Asc: in ascending order.

    • Desc: in descending order.

    Desc

    PageNumber

    integer

    No

    The page number.

    The page number starts from 1. Default value: 1.

    1

    PageSize

    integer

    No

    The number of entries to return on each page.

    Valid values: 1 to 100. Default value: 10.

    10

    Scope

    string

    No

    The query scope. Valid values:

    • Local (default): queries the portfolios created in the current account.

    • Import: queries the portfolios imported from other accounts.

    • All: queries all available portfolios.

    Local

    Response elements

    Parameter

    Type

    Description

    Example

    object

    The response parameters.

    PortfolioDetails

    array<object>

    The list of portfolios.

    object

    The details of the portfolio.

    Description

    string

    The description of the portfolio.

    This is a product portfolio description.

    PortfolioName

    string

    The name of the portfolio.

    DEMO-IT

    CreateTime

    string

    The time when the portfolio was created.

    Time is displayed in UTC and formatted as YYYY-MM-DDThh:mm:ssZ (ISO 8601).

    2022-04-12T06:11:12Z

    ProviderName

    string

    The provider of the portfolio.

    IT team

    PortfolioId

    string

    The ID of the portfolio.

    port-bp1yt7582g****

    PortfolioArn

    string

    The portfolio ARN.

    acs:servicecatalog:cn-hangzhou:146611588617****:portfolio/port-bp1yt7582g****

    RequestId

    string

    The request ID.

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

    TotalCount

    integer

    The total number of entries.

    2

    PageNumber

    integer

    The page number.

    1

    PageSize

    integer

    The number of entries returned per page.

    10

    Examples

    Success response

    JSON format

    {
  "PortfolioDetails": [
    {
      "Description": "This is a product portfolio description.",
      "PortfolioName": "DEMO-IT",
      "CreateTime": "2022-04-12T06:11:12Z",
      "ProviderName": "IT team",
      "PortfolioId": "port-bp1yt7582g****",
      "PortfolioArn": "acs:servicecatalog:cn-hangzhou:146611588617****:portfolio/port-bp1yt7582g****"
    }
  ],
  "RequestId": "0FEEF92D-4052-5202-87D0-3D8EC16F81BF",
  "TotalCount": 2,
  "PageNumber": 1,
  "PageSize": 10
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description

    500

    InternalError

    A system error occurred.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.