All Products
Search
Document Center

Microservices Engine:GetAppMessageQueueRoute

Last Updated:Nov 13, 2024

Queries information about canary release for messaging of an application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mse:GetAppMessageQueueRouteget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionstringYes

The region where the instance resides. Examples:

  • cn-hangzhou: China (Hangzhou)
  • cn-beijing: China (Beijing)
  • cn-shanghai: China (Shanghai)
  • cn-zhangjiakou: China (Zhangjiakou)
  • cn-shenzhen: China (Shenzhen)
cn-hangzhou
AppIdstringYes

The ID of the application.

hkhon1po62@c3df23522baa898
NamespacestringNo

The name of the Microservices Engine (MSE) namespace.

default
AppNamestringNo

The name of the application.

example-app
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpStatusCodeinteger

The HTTP status code returned.

200
RequestIdstring

The ID of the request.

4B00BCB0-105F-5A2A-B75B-641C8E9B18FC
Messagestring

The message returned.

  • If the request is successful, a success message is returned.
  • If the request fails, an error message is returned.
success
Dataobject

The data returned.

AppIdstring

The ID of the application.

hkhon1po62@54e1f42f37cd65a
Regionstring

The region ID.

cn-hangzhou
Enableboolean

Indicates whether the canary release for messaging feature is enabled.

  • true: enabled
  • false: disabled
true
Tagsarray

The tags used to ignore message consumption for nodes in untagged environments.

tagstring

The tag used to ignore message consumption for nodes in untagged environments.

gray
FilterSidestring

The side for message filtering when the canary release for messaging feature is enabled.

Server
Codeinteger

The response code returned.

200
Successboolean

Indicates whether the request was successful. Valid values: true and false. The value true indicates that the request was successful. The value false indicates that the request failed.

true

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "RequestId": "4B00BCB0-105F-5A2A-B75B-641C8E9B18FC",
  "Message": "success",
  "Data": {
    "AppId": "hkhon1po62@54e1f42f37cd65a",
    "Region": "cn-hangzhou",
    "Enable": true,
    "Tags": [
      "gray"
    ],
    "FilterSide": "Server"
  },
  "Code": 200,
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-03-30The Error code has changed. The request parameters of the API has changedView Change Details