ListProducts - Ticket System API - Alibaba Cloud Documentation Center

Obtains the data of the Alibaba Cloud product list.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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.	cn

Response parameters

Parameter	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.	success
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
	object
DirectoryId	long	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	ECS
ProductList	array<object>	List of Alibaba Cloud products
	object
ProductId	long	Alibaba Cloud product ID	7160
ProductName	string	Alibaba Cloud product name	ECS

Examples

Sample success responses

JSONformat

{
  "Code": 0,
  "Message": "success",
  "RequestId": "AC0AB2EC-AFBC-44BA-AE77-132A5A1EC0AD",
  "Success": true,
  "Data": [
    {
      "DirectoryId": 1,
      "DirectoryName": "ECS",
      "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history