ListConsumerAuthorizationRules - 获取消费者授权规则列表

更新时间:
复制为 MD 格式

获取消费者授权规则列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apig:ListConsumerAuthorizationRulesnone
*Domain
acs:apig:{#regionId}:{#accountId}:consumer/{#ConsumerId}

请求语法

GET /v1/consumers/{consumerId}/authorization-rules HTTP/1.1

请求参数

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

api 名称模糊搜索参数。

qwen3
pageNumberinteger

分页页码。

1
pageSizeinteger

分页大小,不填默认 10。

10
consumerIdstring

消费者 ID。

cs-csgdi45lhtggrjcpriug

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

294382D9-EE60-5735-A4CD-F2AC2840423D
codestring

响应状态码。

Ok
messagestring

响应消息。

success
dataobject

响应数据。

totalSizestring

总数量。

9
pageNumberinteger

分页页码。

1
pageSizeinteger

分页大小。

10
itemsarray<object>

消费者授权信息列表。

itemobject

消费者授权信息。

consumerAuthorizationRuleIdstring

消费者授权规则 ID。

car-csgeka5lhtggrjcprok0
consumerIdstring

消费者 ID。

cs-csheiftlhtgmp0j0hp4g
apiInfoHttpApiApiInfo

API 信息。

environmentInfoEnvironmentInfo

环境信息。

gatewayInfoGatewayInfo

网关信息。

resourceIdstring

资源 ID。

2351944
resourceTypestring

资源类型。

HttpApiRoute
expireStatusstring

失效状态。

InEffect
expireModestring

失效模式。LongTerm、ShortTerm,二选一。

ShortTerm
expireTimestamplong

到期时间。

172086834548
createTimestamplong

创建时间戳。

1719386834548
updateTimestamplong

更新时间戳。单位: 毫秒。

1721116090326
deployStatusstring

API 在当前环境的发布状态

{}

示例

正常返回示例

JSON格式

{
  "requestId": "294382D9-EE60-5735-A4CD-F2AC2840423D",
  "code": "Ok",
  "message": "success",
  "data": {
    "totalSize": 9,
    "pageNumber": 1,
    "pageSize": 10,
    "items": [
      {
        "consumerAuthorizationRuleId": "car-csgeka5lhtggrjcprok0",
        "consumerId": "cs-csheiftlhtgmp0j0hp4g",
        "apiInfo": {
          "httpApiId": "api-xxx",
          "name": "test",
          "basePath": "/v1",
          "description": "测试专用API",
          "versionInfo": {
            "enable": true,
            "scheme": "Query",
            "headerName": "my-version",
            "queryName": "myVersion",
            "version": "v1"
          },
          "ingressInfo": {
            "sourceId": "src-xxx",
            "ingressClass": "mse",
            "watchNamespace": "default",
            "environmentInfo": {
              "environmentId": "env-xxx"
            },
            "k8sClusterInfo": {
              "clusterId": "ca435c77cba1547cca9311957bcxxxxxx"
            },
            "overrideIngressIp": true
          },
          "type": "Rest",
          "resourceGroupId": "rg-xxx",
          "enabelAuth": true,
          "authConfig": {
            "authType": "Jwt",
            "authMode": "NoAuth"
          },
          "gatewayId": "gw-cpv4sqdl****",
          "modelCategory": "Text",
          "protocols": [
            "HTTP"
          ],
          "environments": [
            {
              "environmentId": "env-xxx",
              "backendScene": "SingleService",
              "backendType": "Service",
              "serviceConfigs": [
                {
                  "gatewayServiceId": "gs-xxx",
                  "name": "demo-service",
                  "protocol": "HTTP",
                  "port": 8080,
                  "weight": 100,
                  "version": "v1",
                  "match": {
                    "default": true,
                    "conditions": [
                      {
                        "type": "Query",
                        "key": "color",
                        "value": "gray",
                        "operator": "equal"
                      }
                    ]
                  },
                  "serviceId": "svc-xxx"
                }
              ],
              "customDomains": [
                {
                  "domainId": "d-xxx",
                  "name": "www.example.com",
                  "protocol": "HTTP"
                }
              ],
              "name": "test",
              "alias": "test",
              "gatewayInfo": {
                "gatewayId": "gw-xxx",
                "name": "test"
              },
              "deployStatus": "Deployed",
              "subDomains": [
                {
                  "domainId": "d-xxx",
                  "name": "www.example.com",
                  "protocol": "HTTP",
                  "networkType": "Internet"
                }
              ]
            }
          ],
          "aiProtocols": [
            "OpenAI/v1"
          ],
          "deployConfigs": [
            {
              "environmentId": "env-xxx",
              "backendScene": "SingleService",
              "autoDeploy": true,
              "gatewayId": "gw-xx",
              "routeBackend": {
                "scene": "Single",
                "services": [
                  {
                    "serviceId": "service-cq2bmmdlhtgj***",
                    "name": "item-service",
                    "protocol": "HTTP",
                    "port": 0,
                    "weight": 49,
                    "version": "v1"
                  }
                ]
              },
              "gatewayInfo": {
                "gatewayId": "gw-cq7og15lhtgi6qasrj60",
                "name": "apitest-gw",
                "vpcInfo": {
                  "vpcId": "vpc-uf664nyle5kh***",
                  "name": "商品中心预发环境专有网络"
                },
                "engineVersion": "2.0.7"
              },
              "mock": {
                "enable": false,
                "responseCode": 200,
                "responseContent": "Mock测试"
              },
              "gatewayType": "API",
              "customDomainIds": [
                "d-xxx"
              ],
              "serviceConfigs": [
                {
                  "serviceId": "svc-xxx",
                  "weight": 100,
                  "modelNamePattern": "qwen-*",
                  "modelName": "qwen-max",
                  "intentCode": "INQUIRY",
                  "match": {
                    "default": true,
                    "conditions": [
                      {
                        "type": "Query",
                        "key": "color",
                        "value": "gray",
                        "operator": "equal"
                      }
                    ]
                  }
                }
              ],
              "policyConfigs": [
                {
                  "type": "AiFallback",
                  "enable": true,
                  "aiFallbackConfig": {
                    "serviceConfigs": [
                      {
                        "serviceId": "svc-******",
                        "targetModelName": "gpt-4/llama3-70b"
                      }
                    ]
                  },
                  "aiSecurityGuardConfig": {
                    "serviceAddress": "https://api.example.com/v1",
                    "checkRequest": true,
                    "checkResponse": true,
                    "checkRequestImage": true,
                    "checkResponseImage": true,
                    "requestCheckService": "https://checker.example.com/validate-request",
                    "responseCheckService": "https://checker.example.com/validate-response",
                    "requestImageCheckService": "https://image-checker.example.com/scan",
                    "responseImageCheckService": "https://image-checker.example.com/scan-response",
                    "riskAlertLevel": "low/medium/high",
                    "riskConfig": [
                      {
                        "type": "K8S",
                        "level": "Critical",
                        "consumerRules": {
                          "pattern": "first",
                          "matchType": "term"
                        }
                      }
                    ],
                    "bufferLimit": 50,
                    "consumerRequestCheckService": [
                      {
                        "name": "API",
                        "requestCheckService": "https://checker.example.com/validate",
                        "requestImageCheckService": "https://image-check.example.com/scan",
                        "matchType": "exact/prefix",
                        "modalityType": "text/image"
                      }
                    ],
                    "consumerResponseCheckService": [
                      {
                        "name": "AI_API",
                        "responseCheckService": "https://checker.example.com/validate-response",
                        "responseImageCheckService": "https://image-check.example.com/scan-response",
                        "matchType": "term",
                        "modalityType": "text/image"
                      }
                    ],
                    "consumerRiskLevel": [
                      {
                        "name": "APIG-UI",
                        "matchType": "term",
                        "type": "K8S",
                        "level": "Critical"
                      }
                    ]
                  },
                  "aiTokenRateLimitConfig": {
                    "rules": [
                      {
                        "limitType": "request/token",
                        "matchKey": "user_id/api_path",
                        "matchType": "term",
                        "matchValue": "user123",
                        "limitMode": "local",
                        "limitValue": 100
                      }
                    ],
                    "globalRules": [
                      {
                        "limitType": "request",
                        "matchKey": "user_id",
                        "matchType": "term",
                        "matchValue": "user123",
                        "limitMode": "local",
                        "limitValue": 100
                      }
                    ],
                    "enableGlobalRules": true
                  }
                }
              ],
              "customDomainInfos": [
                {
                  "domainId": "d-cshee6dlhtgk******",
                  "name": "hello-server.com",
                  "protocol": "HTTP"
                }
              ],
              "subDomains": [
                {
                  "domainId": "d-csmn42um******",
                  "name": "test",
                  "protocol": "HTTP",
                  "networkType": "Intranet"
                }
              ]
            }
          ],
          "deployCntMap": {
            "key": {
              "deployedCnt": 3,
              "Cnt": 5
            }
          },
          "agentProtocols": [
            "DashScope"
          ]
        },
        "environmentInfo": {
          "environmentId": "env-cq7l5s5lhtgi6qasrdc0",
          "name": "test",
          "alias": "测试环境",
          "description": "这是xxxxx项目测试环境",
          "gatewayInfo": {
            "gatewayId": "gw-cq7og15lhtgi6qasrj60",
            "name": "apitest-gw",
            "vpcInfo": {
              "vpcId": "vpc-uf664nyle5kh***",
              "name": "商品中心预发环境专有网络"
            },
            "engineVersion": "2.0.7"
          },
          "subDomainInfos": [
            {
              "domainId": "d-cpudb0llhtgl2djvq2sg",
              "name": "abc.com",
              "protocol": "HTTP",
              "networkType": "Intranet"
            }
          ],
          "default": false,
          "createTimestamp": 1721116090326,
          "updateTimestamp": 1721116090326,
          "resourceGroupId": "rg-xxxx"
        },
        "gatewayInfo": {
          "gatewayId": "gw-cq7og15lhtgi6qasrj60",
          "name": "apitest-gw",
          "vpcInfo": {
            "vpcId": "vpc-uf664nyle5kh***",
            "name": "商品中心预发环境专有网络"
          },
          "engineVersion": "2.0.7"
        },
        "resourceId": 2351944,
        "resourceType": "HttpApiRoute",
        "expireStatus": "InEffect",
        "expireMode": "ShortTerm",
        "expireTimestamp": 172086834548,
        "createTimestamp": 1719386834548,
        "updateTimestamp": 1721116090326,
        "deployStatus": {}
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2026-01-05新增 OpenAPI查看变更详情