ModifyConsumer

更新时间:
复制 MD 格式

Modifies the properties of a consumer.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

GwClusterId

string

Yes

The ID of the gateway instance.

pg-xxxxxxxx

ConsumerGroupName

string

No

The name of the consumer group.

cg-xxxxxx

Name

string

Yes

The new name for the consumer.

test

IsDefault

string

No

Indicates if the consumer is in the default group. Valid values: 0 (No) and 1 (Yes).

0

ConsumerId

string

Yes

The ID of the consumer.

c-mqveroemc***

RegionId

string

No

The ID of the region.

cn-beijing

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

6BD9CDE4-5E7B-4BF3-9BB8-83C73E******

ConsumerId

string

The ID of the consumer.

c-mqveroemc***

Examples

Success response

JSON format

{
  "RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******",
  "ConsumerId": "c-mqveroemc***"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.