ListProducts - Ticket System API - Alibaba Cloud Documentation Center

Obtains the data of the Alibaba Cloud product list.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the product. Fuzzy search is supported. This parameter is optional.	ecs
Language	string	No	The language that you use, supporting English, Chinese, and Japanese. Valid values: en, zh, and jp, which indicate English, Chinese, and Japanese, respectively.	zh

Response elements

Element	Type	Description	Example
	object
Code	integer	The return code of the request result.	0
Message	string	The error message. If success is set to false, the message is returned.	入参非法
RequestId	string	The unique ID of the API request. The requestID is unique for each call.	AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD
Success	boolean	Indicates whether the call is successful. A value of true indicates that the call is normal.	true
Data	array<object>	Return value, that is, product list
	array<object>
DirectoryId	integer	The ID of the product catalog, which represents the product category, such as elastic computing	1
DirectoryName	string	The name of the product catalog, which represents the product category, such as elastic computing	云服务器
ProductList	array<object>	List of Alibaba Cloud products
	object
ProductId	integer	Alibaba Cloud product ID	7160
ProductName	string	Alibaba Cloud product name	ECS

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "入参非法",
  "RequestId": "AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD",
  "Success": true,
  "Data": [
    {
      "DirectoryId": 1,
      "DirectoryName": "云服务器",
      "ProductList": [
        {
          "ProductId": 7160,
          "ProductName": "ECS"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	param.illegal	Params illegal.
401	illegal.auth	You are not authorized to perform the operation.	You are not authorized to perform this operation.
500	System.error	An error occurred while processing your request.	An error occurred while processing your request. Please try again.
403	No permissions	No permissions to access.	RAM authentication does not have permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.