Query MSE Isolation Rules with ListIsolationRules API - Microservices Engine - Alibaba Cloud - Microservices Engine

Query isolation rules.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	Yes	The microservice namespace to which the application belongs.	default
AppName	string	Yes	The application name.	spring-cloud-a
ResourceSearchKey	string	No	Find protection rules that contain the interface keyword.	a
AppId	string	No	The application ID.	hkhon1po62@c3df23522bXXXXX
Resource	string	No	Find protection rules for specified interface.	/a
PageIndex	integer	No	The first page. Default value: 1.	1
PageSize	integer	No	The page size. Default value: 6.	10
AcceptLanguage	string	No	The language in which you want the results to be displayed. Valid values: zh (default): Chinese. en: English.	zh

Response elements

Parameter	Type	Description	Example
	object
Code	integer	The response code.	200
Message	string	The response message.	OK
RequestId	string	The request ID.	4E9FDCFE-0738-493B-B801-82BDFBCB****
Success	boolean	The result of the request.	true
Data	object	The details of the rule.
Result	array	The returned results.
	object
Namespace	string	The microservice namespace to which the application belongs.	default
RuleId	integer	The rule ID.	1
AppName	string	The application name.	spring-cloud-a
Resource	string	The name of the interface to which the rule applies. The interface name must be the same as the name on the interface details page in the console.	/a
Threshold	integer	The concurrency threshold for isolation rules.	3
Enable	boolean	Indicates whether the rule is enabled.	true
AppId	string	The application ID.	hkhon1po62@c3df23522bXXXXX
RegionId	string	The region in which the cluster resides.	cn-hangzhou
FallbackObject	string	The behavior that was bound to the rule.	"{\"appName\":\"spring-cloud-a\",\"fallbackBehavior\":{\"webFallbackMode\":0,\"webRespContentType\":0,\"webRespMessage\":\"Blocked\",\"webRespStatusCode\":429},\"id\":977,\"name\":\"Fallback\",\"namespace\":\"default\",\"resourceClassification\":1}"
LimitApp	string	The source application of the request.	spring-cloud-a
PageNumber	integer	The first page number.	1
PageSize	integer	The page size.	10
TotalSize	integer	The total number of rules.	3
HttpStatusCode	integer	The HTTP status code.	200

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "OK",
  "RequestId": "4E9FDCFE-0738-493B-B801-82BDFBCB****",
  "Success": true,
  "Data": {
    "Result": [
      {
        "Namespace": "default",
        "RuleId": 1,
        "AppName": "spring-cloud-a",
        "Resource": "/a",
        "Threshold": 3,
        "Enable": true,
        "AppId": "hkhon1po62@c3df23522bXXXXX",
        "RegionId": "cn-hangzhou",
        "FallbackObject": "\"{\\\"appName\\\":\\\"spring-cloud-a\\\",\\\"fallbackBehavior\\\":{\\\"webFallbackMode\\\":0,\\\"webRespContentType\\\":0,\\\"webRespMessage\\\":\\\"Blocked\\\",\\\"webRespStatusCode\\\":429},\\\"id\\\":977,\\\"name\\\":\\\"Fallback\\\",\\\"namespace\\\":\\\"default\\\",\\\"resourceClassification\\\":1}\"",
        "LimitApp": "spring-cloud-a"
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalSize": 3
  },
  "HttpStatusCode": 200
}

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.