下载数据
功能介绍
本接口用于从DIS通道中下载数据。
URI
GET /v2/{project_id}/records
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
partition-cursor |
是 |
String |
数据游标，需要先通过获取数据游标的接口获取。 取值范围：1~512个字符。 说明： 数据游标有效期为5分钟。 |
max_fetch_bytes |
否 |
Integer |
每个请求获取记录的最大字节数。 注意： 该值如果小于分区中单条记录的大小，会导致一直无法获取到记录。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
records |
Array of Record objects |
下载的记录列表。 |
next_partition_cursor |
String |
下一个迭代器。 说明： 数据游标有效期为5分钟。 |
参数 |
参数类型 |
描述 |
|---|---|---|
partition_key |
String |
用户上传数据时设置的partition_key。 说明： 上传数据时，如果传了partition_key参数，则下载数据时可返回此参数。如果上传数据时，未传partition_key参数，而是传入partition_id，则不返回partition_key。 |
sequence_number |
String |
该条数据的序列号。 |
data |
String |
下载的数据。 下载的数据为序列化之后的二进制数据（Base64编码后的字符串）。 比如下载数据接口返回的数据是“ZGF0YQ==”，“ZGF0YQ==”经过Base64解码之后是“data”。 |
timestamp |
Long |
记录写入DIS的时间戳。 |
timestamp_type |
String |
时间戳类型。
缺省值：CreateTime |
请求示例
下载数据
GET https://{Endpoint}/v2/{project_id}/records
响应示例
状态码： 200
正常返回
{
"records" : [ {
"partition_key" : "0",
"sequence_number" : "485",
"data" : "MTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTEx",
"timestamp" : 1527577402541,
"timestamp_type" : "CreateTime"
} ],
"next_partition_cursor" : "eyJpdGVyR2VuVGltZSI6MTQ5MDk1MDE1Nzc0NywiU3RyZWFtTmFtZSI6IjY2MCIsIlNoYXJkSWQiOiIwIiwiU2hhcmRJdGVyYXRvclR5cGUiOiJBVF9TRVFVRU5DRV9OVU1CRVIiLCJTdGFydGluZ1NlcXVlbmNlTnVtYmVyIjoiMjIiLCJUaW1lU3RhbXAiOjB9"
}
状态码
状态码 |
描述 |
|---|---|
200 |
正常返回 |
错误码
请参见错误码。
