调用CreateConsumerAuthorizationRules创建消费者授权规则-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

创建消费者授权规则。

接口说明

前置条件：创建消费者授权规则前，需要按以下依赖链准备资源（括号内为对应创建 API 及 ID 传递关系）：网关实例（CreateGateway → gatewayId，gw- 前缀）环境（网关创建后自带默认环境，也可 CreateEnvironment → environmentId，env- 前缀，需关联步骤 1 的 gatewayId） HTTP API（CreateHttpApi → httpApiId，api- 前缀）路由并发布（CreateHttpApiRoute → routeId，hr- 前缀，属于步骤 3 的 API；再通过 DeployHttpApi 发布到步骤 2 的环境。未发布的路由无法授权）消费者（CreateConsumer → consumerId，cs- 前缀；或消费者组 consumerGroupId，csg- 前缀，与 consumerId 二选一）

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apig:CreateConsumerAuthorizationRules

none

*全部资源

*

无

请求语法

POST /v1/authorization-rules HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
body	object	否	请求体参数。本接口为 ROA 风格 API，所有业务参数必须整体嵌套在 body 键下作为 JSON 请求体传输，不能将 authorizationRules 等字段平铺到请求顶层参数中，否则服务端将因请求体为空返回 400（authorizationRules 参数为空）。	{'key': 'value'}
authorizationRules	array<object>	否	消费者鉴权规则。
	array<object>	否	消费者鉴权规则。
principalType	string	否	授权主体类型枚举值： Consumer : 消费者 ConsumerGroup : 消费者组	ConsumerGroup
consumerId	string	否	消费者 ID。	cs-******
consumerGroupId	string	否	消费者组 ID	csg-8c13d2b4f8a1
resourceType	string	否	资源类型。枚举值： Policy : 策略 Consumer : 消费者 Service : 服务 HttpApi : HTTP API PluginClass : 插件类 Domain : 域名 HttpApiRoute : HTTP API 路由 Plugin : 插件 ConsumerGroup : 消费者组	HttpApiRoute
resourceIdentifier	object	否	资源标识，提供给非标代码源作为空间复用的唯一标识
resourceId	string	否	授权目标资源 ID。所需的 ID 类型由 resourceType 决定，前缀必须匹配	ha-cn-li942gy8p03
environmentId	string	否	环境 ID。	env-******
resources	array	否	资源信息。
	string	否	资源信息。	[]
parentResourceId	string	否	父资源 ID。	api-******
expireMode	string	否	失效模式，当前仅支持 LongTerm 枚举值： LongTerm : 长期有效	LongTerm
expireTimestamp	integer	否	失效时间戳。单位: 毫秒。	1741162221

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	3ACFC7A7-45A9-58CF-B2D5-765B60254695
code	string	响应状态码。	Ok
message	string	响应消息。	success
data	object	响应数据。
consumerAuthorizationRuleIds	array	消费者授权规则 ID 列表。
	string	消费者授权规则 ID。	car-cus2d1em1hkg7732kuk0

示例

正常返回示例

JSON格式

{
  "requestId": "3ACFC7A7-45A9-58CF-B2D5-765B60254695",
  "code": "Ok",
  "message": "success",
  "data": {
    "consumerAuthorizationRuleIds": [
      "car-cus2d1em1hkg7732kuk0"
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。