All Products
Search
Document Center

API Gateway:CreateConsumerAuthorizationRules

Last Updated:Dec 25, 2025

Creates a consumer authentication 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
apig:CreateConsumerAuthorizationRulesnone
*All Resources
*
    none
none

Request syntax

POST /v1/authorization-rules HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request body.

authorizationRulesarray<object>No

The consumer authentication rules to be created.

objectNo
consumerIdstringNo

The consumer ID.

cs-cu08olem1hkokaut34i0
resourceTypestringNo

The resource type.

HttpApiRoute
resourceIdentifierobjectNo

The resource identifier, which is provided to non-standard code sources for space reuse.

resourceIdstringNo

The resource ID.

ha-cn-li942gy8p03
environmentIdstringNo

The environment ID.

env-cti17hem1hktoruj98ug
expireModestringNo

The expiration mode. Valid values: LongTerm and ShortTerm.

LongTerm
expireTimestamplongNo

The expiration timestamp.

174116222x

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

Id of the request

3ACFC7A7-45A9-58CF-B2D5-765B60254695
codestring

The status code.

Ok
messagestring

The returned message.

success
dataobject

The response parameters.

consumerAuthorizationRuleIdsarray

The authentication rule IDs.

itemstring

The authentication rule ID.

car-cus2d1em1hkg7732kuk0

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2025-07-24The internal configuration of the API is changed, but the call is not affectedView Change Details