Deleting Topics in Batches
Function
This API is used to delete topics in batches.
URI
POST /v2/{project_id}/mqs/instances/{instance_id}/topics/delete
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain a project ID, see "Appendix" > "Obtaining a Project ID" in this document. |
| instance_id | Yes | String | Instance ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| topics | Yes | Array of strings | List of topics to delete. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| topics | Array of topics objects | List of topics to delete. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Topic name. |
| success | Boolean | Whether the topics are deleted. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_msg | String | Error message. |
Example Requests
Delete two specified topics.
POST https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/topics/delete
{
"topics" : [ "topic-test-1", "topic-test-2" ]
} Example Responses
Status code: 200
OK
{
"topics" : [ {
"id" : "topic-test-2",
"success" : true
} ]
} Status code: 400
Bad Request
{
"error_code" : 400,
"error_msg" : "Bad Request"
} Status code: 403
Forbidden
{
"error_code" : 403,
"error_msg" : "Forbidden"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 403 | Forbidden |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.