Querying MQS Instances
Function
This API is used to query a list of MQS instances.
URI
GET /v2/{project_id}/mqs/instances
|
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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
include_internal |
Yes |
String |
Whether internal instances are included. The value must be true. |
|
engine |
No |
String |
Engine type (Kafka or RocketMQ). To query a RocketMQ instance, set this parameter to reliability. |
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). |
Response Parameters
Status code: 200
OK
None
Example Requests
GET https://{endpoint}/v2/{project_id}/mqs/instances?include_internal=true
Example Responses
Status code: 200
OK
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
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.
