上传数据 - SendRecords
功能介绍
本接口用于上传数据到DIS通道中。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/records
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
stream_name |
是 |
String |
已创建的通道名称。 |
|
stream_id |
否 |
String |
通道唯一标识符。 当使用stream_name没有找到对应通道且stream_id不为空时,会使用stream_id去查找通道。 说明: 上传数据到被授权的通道时,必须配置此参数。 |
|
records |
是 |
Array of PutRecordsRequestEntry objects |
待上传的记录列表。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
data |
是 |
String |
需要上传的数据。 上传的数据为序列化之后的二进制数据(Base64编码后的字符串)。 比如需要上传字符串“data”,“data”经过Base64编码之后是“ZGF0YQ==”。 |
|
explicit_hash_key |
否 |
String |
用于明确数据需要写入分区的哈希值,此哈希值将覆盖“partition_key”的哈希值。 取值范围:0~long.max |
|
partition_id |
否 |
String |
通道的分区标识符。可定义为如下两种样式:- shardId-0000000000- 0比如一个通道有三个分区,那么分区标识符分别为0, 1, 2,或者shardId-0000000000, shardId-0000000001, shardId-0000000002 |
|
partition_key |
否 |
String |
数据将写入的分区。说明:如果传了partition_id参数,则优先使用partition_id参数。如果partition_id没有传,则使用partition_key。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
failed_record_count |
Integer |
上传失败的数据数量。若上传数据中有失败,则此字段值>0。 |
|
records |
Array of PutRecordsResultEntry objects |
上传结果列表。注意:调用方需要对此字段进行解析,确认数据是否会全部上传成功。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
partition_id |
String |
数据上传成功后,存储到DIS通道中的分区ID。如果上传失败,则无此字段。 |
|
sequence_number |
String |
数据上传成功后,存储到DIS通道中数据的序列号。序列号是每个记录的唯一标识符。序列号由DIS在数据生产者调用PutRecords操作以添加数据到DIS数据通道时DIS服务自动分配的。同一分区键的序列号通常会随时间变化增加。PutRecords请求之间的时间段越长,序列号越大。注意:上传失败时,无此字段。 |
|
error_code |
String |
错误码。注意:数据上传成功时,无此字段。反之,此字段有值。 |
|
error_message |
String |
错误消息。注意:数据上传成功时,无此字段。反之,此字段有值。 |
请求示例
上传数据
POST https://{Endpoint}/v2/{project_id}/records
{
"stream_name" : "newstream",
"records" : [ {
"data" : "MTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTE="
} ]
}
响应示例
状态码:200
注意:响应状态码为200,上传数据有可能全部上传成功,也有可能部分上传失败,用户业务需要对响应体进行解析处理。
示例为部分数据上传失败样例。
{
"failed_record_count" : 2,
"records" : {
"partition_id" : "shardId-0000000000",
"sequence_number" : 17,
"error_code" : "DIS.xxxx",
"error_message" : "Exceeded traffic control limit"
}
}
SDK代码示例
SDK代码示例如下。
Java
上传数据
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
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.*; import java.util.List; import java.util.ArrayList; public class SendRecordsSolution { 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(); SendRecordsRequest request = new SendRecordsRequest(); PutRecordsRequest body = new PutRecordsRequest(); List<PutRecordsRequestEntry> listbodyRecords = new ArrayList<>(); listbodyRecords.add( new PutRecordsRequestEntry() .withData("MTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTE=") ); body.withRecords(listbodyRecords); body.withStreamName("newstream"); request.withBody(body); try { SendRecordsResponse response = client.sendRecords(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
上传数据
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# 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 = SendRecordsRequest() listRecordsbody = [ PutRecordsRequestEntry( data="MTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTE=" ) ] request.body = PutRecordsRequest( records=listRecordsbody, stream_name="newstream" ) response = client.send_records(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
上传数据
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
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.SendRecordsRequest{} var listRecordsbody = []model.PutRecordsRequestEntry{ { Data: "MTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTE=", }, } request.Body = &model.PutRecordsRequest{ Records: listRecordsbody, StreamName: "newstream", } response, err := client.SendRecords(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
注意:响应状态码为200,上传数据有可能全部上传成功,也有可能部分上传失败,用户业务需要对响应体进行解析处理。 示例为部分数据上传失败样例。 |
错误码
请参见错误码。