All Products
Search
Document Center

Microservices Engine:ListGatewayAuthConsumerResource

Last Updated:Aug 12, 2024

Queries the list of authorized resources for the consumer on which a gateway performs authentication operations.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:ListGatewayAuthConsumerResource
  • Gateway
    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-3f97e2989c344f35ab3fd62b19f1****
ConsumerIdlongYes

The ID of the consumer.

2
RouteNamestringNo

The name of the route.

test
ResourceStatusbooleanNo

The resource authorization status. Valid values:

  • true: enabled
  • false: disabled
true
PageNumstringYes

The number of the page to return.

1
PageSizestringYes

The number of entries to return on each page.

10
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

RestResult<List>

RequestIdstring

The ID of the request.

A73AC37C-C617-4E3A-8049-372CF49C****
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
True
Codeinteger

The status code. A value of 200 is returned if the request is successful.

200
ErrorCodestring

The error code that is returned.

mse-100-000
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The error message returned.

The request is successfully processed.
DynamicCodestring

The dynamic part in the error message.

code
DynamicMessagestring

The dynamic part in the error message. This parameter is used to replace the **%s** variable in the ErrMessage parameter.

Note If the return value of the ErrMessage parameter is The Value of Input Parameter %s is not valid and the return value of the DynamicMessage parameter is DtsJobId, the specified DtsJobId parameter is invalid.
The specified parameter is invalid.
Dataobject

The returned result.

TotalSizelong

The total number of entries returned.

11
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

10
Resultarray<object>

The data structure.

object

The data structure.

Idlong

The ID of the authorized resource for the consumer.

1
ConsumerIdlong

The ID of the consumer.

2
RouteIdlong

The ID of the route.

3091
RouteNamestring

The name of the route.

test
ResourceStatusboolean

The resource authorization status. Valid values:

  • true: enabled
  • false: disabled
true
GatewayUniqueIdstring

The unique ID of the gateway.

gw-5017305290e14centbrveca****
GmtCreatestring

The creation time.

2022-01-07 18:07:57
GmtModifiedstring

The modification time.

2022-01-07 18:07:57

Examples

Sample success responses

JSONformat

{
  "RequestId": "A73AC37C-C617-4E3A-8049-372CF49C****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "TotalSize": 11,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 1,
        "ConsumerId": 2,
        "RouteId": 3091,
        "RouteName": "test",
        "ResourceStatus": true,
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "GmtCreate": "2022-01-07 18:07:57",
        "GmtModified": "2022-01-07 18:07:57"
      }
    ]
  }
}

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
2024-02-23The internal configuration of the API is changed, but the call is not affectedView Change Details