Updates the attributes of a consumer group.

Request syntax

PUT /logstores/logstoreName/consumergroups/consumerGroup HTTP/1.1
Authorization: LOG yourAccessKeyId:yourSignature 
x-log-bodyrawsize: 0
x-log-apiversion: 0.6.0
Host: ProjectName.Endpoint
x-log-signaturemethod: hmac-sha1
Date: GMT Date
Content-Type: application/json
Content-MD5: F58544E4D022CC28A93D0B7CC208A5AA
Content-Length: 20
{
  "timeout": timeout,
  "order": order
}

The value of the Host parameter consists of a project name and an endpoint. You must specify a project name for the Host parameter.

Request parameters

  • Request headers

    The UpdateConsumerGroup operation does not have operation-specific request headers. For information about the common request headers of Log Service API operations, see Common request headers.

  • Parameters
    Parameter Type Required Example Description
    projectName String Yes my-project The name of the project.
    logstoreName String Yes logstore-test The name of the Logstore.
    consumerGroup String Yes consumer-group-1 The name of the consumer group.
    timeout Integer No 100 The timeout period. The timeout period. If Log Service does not receive heartbeat messages from the consumer group within the timeout period, the consumer group is deleted. Unit: seconds.
    Note You must specify the timeout or order parameter, or both.
    order Boolean No False Specifies whether to consume data in sequence from a single shard. Valid values:
    • true: The data in a single shard is consumed in sequence. After the shard is split, the data in the original shard is consumed. Then, the data in the new shards is consumed at the same time.
    • False: The data in a single shard is randomly consumed.
    Note You must specify the timeout or order parameter, or both.

Response parameters

  • Response headers

    The UpdateConsumerGroup operation does not have special response headers. For information about the common response headers of Log Service API operations, see Common response headers.

  • Response elements

    If the request succeeds, the HTTP status code 200 is returned. If the request is successful, no other elements are returned.

Examples

  • Sample requests
    PUT /logstores/logstore-test/consumergroups/consumer-group-1 HTTP/1.1
    Header:
    Authorization: LOG yourAccessKeyId:yourSignature
    x-log-bodyrawsize: 0
    User-Agent: sls-java-sdk-v-0.6.1
    x-log-apiversion: 0.6.0
    Host: my-project.cn-shanghai.log.aliyuncs.com
    x-log-signaturemethod: hmac-sha1
    Date: Fri, 04 May 2018 08:02:22 GMT
    Content-Type: application/json
    Content-MD5: F58544E4D022CC28A93D0B7CC208A5AA
    Content-Length: 65
    Connection: Keep-Alive
    Body:
    {
      "order": False,
      "timeout": 100
    }
  • Sample success responses
    HTTP/1.1 200 OK
    Header:
    {
    Server: nginx/1.12.1
    Content-Length: 0
    Connection: close
    Access-Control-Allow-Origin: *
    Date: Fri, 04 May 2018 08:15:11 GMT
    x-log-requestid: 5AEC168FA796F4195BF404CB
    }

Error codes

HTTP status code Error code Error message Description
400 JsonInfoInvalid Timeout is of error value type. The error message returned because the specified type of the timeout parameter is invalid.
404 ProjectNotExist The Project does not exist : projectName. The error message returned because the specified project does not exist.
404 ConsumerGroupNotExist Consumer group not exist. The error message returned because the specified consumer group does not exist.
404 LogStoreNotExist Logstore logstoreName dose not exist. The error message returned because the specified Logstore does not exist.
500 InternalServerError Specified Server Error Message. The error message returned because an internal server error has occurred.

For more information about the error codes, see Common error codes.