ListProductCatalog API reference for querying Meta product catalogs - Chat App Message Service

Operation description

This operation allows a maximum of 10 requests per second (RPS) per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.

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

cams:ListProductCatalog

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BusinessId	integer	Yes	The Business Manager ID.	105048970863****
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	integer	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.	C29398882929

Response elements

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

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.