vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dis/api-ref/dis_02_0018.html
Xiong, Chen Xiao 83fa2f6615 DIS API 20230116 version 
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
2023-06-27 15:26:05 +00:00

259 lines
18 KiB
HTML
Raw Blame History

<a name="dis_02_0018"></a><a name="dis_02_0018"></a>
<h1 class="topictitle1">Uploading Data</h1>
<div id="body19864141914583"><div class="section" id="dis_02_0018__section8864121985817"><h4 class="sectiontitle">Function</h4><p id="dis_02_0018__p686481965819">This API is used to upload data to DIS streams.</p>
</div>
<div class="section" id="dis_02_0018__section18658191584"><h4 class="sectiontitle">URI</h4><p id="dis_02_0018__p1886520193580">POST /v2/{project_id}/records</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0018__table2086641911586" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="dis_02_0018__row3866319165818"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="dis_02_0018__p1186761935815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="dis_02_0018__p286761955814">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="dis_02_0018__p286741918587">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="dis_02_0018__p2867181917586">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0018__row186651918587"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="dis_02_0018__p38685190582">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="dis_02_0018__p148688198581">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="dis_02_0018__p19869519125810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="dis_02_0018__p168696191589">Project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dis_02_0018__section1487071965814"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0018__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="dis_02_0018__row1987011935810"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="dis_02_0018__p1187211975817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="dis_02_0018__p118722192585">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="dis_02_0018__p08723192587">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="dis_02_0018__p1387315194581">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0018__row128712194586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dis_02_0018__p1287311190581">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dis_02_0018__p18749196589">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dis_02_0018__p1874141920583">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dis_02_0018__p487420198585">User token</p>
<p id="dis_02_0018__p7875719145817">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="dis_02_0018__b1487571995815">X-Subject-Token</strong> in the response header is the user token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0018__request_PutRecordsRequest" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="dis_02_0018__row19875121916582"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="dis_02_0018__p138776192583">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="dis_02_0018__p48771194583">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="dis_02_0018__p58781619155816">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="dis_02_0018__p48781719115815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0018__row787620196582"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dis_02_0018__p687811955817">stream_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dis_02_0018__p687910193584">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dis_02_0018__p198791219125811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dis_02_0018__p4879519175818">Name of the stream.</p>
<p id="dis_02_0018__p98801419105820">Maximum: <strong id="dis_02_0018__b38808193585">64</strong></p>
</td>
</tr>
<tr id="dis_02_0018__row17876181925816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dis_02_0018__p12880141919584">stream_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dis_02_0018__p198801198586">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dis_02_0018__p68814191589">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dis_02_0018__p4881141945817">Unique ID of the stream</p>
<p id="dis_02_0018__p488111197586">If no stream is found based on stream_name and stream_id is not empty, stream_id is used to search for the stream.</p>
<p id="dis_02_0018__p13882619105810">Note:</p>
<p id="dis_02_0018__p68821719165816">This parameter is mandatory when data is uploaded to the authorized stream.</p>
</td>
</tr>
<tr id="dis_02_0018__row1987671911586"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dis_02_0018__p188821819105817">records</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dis_02_0018__p16882121915811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dis_02_0018__p1488314193587">Array of <a href="#dis_02_0018__request_PutRecordsRequestEntry">PutRecordsRequestEntry</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dis_02_0018__p7884171914583">List of records to be uploaded.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dis_02_0018__request_PutRecordsRequestEntry"></a><a name="request_PutRecordsRequestEntry"></a><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0018__request_PutRecordsRequestEntry" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PutRecordsRequestEntry</caption><thead align="left"><tr id="dis_02_0018__row28841819115810"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="dis_02_0018__p1188621945812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="dis_02_0018__p38871919105820">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="dis_02_0018__p118877196586">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="dis_02_0018__p2088718197581">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0018__row18885181955813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dis_02_0018__p1188841925814">data</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dis_02_0018__p10888141925815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dis_02_0018__p488919193583">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dis_02_0018__p15890141915814">Data to be uploaded</p>
<p id="dis_02_0018__p5890119105810">The uploaded data is the serialized binary data (character string encoded using Base64).</p>
<p id="dis_02_0018__p1189131915816">For example, if the character string data needs to be uploaded, the character string after Base64 encoding is <strong id="dis_02_0018__b11891119195811">ZGF0YQ==</strong>.</p>
</td>
</tr>
<tr id="dis_02_0018__row1288551905814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dis_02_0018__p1989131905819">explicit_hash_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dis_02_0018__p1089161918587">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dis_02_0018__p118921319135814">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dis_02_0018__p1489218199580">Hash value of the data to be written to the partition. The hash value overwrites the hash value of <strong id="dis_02_0018__b13893719165814">partition_key</strong>.</p>
<p id="dis_02_0018__p889319195583">Value range: 0 to long.max</p>
</td>
</tr>
<tr id="dis_02_0018__row11885161919582"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dis_02_0018__p1789315191586">partition_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dis_02_0018__p989317196589">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dis_02_0018__p7894111975811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dis_02_0018__p10894819195810">Partition ID of the stream The value can be in either of the following formats: - shardId-0000000000- 0For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.</p>
</td>
</tr>
<tr id="dis_02_0018__row148851719145816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dis_02_0018__p12894141911586">partition_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dis_02_0018__p6895121935810">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dis_02_0018__p1489511995817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dis_02_0018__p14895191917582">Partition to which data is written to Note:If the <strong id="dis_02_0018__b19896111975813">partition_id</strong> parameter is transferred, it will be preferentially used. If <strong id="dis_02_0018__b11896151911586">partition_id</strong> is not passed, <strong id="dis_02_0018__b208961319165814">partition_key</strong> will be used.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dis_02_0018__section17896191916581"><h4 class="sectiontitle">Response Parameters</h4><p id="dis_02_0018__p178965199585"><strong id="dis_02_0018__b48961019125818">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0018__response_PutRecordsResult" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="dis_02_0018__row2089719195582"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="dis_02_0018__p889871915583">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="dis_02_0018__p158991919195817">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="dis_02_0018__p168991419125810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0018__row7897161955811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0018__p148999191583">failed_record_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0018__p16900719195810">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0018__p1790017191586">Number of data records that fail to be uploaded.</p>
</td>
</tr>
<tr id="dis_02_0018__row68971219115819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="dis_02_0018__p1790012198586">records</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="dis_02_0018__p129011719125817">Array of <a href="#dis_02_0018__response_PutRecordsResultEntry">PutRecordsResultEntry</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="dis_02_0018__p99012197586">List of upload results.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dis_02_0018__response_PutRecordsResultEntry"></a><a name="response_PutRecordsResultEntry"></a><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0018__response_PutRecordsResultEntry" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PutRecordsResultEntry</caption><thead align="left"><tr id="dis_02_0018__row990241918585"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="dis_02_0018__p19903119195816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="dis_02_0018__p19904181925814">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="dis_02_0018__p19041219135819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0018__row19022197587"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0018__p10904121965812">partition_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0018__p8905181945812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0018__p189051419155815">ID of the partition to which data is uploaded.</p>
</td>
</tr>
<tr id="dis_02_0018__row19902121915587"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0018__p79053194583">sequence_number</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0018__p1190661995811">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0018__p1790781935815">Sequence number of the data to be uploaded. A sequence number is a unique identifier for each record. DIS automatically allocates a sequence number the data producer calls the PutRecords operation to add data to the DIS stream. Sequence number of the same partition key usually changes with time. A longer interval between PutRecords requests results in a larger sequence number.</p>
</td>
</tr>
<tr id="dis_02_0018__row1390215196583"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0018__p19907151945811">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0018__p190814192588">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0018__p9908719115812">Error code.</p>
</td>
</tr>
<tr id="dis_02_0018__row12902111995816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dis_02_0018__p1590913192587">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dis_02_0018__p4910101945816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dis_02_0018__p8910151925816">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dis_02_0018__section791051916588"><h4 class="sectiontitle">Example Requests</h4><p id="dis_02_0018__p11911121955814">Uploading Data</p>
<pre class="screen" id="dis_02_0018__screen591216199586">POST https://{Endpoint}/v2/{project_id}/records
{
"stream_name" : "newstream",
"records" : [ {
"data" : "MTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTE="
} ]
}</pre>
</div>
<div class="section" id="dis_02_0018__section1191419195582"><h4 class="sectiontitle">Example Responses</h4><p id="dis_02_0018__p12914171912585">None</p>
</div>
<div class="section" id="dis_02_0018__section1391451915589"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dis_02_0018__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="dis_02_0018__row139153197584"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="dis_02_0018__p39151319145818">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="dis_02_0018__p691618198586">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dis_02_0018__row1915151920589"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="dis_02_0018__p691621915589">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="dis_02_0018__p4916141975818">Normal response.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dis_02_0018__section12917111916585"><h4 class="sectiontitle">Error Codes</h4><p id="dis_02_0018__p16917191945817">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Data Management</a></div>
</div>
</div>
View Git Blame Copy Permalink