AddAuthPolicy - Microservices Engine - Alibaba Cloud Documentation Center

You can call the AddAuthPolicy operation to create a service authentication rule.

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:AddAuthPolicy

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the rule.	test
Source	string	Yes	The source. The value can be `edasmsc`.	edasmsc
Region	string	Yes	The region.	cn-hangzhou
Enable	string	Yes	Specifies whether to enable the authentication rule. Valid values: `true`: enabled. `false`: disabled.	true
AppId	string	No	The application ID.	e9clba2xlc@***
Protocol	string	Yes	The protocol type. Valid values: SPRING_CLOUD DUBBO istio	SPRING_CLOUD
AuthRule	string	Yes	The content of the service authentication rule.	[{"all":true,"black":false,"appIds":["dez4qt7weh@***"]}]
Namespace	string	No	The MSE namespace to which the application belongs.	default
AuthType	integer	No	The type of the rule. Valid values: 0: by application. 1: by namespace.	0
K8sNamespace	string	No	The ID of the namespace in the Kubernetes cluster.	c19c6c500e1ff4d7abc7***
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN (default): Chinese, en-US: English	zh

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	dc63-465d-8ef5-20dc18af****
Message	string	The response message.	OK
Data	string	The data overview.
Code	integer	The response code. Its value is synchronized with the `Success` parameter.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "dc63-465d-8ef5-20dc18af****",
  "Message": "OK",
  "Data": "",
  "Code": 200,
  "Success": 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.