Filter & List AI Products with ListProducts API - Platform For AI

Lists products.

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

pai:ListProducts

list

*All Resource

*

None

Request syntax

GET /api/v1/products HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ProductCodes	string	No	The product codes, separated by commas.	PAI_isolate
ServiceCodes	string	No	The service codes, separated by commas.	oss
Verbose	boolean	No

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	1e195c5116124202371861018d5bde
Products	array<object>	The list of products.
	object
PurchaseUrl	string	The purchase URL.	https://common-buy.aliy
ProductCode	string	The product code.	DataWorks_isolate
IsPurchased	boolean	Indicates whether the product is purchased.	true
HasPermissionToPurchase	boolean	Indicates whether the user has permission to purchase the product.
ProductId	string
Services	array<object>	The list of services.
	object
IsOpen	boolean	Indicates whether the service is activated.	true
OpenUrl	string	The activation URL.
ServiceCode	string	The service code.	oss

Examples

Success response

JSON format

{
  "RequestId": "1e195c5116124202371861018d5bde",
  "Products": [
    {
      "PurchaseUrl": "https://common-buy.aliy",
      "ProductCode": "DataWorks_isolate",
      "IsPurchased": true,
      "HasPermissionToPurchase": false,
      "ProductId": ""
    }
  ],
  "Services": [
    {
      "IsOpen": true,
      "OpenUrl": "",
      "ServiceCode": "oss"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.