Modifying a Specified Consumer Group
Function
This API is used to modify a specified consumer group.
Calling Method
For details, see Calling APIs.
URI
PUT /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group}
Parameter | Mandatory | Type | Description |
|---|---|---|---|
engine | Yes | String | Engine. |
project_id | Yes | String | Project ID. For details about how to obtain it, see Obtaining a Project ID. |
instance_id | Yes | String | Instance ID. |
group | Yes | String | Consumer group ID. |
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
group_name | No | String | Definition Consumer group name. Constraints N/A Range N/A Default Value N/A |
group_desc | No | String | Definition Consumer group description. Constraints A maximum of 200 characters Range N/A Default Value N/A |
Response Parameters
Status code: 204
Operation successful.
None
Example Requests
PUT https://{endpoint}/v2/{engine}/{project_id}/instances/{instance_id}/groups/{group}
{
"group_name" : "test",
"group_desc" : "this is a test group"
} Example Responses
None
Status Codes
Status Code | Description |
|---|---|
204 | Operation successful. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
