Processing Messages
Function
Confirms received notification messages and selects when to process the messages within a specified time range.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/service/messages
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service. |
|
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
|
Dlm-Type |
No |
String |
Specifies the version type of the data service. The value can be SHARED or EXCLUSIVE. |
|
Content-Type |
Yes |
String |
Type (format) of the message body. This parameter is mandatory if the message body exists. If the message body does not exist, leave this parameter blank. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
message_id |
No |
String |
Message ID. |
|
action |
No |
Integer |
Policy action. 0: immediately; 1: periodically. |
|
time |
No |
String |
Expiry time of using the API, This parameter is required only for periodic execution. By default, the current time of the server is three days later. |
Response Parameters
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code. |
|
error_msg |
String |
Error message. |
Example Requests
Confirm received notifications.
/v1/0833a5737480d53b2f250010d01a7b88/service/messages
{
"message_id" : "c6c1229f3387848b6bfb69eec7004a60",
"action" : 0,
"time" : "2022-03-23T10:00:00.000Z"
}
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
204 |
The messages are successfully processed. |
|
400 |
Bad request |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.