更新指定消費組消費數據時Shard的checkpoint。
接口說明
- 當不指定消費者時，必須指定 forceSuccess 為 true 才能更新 checkpoint。
- Host 由 Project 名稱和日志服務 Endpoint 構成，您需要在 Host 中指定 Project。
- 已創建并獲取 AccessKey。更多信息，請參見訪問密鑰。
阿里云賬號 AccessKey 擁有所有 API 的訪問權限，風險很高。強烈建議您創建并使用 RAM 用戶進行 API 訪問或日常運維。RAM 用戶需具備操作日志服務資源的權限。具體操作，請參見創建 RAM 用戶及授權。
- 已明確您查詢日志所屬的 Project 名稱、所屬地域、Logstore 名稱等。如何查詢，請參見管理 Project和管理 Logstore。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| log:ConsumerGroupUpdateCheckPoint | update | *全部資源 * |
| 無 |
請求語法
POST /logstores/{logstore}/consumergroups/{consumerGroup}?type=checkpoint HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| project | string | 是 | Project 名稱。 | ali-test-project |
| logstore | string | 是 | Logstore 名稱。 | ali-test-logstore |
| consumerGroup | string | 是 | 消費組名稱。 | consumer_group_test |
| consumer | string | 是 | 消費者。 | consumer_1 |
| forceSuccess | boolean | 否 | 是否強制更新。
| true |
| body | object | 否 | Shard ID。 |
返回參數
示例
正常返回示例
JSON格式
{}錯誤碼
訪問錯誤中心查看更多錯誤碼。
| HttpStatusCode | ErrorCode | ErrorMessage | 錯誤碼描述 |
|---|---|---|---|
| 400 | InvalidShardCheckPoint | shard checkpoint not encoded by base64. | checkpoint 不是 Base64 編碼，格式錯誤。 |
| 404 | ProjectNotExist | Project does not exist. | Project 不存在。 |
| 404 | LogStoreNotExist | Logstore does not exist. | Logstore 不存在。 |
| 404 | ConsumerGroupNotExist | consumer group not exist. | 消費組不存在。 |
| 404 | ConsumerNotExist | consumer not exist in the consumer group. | 消費組中不存在該消費者。 |
| 404 | ShardNotExist | shard not exist. | Shard 不存在。 |
| 500 | InternalServerError | Specified Server Error Message. | 內部服務調用錯誤。 |
更多信息，請參見通用錯誤碼。