ListGatewayAuthConsumer - Microservices Engine - Alibaba Cloud Documentation Center

Queries the list of consumers on which a gateway performs authentication operations.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ListGatewayAuthConsumer	list	Gateway acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-0fe488252dc44d55a9dd57875193****
Name	string	No	The name of the consumer.	test
Type	string	No	The authentication type. Valid values: JWT	JWT
ConsumerStatus	boolean	No	The status of the consumer. Valid values: true: enabled false: disabled	true
PageNum	string	Yes	The number of the page to return.	1
PageSize	string	Yes	The number of entries to return on each page.	10
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	RestResult<List>
RequestId	string	The ID of the request.	dc63-465d-8ef5-20dc18af****
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	The status code. A value of 200 is returned if the request is successful.	200
ErrorCode	string	The error code that is returned.	mse-100-000
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The error message returned.	The request is successfully processed.
DynamicCode	string	The dynamic part in the error message.	code
DynamicMessage	string	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.
Data	object	The data structure.
TotalSize	long	The total number of returned entries.	9
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
Result	array<object>	The returned information.
Consumers	object	The returned information.
Id	long	The ID of the consumer.	1
Name	string	The name of the consumer.	test
ConsumerStatus	boolean	The status of the consumer. Valid values: true: enabled false: disabled	true
PrimaryUser	string	The creator.	123
GatewayUniqueId	string	The unique ID of the gateway.	gw-5017305290e14centbrveca****
Type	string	The authentication type. Valid values: JWT	JWT
Description	string	The description of the consumer.	Description
GmtCreate	string	The creation time.	2021-09-13 19:24:23
GmtModified	string	The modification time.	2022-01-07 18:07:57

Examples

Sample success responses

JSONformat

{
  "RequestId": "dc63-465d-8ef5-20dc18af****",
  "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": 9,
    "PageNumber": 1,
    "PageSize": 10,
    "Result": [
      {
        "Id": 1,
        "Name": "test",
        "ConsumerStatus": true,
        "PrimaryUser": "123",
        "GatewayUniqueId": "gw-5017305290e14centbrveca****",
        "Type": "JWT",
        "Description": "Description\n",
        "GmtCreate": "2021-09-13 19:24:23",
        "GmtModified": "2022-01-07 18:07:57"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

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

Change history

Change time	Summary of changes	Operation
2023-08-24	The internal configuration of the API is changed, but the call is not affected	View Change Details