时序表操作
更新时间：2025-08-21
创建bucket
描述
在指定database下创建一个bucket，bucket name限制字符个数1-255，满足正则：[a-zA-Z_][a-za-z0-9\_]{0,254}，以字母或下划线开头。
创建bucket是一个异步流程，提交创建请求成功后，用户需要调用获取bucket状态的API接口，当bucket状态为Normal后方可使用此bucket。
请求
| uri | /api/v2/buckets | |
|---|---|---|
| Verb | POST | |
| Body | name(required): bucket名称 retentionRules(required)：Array，实际只支持1个 >82800，数据的保留时间(秒)，默认值是259200 |
curl --request POST "http://localhost:8086/api/v2/buckets \ --header "Authorization: IAM认证串" \ --header "DataBase: database名称" \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --data '{ "name": "air_sensor", "retentionRules": [ { "type": "expire", "everySeconds": 2592000, }], "storageType": "CommonPerformance", }' |
请求参数
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| name | string | 是 | bucket name |
| retentionRules | list | 是 | 该bucket的retentionRules |
| +type | string | 否 | 默认为expire |
| +everySeconds | int | 是 | 数据生存时间，单位为秒 |
| storageType | string | 否 | bucket存储介质，默认同database |
响应参数
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| id | string | bucket id |
| name | string | bucket name |
| createdAt | string | 创建bucket的UTC时间 |
| retentionRules | list | 该bucket的retentionRules |
| +type | string | 默认为expire |
| +everySeconds | int | 数据生存时间，单位为秒 |
错误码
| http_code | code | 说明 |
|---|---|---|
| 201 | - | 请求被接受，后端异步处理创建bucket，将在一分钟内创建成功 |
| 400 | invalid | Bad Request，请求参数错误等，message按具体错误来定 |
| 401 | unauthorized | 鉴权失败，在此表示IAM认证鉴权失败 |
| 403 | AccessDenied | 请求受限，message按具体错误来定 |
| 500 | internal error | 服务器内部错误，message按具体错误来定 |
请求示例
Plain Text
1POST /api/v2/buckets HTTP/1.1
2HOST: bts.bd.baidubce.com
3Authorization: bce-auth-v1/{table-access-key}/2024-05-24T13:41:13Z/1800/x-bce-date/{signature}
4Content-Type: application/json
5Content-Length: {payloadSizeBytes}
6x-bce-date: 2024-05-24T13:41:13Z
7
8{
9 "name": "test1",
10 "retentionRules": [{
11 "type": "expire",
12 "everySeconds": 86400
13 }],
14 "storageType": "CommonPerformance"
15}响应示例
Plain Text
1HTTP/1.1 201 Created
2Date: Sat, 18 Aug 2024 18:18:18 GMT
3Content-Type: application/json; charset=utf-8
4Content-Length: {payloadSizeBytes}
5x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
6
7{
8 "id": "a387d62200000048",
9 "name": "test1",
10 "retentionRules": [{
11 "type": "expire",
12 "everySeconds": 86400
13 }],
14 "createAt": "2024-08-18T06:52:43Z",
15 "updateAt": "2024-08-18T06:52:43Z"
16}更新bucket
描述
更新bucket的数据生存时间。
请求
| uri | /api/v2/buckets/{bucketID} | |
|---|---|---|
| Verb | Patch | |
| Body | retentionRules(required)：Array[object]保留策略 everySeconds(required)：integer > 82800，默认值是259200；数据的保留时间(秒) type："expire"，目前只支持此类型，表示数据过期删除，用户可不填 |
curl --request PATCH "http://localhost:8086/api/v2/buckets/BUCKET_ID \ --header "Authorization: IAM认证串" \ --header "DataBase: database名称" \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --data '{ "retentionRules": [ { "type": "expire", "everySeconds": 2592000 }] }' |
请求参数
| 参数名称 | 是否必须 | 参数类型 | 说明 |
|---|---|---|---|
| name | 是 | string | bucket name |
| retentionRules | 是 | list | 数据生存策略，该数组只能有一个元素 |
| +type | 否 | string | 当前只有一个值为expire，默认为expire |
| +everySeconds | 是 | int | 数据ttl，单位为秒，最小为82800 |
响应参数
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| id | string | bucket id |
| name | string | bucket name |
| createdAt | string | 创建bucket的UTC时间 |
| updatedAt | string | 更新bucket的UTC时间 |
| retentionRules | list | 该bucket的retentionRules |
| +type | string | 默认为expire |
| +everySeconds | int | 数据生存时间，单位为秒 |
错误码
| http_code | code | 说明 |
|---|---|---|
| 201 | - | 请求被接受，后端异步处理更新bucket，将在一分钟内更新成功 |
| 400 | invalid | Bad Request，请求参数错误等，message按具体错误来定 |
| 401 | unauthorized | 鉴权失败，在此表示IAM认证鉴权失败 |
| 403 | AccessDenied | 请求受限，message按具体错误来定 |
| 404 | not found | bucket不存在 |
| 500 | internal error | 服务器内部错误，message按具体错误来定 |
请求示例
Plain Text
1PATCH /api/v2/buckets/a387d62200000048 HTTP/1.1
2HOST: bts.bd.baidubce.com
3Authorization: bce-auth-v1/{table-access-key}/2024-05-24T13:41:13Z/1800/x-bce-date/{signature}
4Content-Type: application/json
5Content-Length: {payloadSizeBytes}
6x-bce-date: 2024-05-24T13:41:13Z
7
8{
9 "retentionRules": [{
10 "type": "expire",
11 "everySeconds": 864000
12 }]
13}响应示例
Plain Text
1HTTP/1.1 200 OK
2Date: Sat, 18 Aug 2024 18:18:18 GMT
3Content-Type: application/json; charset=utf-8
4Content-Length: {payloadSizeBytes}
5x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
6
7{
8 "retentionRules": [{
9 "type": "expire",
10 "everySeconds": 864000
11 }]
12}删除bucket
描述
删除指定的bucket。
请求
| uri | /api/v2/buckets/{bucketID} |
|---|---|
| Verb | DELETE |
| Body | 无 |
| 示例 | curl --request DELETE "http://localhost:8086/api/v2/buckets/BUCKET_ID" \ --header "Authorization: IAM认证串" \ --header "DataBase: database名称" |
请求参数
无
响应参数
无
错误码
| http_code | code | 说明 |
|---|---|---|
| 204 | - | 请求被接受，后端异步处理删除bucket，将在一分钟内删除成功 |
| 400 | invalid | Bad Request，请求参数错误等，message按具体错误来定 |
| 401 | unauthorized | 鉴权失败，在此表示IAM认证鉴权失败 |
| 403 | AccessDenied | 请求受限，message按具体错误来定 |
| 404 | not found | bucket不存在 |
| 500 | internal error | 服务器内部错误，message按具体错误来定 |
请求示例
Plain Text
1DELETE /api/v2/buckets/a387d62200000048 HTTP/1.1
2HOST: bts.bd.baidubce.com
3Authorization: bce-auth-v1/{table-access-key}/2024-05-24T13:41:13Z/1800/x-bce-date/{signature}
4Content-Type: application/json
5Content-Length: {payloadSizeBytes}
6x-bce-date: 2024-05-24T13:41:13Z响应示例
Plain Text
1HTTP/1.1 204 No Content
2Date: Sat, 18 Aug 2024 18:18:18 GMT
3Content-Type: application/json; charset=utf-8
4Content-Length: {payloadSizeBytes}
5x-bce-request-id: 7869616F-7A68-6977-656E-406261696475查询bucket
描述
查询指定bucket信息。
请求
| uri | /api/v2/buckets/{bucketID} |
|---|---|
| Verb | GET |
| 示例 | curl --request GET "http://localhost:8086/api/v2/buckets/BUCKET_ID" \ --header "Authorization: IAM认证串" \ --header "DataBase: database名称" |
请求参数
无
响应参数
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| id | string | bucket id |
| name | string | bucket name |
| createdAt | string | 创建bucket的UTC时间 |
| updatedAt | string | 更新bucket的UTC时间 |
| retentionRules | list | 该bucket的retentionRules |
| +type | string | 默认为expire |
| +everySeconds | int | 数据生存时间，单位为秒 |
错误码
| http_code | code | 说明 |
|---|---|---|
| 201 | - | 请求被接受，后端异步处理更新bucket，将在一分钟内更新成功 |
| 400 | invalid | Bad Request，请求参数错误等，message按具体错误来定 |
| 401 | unauthorized | 鉴权失败，在此表示IAM认证鉴权失败 |
| 403 | AccessDenied | 请求受限，message按具体错误来定 |
| 404 | not found | bucket不存在 |
| 500 | internal error | 服务器内部错误，message按具体错误来定 |
请求示例
Plain Text
1GET /api/v2/buckets/a387d62200000048 HTTP/1.1
2HOST: bts.bd.baidubce.com
3Authorization: bce-auth-v1/{table-access-key}/2024-05-24T13:41:13Z/1800/x-bce-date/{signature}
4Content-Type: application/json
5Content-Length: {payloadSizeBytes}
6x-bce-date: 2024-05-24T13:41:13Z响应示例
Plain Text
1HTTP/1.1 200 OK
2Date: Sat, 18 Aug 2024 18:18:18 GMT
3Content-Type: application/json; charset=utf-8
4Content-Length: {payloadSizeBytes}
5x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
6
7{
8 "id": "a387d62200000048",
9 "name": "test1",
10 "retentionRules": [{
11 "type": "expire",
12 "everySeconds": 864000
13 }],
14 "createAt": "2024-09-05T06:52:43Z",
15 "updateAt": "2024-09-05T07:04:10Z"
16}列举bucket
描述
列举指定database中所有bucket。
请求
| uri | /api/v2/buckets |
|---|---|
| Verb | GET |
| Body | 无 |
| 示例 | curl --request GET "http://localhost:8086/api/v2/buckets?name=_monitoring" \ --header "Authorization: IAM认证串" \ --header "DataBase: database名称" \ --header "Accept: application/json" |
请求参数
| 参数名称 | 是否必须 | 参数类型 | 说明 |
|---|---|---|---|
| id | 否 | string | 查询指定id的bucket |
| name | 否 | string | 查询指定name的bucket |
响应参数
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| buckets | list | bucket列表 |
| +id | string | bucket id |
| +name | string | bucket name |
| +createdAt | string | 创建bucket的UTC时间 |
| +updatedAt | string | 更新bucket的UTC时间 |
| +retentionRules | list | 该bucket的retentionRules |
| ++type | string | 默认为expire |
| ++everySeconds | int | 数据生存时间，单位为秒 |
错误码
| http_code | code | 说明 |
|---|---|---|
| 201 | - | 请求被接受，后端异步处理更新bucket，将在一分钟内更新成功 |
| 400 | invalid | Bad Request，请求参数错误等，message按具体错误来定 |
| 401 | unauthorized | 鉴权失败，在此表示IAM认证鉴权失败 |
| 403 | AccessDenied | 请求受限，message按具体错误来定 |
| 500 | internal error | 服务器内部错误，message按具体错误来定 |
请求示例
Plain Text
1GET /api/v2/buckets HTTP/1.1
2HOST: bts.bd.baidubce.com
3Authorization: bce-auth-v1/{table-access-key}/2024-05-24T13:41:13Z/1800/x-bce-date/{signature}
4Content-Type: application/json
5Content-Length: {payloadSizeBytes}
6x-bce-date: 2024-05-24T13:41:13Z响应示例
Plain Text
1HTTP/1.1 200 OK
2Date: Sat, 18 Aug 2024 18:18:18 GMT
3Content-Type: application/json; charset=utf-8
4Content-Length: {payloadSizeBytes}
5ETag: 3f80f-1b6-3e1cb03b
6x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
7
8{
9 "buckets": [{
10 "id": "a387d62200000048",
11 "name": "test1",
12 "retentionRules": [{
13 "type": "expire",
14 "everySeconds": 864000
15 }],
16 "createAt": "2024-09-05T06:52:43Z",
17 "updateAt": "2024-09-05T07:04:10Z"
18 }]
19}