All Products
Search
Document Center

API Gateway:UpdateConsumer

Last Updated:Dec 25, 2025

Updates a consumer.

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:UpdateConsumernone
*Domain
acs:apig:{#regionId}:{#accountId}:consumer/{#ConsumerId}
    none
none

Request syntax

PUT /v1/consumers/{consumerId} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
consumerIdstringNo

The consumer ID.

cs-cvfmq9um1hkg1teictkg
bodyobjectNo

The request body.

descriptionstringNo

The description.

This is the description.
jwtIdentityConfigJwtIdentityConfigNo

The JWT authentication configuration.

akSkIdentityConfigsarrayNo

The list of AK/SK authentication configurations.

AkSkIdentityConfigNo

The AK/SK authentication configurations.

apikeyIdentityConfigApiKeyIdentityConfigNo

The API key authentication configurations.

enablebooleanNo

Specifies the enablement status.

false

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

The request ID.

B917B12C-030A-597A-AF2B-6C4353FC9F10
codestring

The status code.

Ok
messagestring

The status message.

ok

Examples

Sample success responses

JSONformat

{
  "requestId": "B917B12C-030A-597A-AF2B-6C4353FC9F10",
  "code": "Ok",
  "message": "ok"
}

Error codes

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