Update the status of a gateway authentication consumer by calling UpdateGatewayAuthConsumerStatus - Microservices Engine - Alibaba Cloud - Microservices Engine

Updates the status of a gateway authentication consumer.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:UpdateGatewayAuthConsumerStatus

update

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-685f661467b54f48b7b7a76605ce****
Id	integer	Yes	The ID of the authentication consumer.	1
ConsumerStatus	boolean	Yes	Specifies whether the authentication consumer is enabled. Valid values: true: Enabled. false: Disabled.	true
AcceptLanguage	string	No	The language of the returned information. Valid values: zh: Chinese. en: English.	zh

Response elements

Element	Type	Description	Example
	object	RestResult<List>
RequestId	string	The request ID.	56D9E600-6348-4260-B35F-583413F****
Success	boolean	Indicates whether the request is successful. Valid values: `true`: The request is successful. `false`: The request fails.	true
Code	integer	The code is used only to synchronize with the success field.	200
ErrorCode	string	The error code.	mse-100-000
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The returned message.	The request is processed successfully.
DynamicCode	string	The placeholder in the dynamic error message.	code
DynamicMessage	string	The dynamic error message, which is used to replace the %s placeholder in the ErrMessage response parameter. Note If ErrMessage returns The Value of Input Parameter %s is not valid and DynamicMessage returns DtsJobId, it indicates that the value of the DtsJobId request parameter is invalid.	The specified parameter is invalid.
Data	boolean	Indicates whether the execution is successful. Valid values: true: Successful. false: Failed.	true

Examples

Success response

JSON format

{
  "RequestId": "56D9E600-6348-4260-B35F-583413F****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request is processed successfully.",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": true
}

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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.