調用GetCheckPoint接口獲取指定消費組消費數據時Shard的checkpoint。
接口說明
- 請求語法中 Host 由 Project 名稱和日志服務 Endpoint 構成，您需要在 Host 中指定 Project。
- 已創建并獲取 AccessKey。更多信息，請參見訪問密鑰。
阿里云賬號 AccessKey 擁有所有 API 的訪問權限，風險很高。強烈建議您創建并使用 RAM 用戶進行 API 訪問或日常運維。RAM 用戶需具備操作日志服務資源的權限。具體操作，請參見創建 RAM 用戶及授權。
- 已明確您查詢日志所屬的 Project 名稱、所屬地域、Logstore 名稱等。如何查詢，請參見管理 Project和管理 Logstore。
- 已獲取消費組名稱。更多信息，請參見 ListConsumerGroup 。
鑒權資源
下表列出了 API 對應的授權信息。您可以在 RAM 權限策略語句的 Action 元素中添加該信息，用于為 RAM 用戶或 RAM 角色授予調用此 API 的權限。
| 動作（Action） | 授權策略中的資源描述方式（Resource） |
|---|---|
log:GetConsumerGroupCheckPoint | acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup} |
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求語法
GET /logstores/{logstore}/consumergroups/{consumerGroup} HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| project | string | 是 | Project 名稱。 | ali-test-project |
| logstore | string | 是 | Logstore 名稱。 | test-logstore |
| consumerGroup | string | 是 | 消費組名稱。 | consumer-group-1 |
| shard | integer | 否 | Shard ID。
| 1 |
返回參數
示例
正常返回示例
JSON格式
[
{
"shard": 0,
"checkpoint": "MTUyNDE1NTM3OTM3MzkwODQ5Ng==",
"updateTime": 1524224984800922,
"consumer": "consumer_1"
}
]錯誤碼
訪問錯誤中心查看更多錯誤碼。
| HttpStatusCode | ErrorCode | ErrorMessage | 錯誤碼描述 |
|---|---|---|---|
| 404 | ProjectNotExist | Project does not exist. | Project 不存在。 |
| 404 | LogStoreNotExist | Logstore does not exist. | Logstore 不存在。 |
| 404 | ConsumerGroupNotExist | consumer group not exist. | 消費組不存在。 |
| 500 | InternalServerError | Specified Server Error Message. | 內部服務調用錯誤。 |
更多信息，請參見通用錯誤碼。