指定した Logstore のすべてのコンシューマーグループを照会します。
例:
GET /logstores/{logstoreName}/consumergroups
リクエスト構文
GET /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/x-protobuf
Connection: Keep-Alive
リクエストパラメーター
属性名 | タイプ | 必須/省略可能 | 説明 |
---|---|---|---|
logstoreName | string | 必須 | Logstore 名 |
ListConsumerGroup インターフェースに特別のリクエストパラメーターはありません。 Log Service API のパブリックリクエストヘッダーの詳細については、「パブリックリクエストヘッダー」をご参照ください。
レスポンスヘッダーListConsumerGroup インターフェースに特別のリクエストパラメーターはありません。 Log Service API のパブリックレスポンスヘッダーの詳細については、「パブリックレスポンスヘッダー」をご参照ください。
レスポンス要素ListConsumerGroup リクエストが正常に送信されると、レスポンスボディは指定したプロジェクトと Logstore の中にすべてのコンシューマーグループを以下の形式で含みます。
属性名 | データ型 | 説明 |
---|---|---|
Consumergroup | string | コンシューマーグループ名 |
timeout | integer | タイムアウト期間。 タイムアウト期間内にハートビートが受信されければ、コンシューマーグループは削除されます。 |
order | bool | 順次消費するかどうかを設定します。 |
Log Service API の 一般的なエラー コード に加えて以下のエラーコードがインターフェースから返される場合があります。
HTTP ステータスコード | ErrorCode | ErrorMessage |
---|---|---|
404 | ProjectNotExist | The Project does not exist : {Project} |
404 | LogStoreNotExist | logstore {logstoreName} dose not exist |
500 | InternalServerError | Specified Server Error Message. |
例
リクエスト例:
GET /logstores/my-logstore/consumergroups HTTP/1.1
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:47:30 GMT
Content-Type: application/x-protobuf
Connection: keep-alive
レスポンス例:
HTTP/1.1 200
Server: nginx/1.12.1
Content-Type: application/json
Connection: close
Access-Control-Allow-Origin: *
Date: Fri, 04 May 2012 03:21:12 GMT
x-log-requestid: 5AEC1E23048191954B42EAB9
[
{
"name": "test-consumer-group",
"timeout": 30,
"order": true
}
]