All Products
Search
Document Center

Microservices Engine:ListAuthPolicy

Last Updated:Aug 12, 2024

Queries a list of service authentication rules.

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:ListAuthPolicyget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionstringYes

The region ID.

cn-shanghai
PageNumberstringYes

The page number.

1
PageSizestringYes

The number of entries per page.

10
SourcestringYes

The service source.

edasmsc
ProtocolstringNo

The protocol type. Valid values:

  • SPRING_CLOUD
  • DUBBO
  • istio
SPRING_CLOUD
NamestringNo

The name of the authentication rule.

auto-rule-**
AppIdstringNo

The application ID.

jgy4cadmqo@***
NamespacestringNo

The name of the Microservices Engine (MSE) namespace.

default
AcceptLanguagestringNo

The language of the response. Valid values: zh-CN and en-US. Default value: zh-CN. The value zh-CN indicates Chinese and the value en-US indicates English.

zh

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
Messagestring

The returned message.

RequestIdstring

The request ID.

05A5A150-4A5F-5A8C-97D6-710776CC8408
Dataobject

The details of the data.

Resultarray<object>

The data returned.

object
Statusinteger

The status.

1
AuthRulearray<object>

The content of the service authentication rule.

object
Blackboolean

Indicates whether the rule is a blacklist rule.

false
Pathstring

The service path.

/a
Methodobject

The request method.

Versionstring

The method version.

0.0.1
ParameterTypesarray

The types of request parameters.

string

The type of the request parameter.

[\"java.lang.String\",\"java.lang.Object\",\"java.lang.String\"]
ServiceNamestring

The service name.

spring-cloud-a
Namestring

The method name.

hello
Groupstring

The group.

default
ReturnTypestring

The type of the return value.

Boolean
AppIdsarray

The IDs of applications.

string

The application ID.

["dez4qt7weh@***"]
AuthTypeinteger

The rule type. Valid values:

  • 0: by application
  • 1: by namespace
0
K8sNamespacesarray

The queried namespaces.

string

The namespace.

acced****
NamespaceIdstring

The namespace ID.

ced54a95-4e33-4bda-be7e-37e95868***
Protocolstring

The protocol type. Valid values:

  • SPRING_CLOUD
  • DUBBO
  • istio
SPRING_CLOUD
AccountIdstring

The ID of the Alibaba Cloud account to which the resource belongs.

19039813784***
Sourcestring

The source of the application.

edasmsc
RegionIdstring

The region ID.

cn-hangzhou
AppNamestring

The application name.

spring-cloud-a
AppIdstring

The application ID.

hkhon1po62@5f1b08becb*****
Namestring

The name of the authentication rule.

test
Idinteger

The rule ID.

204
Enableboolean

Indicates whether the rule was enabled or disabled. Valid values:

  • true: enabled
  • false: disabled
false
AuthTypeinteger

The rule type. Valid values:

  • 0: by application
  • 1: by namespace
0
K8sNamespacestring

The namespace.

c19c6c500e1ff4d7abc7bed9b8236***
TotalSizeinteger

The total number of entries.

11
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
Codeinteger

The response code.

200
Successboolean

Indicates whether the request was successful. Valid values:

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

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "Message": "",
  "RequestId": "05A5A150-4A5F-5A8C-97D6-710776CC8408",
  "Data": {
    "Result": [
      {
        "Status": 1,
        "AuthRule": [
          {
            "Black": false,
            "Path": "/a",
            "Method": {
              "Version": "0.0.1",
              "ParameterTypes": [
                "[\\\"java.lang.String\\\",\\\"java.lang.Object\\\",\\\"java.lang.String\\\"]"
              ],
              "ServiceName": "spring-cloud-a",
              "Name": "hello",
              "Group": "default",
              "ReturnType": "Boolean"
            },
            "AppIds": [
              "[\"dez4qt7weh@***\"]"
            ],
            "AuthType": 0,
            "K8sNamespaces": [
              "acced****"
            ]
          }
        ],
        "NamespaceId": "ced54a95-4e33-4bda-be7e-37e95868***",
        "Protocol": "SPRING_CLOUD",
        "AccountId": "19039813784***",
        "Source": "edasmsc",
        "RegionId": "cn-hangzhou",
        "AppName": "spring-cloud-a",
        "AppId": "hkhon1po62@5f1b08becb*****",
        "Name": "test",
        "Id": 204,
        "Enable": false,
        "AuthType": 0,
        "K8sNamespace": "c19c6c500e1ff4d7abc7bed9b8236***"
      }
    ],
    "TotalSize": 11,
    "PageNumber": 1,
    "PageSize": 10
  },
  "Code": 200,
  "Success": true
}

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.