指定された Logstore にコンシューマーグループを作成します。

例:
POST /logstores/{logstoreName}/consumergroups

リクエスト構文

POST /logstores/<logstoreName>/consumergroups HTTP/1.1
Authorization:<AuthorizationString>
'x-log-bodyrawsize': '0',
User-Agent: <UserAgent>
x-log-apiversion: 0.6.0
Host: <Project Endpoint>
x-log-signaturemethod: hmac-sha1
Date: <GMT Date>
Content-Type: application/json
Content-MD5: F58544E4D022CC28A93D0B7CC208A5AA
Content-Length: <ContentLength>
{
  "consumerGroup": <consumerGroup>,
  "timeout": <timeout>,
  "order": <order>
}

リクエストパラメーター

属性名 データ型 必須/省略可能 説明
logstoreName string 必須 Logstore 名
consumerGroup string 必須 コンシューマーグループ名はプロジェクトにおいて一意でなければなりません。
timeout integer 必須 タイムアウト期間。 タイムアウト期間中にハートビートを受信しない場合、コンシューマーグループは削除されます。
order bool 必須 シャードのデータを順番に消費するかどうかを設定します。
  • true:シャードのデータを順番に消費する設定を表します。 具体的には、シャードを 2 つの新しいシャードに分割すると、最初に元のシャードのデータが消費され、次に 2 つの新しいシャードのデータが同時に消費されます。
  • false:シャードのデータを順番に消費しない設定を表します。
リクエストヘッダー

CreateConsumerGroup インターフェースに特別のリクエストヘッダーはありません。 Log Service API のパブリックリクエストヘッダーの詳細については、「パブリックリクエストヘッダー」をご参照ください。

レスポンスヘッダー

CreateConsumerGroup インターフェースに特別のレスポンスヘッダーはありません。 Log Service API のパブリックレスポンスヘッダーの詳細については、「パブリックレスポンスヘッダー」をご参照ください。

レスポンス要素

返される状態コードは、200 です。

エラーコード

Log Service API の 一般的なエラー コード に加えて、インターフェースから以下のエラーコードが返される場合があります。

HTTP ステータスコード ErrorCode ErrorMessage
400 ConsumerGroupAlreadyExist consumer group already exist
400 JsonInfoInvalid consumerGroup or timeout is of error format
404 ProjectNotExist The Project does not exist : {Project}
404 LogStoreNotExist logstore {logstoreName} dose not exist
500 InternalServerError Specified Server Error Message

リクエスト例:
POST /logstores/my-logstore/consumergroups 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:
{
  "consumerGroup": "consumer-group-1",
  "timeout": 300,
  "order": true
}
レスポンス例:
HTTP/1.1 200
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