文档

ListAuthPolicy - 获取服务鉴权规则列表

更新时间:

通过ListAuthPolicy接口查询服务鉴权规则列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
mse:ListAuthPolicyRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Regionstring

地域 ID。

cn-shanghai
PageNumberstring

当前页码。

1
PageSizestring

每页显示条数。

10
Sourcestring

来源。

edasmsc
Protocolstring

协议类型。取值:

  • SPRING_CLOUD
  • DUBBO
  • istio
SPRING_CLOUD
Namestring

鉴权规则名称。

auto-rule-**
AppIdstring

应用 ID。

jgy4cadmqo@***
Namespacestring

MSE 命名空间名。

default
AcceptLanguagestring

返回结果显示的语言。取值:zh-CN(默认值):中文,en-US:英文

zh

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

返回信息。

请求处理成功
RequestIdstring

请求 ID。

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

数据概览。

Resultobject []

返回数据。

Statusinteger

状态。

1
AuthRuleobject []

服务鉴权规则内容列表。

Blackboolean

是否黑名单。

false
Pathstring

路径。

/a
Methodobject

请求方法。

Versionstring

方法版本号。

0.0.1
ParameterTypesarray

请求参数类型列表。

string

请求参数类型。

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

服务名称。

spring-cloud-a
Namestring

方法名。

hello
Groupstring

分组。

default
ReturnTypestring

返回值类型。

Boolean
AppIdsarray

应用集合。

string

应用 ID。

["dez4qt7weh@***"]
AuthTypeinteger

规则类型。

  • 0, 按照应用维度。
  • 1,按照命名空间维度。
0
K8sNamespacesarray

命名空间列表。

string

命名空间。

acced****
NamespaceIdstring

命名空间 ID。

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

协议类型。取值:

  • SPRING_CLOUD
  • DUBBO
  • istio
SPRING_CLOUD
AccountIdstring

资源拥有者的阿里云账号 ID。

19039813784***
Sourcestring

应用来源。

edasmsc
RegionIdstring

地域 ID。

cn-hangzhou
AppNamestring

应用名称。

spring-cloud-a
AppIdstring

应用 ID。

hkhon1po62@5f1b08becb*****
Namestring

鉴权规则名称。

test
Idinteger

ID。

204
Enableboolean

开启或关闭。

  • true:开启。
  • false:关闭。
false
AuthTypeinteger

规则类型。

  • 0, 按照应用维度。
  • 1,按照命名空间维度。
0
K8sNamespacestring

命名空间。

c19c6c500e1ff4d7abc7bed9b8236***
TotalSizeinteger

总条数。

11
PageNumberinteger

页码。

1
PageSizeinteger

页大小。

10
Codeinteger

响应码。

200
Successboolean

请求结果,取值如下:

  • true:请求成功。
  • false:请求失败。
True

示例

正常返回示例

JSON格式

{
  "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
}

错误码

HTTP status code错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

访问错误中心查看更多错误码。

  • 本页导读 (1)