CreateConsumerAuthorizationRule - API Gateway - Alibaba Cloud Documentation Center

Creates a consumer authorization rule.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
apig:CreateConsumerAuthorizationRule	none	*Domain `acs:apig:{#regionId}:{#accountId}:consumer/{#ConsumerId}`	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
consumerId	string	No	The consumer ID.	cs-ctd4l1um1hkph7ki1k80
body	object	No	The request body.
resourceType	string	No	The resource type,	API
parentResourceType	string	No	The type of the parent resource.	API
authorizationResourceInfos	array	No	The list of resource authorization information.
	AuthorizationResourceInfo	No	The resource authorization information.
expireMode	string	No	The expiry mode. Valid values: LongTerm and ShortTerm.	LongTerm
expireTimestamp	long	No	The expiration time.	1750852089975

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
requestId	string	The request ID.	6CC83C32-3B5A-57EE-9AFE-D0D51822C7BA
code	string	The status code.	Ok
message	string	The status message.	success
data	object	The response payload.
consumerAuthorizationRuleId	string	Filters the list of operations based on a specific consumer authorization rule ID. Only authorized operations are returned in the response.	car-d06p196m1hkg9ukum5pg

Examples

Sample success responses

JSONformat

{
  "requestId": "6CC83C32-3B5A-57EE-9AFE-D0D51822C7BA",
  "code": "Ok",
  "message": "success",
  "data": {
    "consumerAuthorizationRuleId": "car-d06p196m1hkg9ukum5pg"
  }
}

Error codes

For a list of error codes, visit the Service error codes.