# 提交Checkpoint - CommitCheckpoint
#### 功能介绍
本接口用于提交Checkpoint。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-dis/dis_02_0400.html)。
#### URI
POST /v2/{project_id}/checkpoints
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述    |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                       |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
表3请求Body参数 
| 参数              | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| app_name        | 是    | String | APP的名称，用户数据消费程序的唯一标识符，需要先通过创建App接口创建。                                                                                                                                                                                  |
| checkpoint_type | 是    | String | Checkpoint类型。 - LAST_READ：在数据库中只记录序列号。    |
| stream_name     | 是    | String | 已创建的通道名称。                                                                                                                                                                                                              |
| partition_id    | 是    | String | 通道的分区标识符。可定义为如下两种样式：- shardId-0000000000- 0比如一个通道有三个分区，那么分区标识符分别为0, 1, 2，或者shardId-0000000000, shardId-0000000001, shardId-0000000002                                                                                  |
| sequence_number | 是    | String | 需要提交的序列号，用来记录该通道的消费检查点，需要保证该序列号处于有效范围内。                                                                                                                                                                                |
| metadata        | 否    | String | 用户消费程序端的元数据信息。 元数据信息的最大长度为1000个字符。                                                                                                                                                      |
   
#### 响应参数
**状态码：201**
正常返回
无
#### 请求示例
提交Checkpoint
```
POST https://{Endpoint}/v2/{project_id}/checkpoints
{
  "stream_name" : "newstream",
  "app_name" : "newapp",
  "partition_id" : "0",
  "sequence_number" : "2",
  "checkpoint_type" : "LAST_READ"
}
```
#### 响应示例
无
#### SDK代码示例
SDK代码示例如下。
#### Java
提交Checkpoint
```
package com.huaweicloud.sdk.test;
import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dis.v2.region.DisRegion;
import com.huaweicloud.sdk.dis.v2.*;
import com.huaweicloud.sdk.dis.v2.model.*;
public class CommitCheckpointSolution {
    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";
        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);
        DisClient client = DisClient.newBuilder()
                .withCredential(auth)
                .withRegion(DisRegion.valueOf("<YOUR REGION>"))
                .build();
        CommitCheckpointRequest request = new CommitCheckpointRequest();
        CommitCheckpointReq body = new CommitCheckpointReq();
        body.withSequenceNumber("2");
        body.withPartitionId("0");
        body.withStreamName("newstream");
        body.withCheckpointType(CommitCheckpointReq.CheckpointTypeEnum.fromValue("LAST_READ"));
        body.withAppName("newapp");
        request.withBody(body);
        try {
            CommitCheckpointResponse response = client.commitCheckpoint(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
```
#### Python
提交Checkpoint
```
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdis.v2.region.dis_region import DisRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdis.v2 import *
if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"
    credentials = BasicCredentials(ak, sk, projectId)
    client = DisClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DisRegion.value_of("<YOUR REGION>")) \
        .build()
    try:
        request = CommitCheckpointRequest()
        request.body = CommitCheckpointReq(
            sequence_number="2",
            partition_id="0",
            stream_name="newstream",
            checkpoint_type="LAST_READ",
            app_name="newapp"
        )
        response = client.commit_checkpoint(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
```
#### Go
提交Checkpoint
```
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dis "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dis/v2"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dis/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dis/v2/region"
)
func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"
    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()
    client := dis.NewDisClient(
        dis.DisClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())
    request := &model.CommitCheckpointRequest{}
request.Body = &model.CommitCheckpointReq{
SequenceNumber: "2",
PartitionId: "0",
StreamName: "newstream",
CheckpointType: model.GetCommitCheckpointReqCheckpointTypeEnum().LAST_READ,
AppName: "newapp",
}
response, err := client.CommitCheckpoint(request)
if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}
```
#### 更多
更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DIS/sdk?api=CommitCheckpoint)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述   |
|:---|:---|
| 201 | 正常返回 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-dis/ErrorCode.html)。