查询消费者授权规则列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
apig:QueryConsumerAuthorizationRules |
none |
*全部资源
|
无 | 无 |
请求语法
GET /v1/authorization-rules HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| apiNameLike |
string |
否 |
API 名。 |
api-xx |
| pageNumber |
integer |
否 |
分页页码。 |
1 |
| pageSize |
integer |
否 |
分页大小。 |
10 |
| consumerId |
string |
否 |
消费者 ID。 |
cs-ct21c16m1hkp64hk6qmg |
| resourceId |
string |
否 |
资源 ID。 |
ha-cn-li942gy8p03 |
| resourceType |
string |
否 |
资源类型。 |
HttpApiRoute |
| environmentId |
string |
否 |
环境 ID。 |
env-cpqnr6tlhtgubc*** |
| groupByApi |
boolean |
否 |
通过 API 分组。 |
true |
| parentResourceId |
string |
否 |
父项资源 ID。 |
ha-cn-li942gy8p01 |
| consumerNameLike |
string |
否 |
消费者名称。 |
consumer-xxx |
| resourceTypes |
string |
否 |
服务来源类型 |
K8S |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
Id of the request |
A60EE5CA-1294-532A-9775-8D2FD1C6EFBF |
| code |
string |
响应状态码。 |
Ok |
| message |
string |
响应消息。 |
success |
| data |
object |
响应数据。 |
|
| totalSize |
string |
总数量。 |
6 |
| pageNumber |
integer |
分页页码。 |
1 |
| pageSize |
integer |
分页大小。 |
10 |
| items |
array<object> |
消费者规则列表。 |
|
|
array<object> |
消费者鉴权规则详情。 |
||
| consumerAuthorizationRuleId |
string |
消费者授权规则 ID。 |
car-csgeka5lhtggrjcprok0 |
| consumerId |
string |
消费者 ID。 |
cs-csheiftlhtgmp0j0hp4g |
| apiInfo | HttpApiApiInfo |
API 信息详情。 |
|
| environmentInfo | EnvironmentInfo |
环境信息。 |
|
| gatewayInfo | GatewayInfo |
网关信息。 |
|
| resourceId |
string |
资源 ID。 |
2351944 |
| resourceType |
string |
资源类型。 |
HttpApiRoute |
| expireStatus |
string |
失效状态。 |
InEffect |
| expireMode |
string |
失效模式。LongTerm、ShortTerm，二选一。 |
ShortTerm |
| expireTimestamp |
integer |
到期时间。 |
172086834548 |
| createTimestamp |
integer |
创建时间戳。单位: 毫秒。 |
1719386834548 |
| updateTimestamp |
integer |
更新时间戳。单位: 毫秒。 |
1719386834548 |
| deployStatus |
string |
API 在当前环境的发布状态 |
{} |
| consumerInfo | ConsumerInfo |
消费者信息详情。 |
|
| resourceInfo |
object |
资源信息详情。 |
|
| route | HttpRoute |
路由规则。 |
|
| operationInfo | HttpApiOperationInfo |
接口信息。 |
示例
正常返回示例
JSON格式
{
"requestId": "A60EE5CA-1294-532A-9775-8D2FD1C6EFBF",
"code": "Ok",
"message": "success",
"data": {
"totalSize": "6",
"pageNumber": 1,
"pageSize": 10,
"items": [
{
"consumerAuthorizationRuleId": "car-csgeka5lhtggrjcprok0",
"consumerId": "cs-csheiftlhtgmp0j0hp4g",
"environmentInfo": {
"environmentId": "env-cq7l5s5lhtgi6qasrdc0",
"name": "test",
"alias": "测试环境",
"description": "这是xxx的xx项目测试环境",
"gatewayInfo": {
"gatewayId": "gw-cq7og15lhtgi6qasrj60",
"name": "apitest-gw",
"vpcInfo": {
"vpcId": "vpc-uf664nyle5kh***",
"name": "商品中心预发环境专有网络"
},
"engineVersion": "2.0.7",
"gatewayEdition": "MultiTenantServerless"
},
"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",
"gatewayEdition": "MultiTenantServerless"
},
"resourceId": "2351944",
"resourceType": "HttpApiRoute",
"expireStatus": "InEffect",
"expireMode": "ShortTerm",
"expireTimestamp": 172086834548,
"createTimestamp": 1719386834548,
"updateTimestamp": 1719386834548,
"deployStatus": "{}",
"consumerInfo": {
"consumerId": "cs-ctd4l1um1hkph7ki1k80",
"name": "test",
"enable": false
},
"resourceInfo": {}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。