ListMessages API: Paginate & Filter Messages Efficiently - BDRC - Alibaba Cloud - Backup and Disaster Recovery Center

Queries messages in batches.

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

bdrc:ListMessages

none

*All Resource

*

None

Request syntax

GET /api/v1/messages HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The pagination token. If there is a next page, this field has a return value. This parameter indicates that there is a next page as long as data is returned. You can use the returned NextToken as a request parameter to obtain the next page of data until Null is returned, which indicates that all data has been retrieved.	cae***********99
MaxResults	integer	No	The maximum number of records to return in this request.	100
MessageTimeLaterThan	integer	No	Filters messages with a time later than the specified value.	1740019609
MessageTimeEarlierThan	integer	No	Filters messages with a time earlier than the specified value.	1740019610
MessageType	string	No	The message type.	SUB_PROTECTION_POLICY_MODIFIED
MessageLevel	string	No	The message level.	WARNING

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The unique request ID.	5748C531-80B1-5C31-8421-63A1830B9E48
Data	object	The response data.
Content	array<object>	The response content.
	object	The collection of records returned in this request.
MessageId	string	Message ID.	zgrjap8j-us04-owef-fpmo-kdpr80pbss0k
MessageName	string	Message name.	MyMessage
MessageTime	integer	Message time.	1740019609
MessageType	string	Message type.	SUB_PROTECTION_POLICY_MODIFIED
MessageLevel	string	Message level.	WARNING
MessageSourceType	string	Message source type.	PROTECTION_POLICY
MessageSourceId	string	Message source ID.	p-123***7890
MessageSourceRegionId	string	Message source region ID.	cn-hangzhou
NextToken	string	The pagination token.	eKDyCM0zFQ5op7jVMWmNNA==
MaxResults	integer	The maximum number of results requested.	10
TotalCount	integer	The total number of results.	42

Examples

Success response

JSON format

{
  "RequestId": "5748C531-80B1-5C31-8421-63A1830B9E48",
  "Data": {
    "Content": [
      {
        "MessageId": "zgrjap8j-us04-owef-fpmo-kdpr80pbss0k",
        "MessageName": "MyMessage",
        "MessageTime": 1740019609,
        "MessageType": "SUB_PROTECTION_POLICY_MODIFIED",
        "MessageLevel": "WARNING",
        "MessageSourceType": "PROTECTION_POLICY",
        "MessageSourceId": "p-123***7890",
        "MessageSourceRegionId": "cn-hangzhou"
      }
    ],
    "NextToken": "eKDyCM0zFQ5op7jVMWmNNA==",
    "MaxResults": 10,
    "TotalCount": 42
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.