ListProductCatalog - Chat App Message Service - Alibaba Cloud Documentation Center

Queries the product catalogs on the Business Manager platform of Meta.

Operation description

You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cams:ListProductCatalog		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
BusinessId	long	Yes	The Business Manager ID.	28
Before	string	No	The cursor that points to the beginning of the page of the returned data.	wiidkd939kek93
After	string	No	The cursor that points to the end of the page of the returned data.	kdkii48jfjjei3
Fields	string	No	The fields. Separate multiple fields with commas (,). see catalog fields	id,name
Limit	long	No	The number of catalogs to be queried. Valid values: 1 to 1000.	73
CustSpaceId	string	No	The space ID of the user within the independent software vendor (ISV) account.	293483938849493

Response parameters

Parameter	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	None
Message	string	The error message.	None
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A9486641****
Model	object	The returned data.
Paging	object	The pagination details.
Cursors	object	The cursors for pagination.
Before	string	The cursor that points to the beginning of the page of the returned data.	sjjsjdjjdjd83883
After	string	The cursor that points to the end of the page of the returned data.	sjsuueu83838
Data	array<object>	The returned data.
data	object	The response parameters.	{"id":"2999293993", "name":"catalog_name"}
Code	string	The response code. The value OK indicates that the request was successful. Other values indicate that the request failed. For more information, see Error codes.	OK
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "\t\n90E63D28-E31D-1EB2-8939-A9486641****\n",
  "Model": {
    "Paging": {
      "Cursors": {
        "Before": "sjjsjdjjdjd83883",
        "After": "sjsuueu83838"
      }
    },
    "Data": [
      {
        "id": "2999293993",
        "name": "catalog_name"
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history