实例操作接口
更新时间：2024-10-11
创建database
描述
创建一个database，要求名称不能和同Region内现有的Instance或database重名，限制字符个数3-255，满足正则：[a-zA-Z_][a-za-z0-9\_]{2,254}。 实例名称不能包含 [‘baidu’, ‘bidu’, ‘bce’, ‘bts’] 这几个单词，不能以‘__’（两个下划线）开头。
请求
| Verb | URI |
|---|---|
| PUT | /api/v2/database/{dbname} |
请求参数
| 参数名称 | 是否必须 | 参数类型 | 说明 |
|---|---|---|---|
| storageType | 否 | string | 该Instance下表的默认存储类型。 若创建表时未指定存储类型，则默认使用所属Instance的表存储类型。 |
响应参数
无
错误码
| http_code | code | 说明 |
|---|---|---|
| 201 | - | 创建成功 |
| 400 | invalid | Bad Request，请求参数错误等，message按具体错误来定 |
| 401 | unauthorized | 鉴权失败，在此表示IAM认证鉴权失败 |
| 409 | conflict | database/instance已存在 |
| 500 | internal error | 服务器内部错误，message按具体错误来定 |
请求示例
(1) 未设置 database 存储类型（默认使用高性能型存储类型）
PUT PUT /api/v2/database/ins1 HTTP/1.1
HOST: bts.bd.baidubce.com
Authorization: bce-auth-v1/{table-access-key}/2024-09-05T04:02:40Z/1800/x-bce-date/{signature}
Content-Type: application/json
Content-Length: {payloadSizeBytes}
x-bce-date: 2024-09-05T04:02:40Z(2) 设置 database 表格存储类型
PUT PUT /api/v2/database/ins1 HTTP/1.1
HOST: bts.bd.baidubce.com
Authorization: bce-auth-v1/{table-access-key}/2024-09-05T04:02:40Z/1800/x-bce-date/{signature}
Content-Type: application/json
Content-Length: {payloadSizeBytes}
x-bce-date: 2024-09-05T04:02:40Z
{"storageType": "CommonPerformance"}响应示例
HTTP/1.1 201 Created
Date: Thu, 05 Sep 2024 12:12:02 GMT
Content-Type: application/json; charset=utf-8
Content-Length: {payloadSizeBytes}
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
{}删除database
描述
删除一个database，要求实例下不存在任何bucket，否则删除失败。删除database是一个同步操作过程，一旦返回成功，实例将不复存在。
请求
| Verb | URI |
|---|---|
| DELETE | /api/v2/database/{dbname} |
请求参数
无
响应参数
无
错误码
| http_code | code | 说明 |
|---|---|---|
| 204 | - | database删除成功 |
| 400 | invalid | Bad Request，请求参数错误等，message按具体错误来定 |
| 401 | unauthorized | 鉴权失败，在此表示IAM认证鉴权失败 |
| 404 | not found | database不存在 |
| 500 | internal error | 服务器内部错误，message按具体错误来定 |
请求示例
DELETE /api/v2/database/ins1 HTTP/1.1
HOST: bts.bd.baidubce.com
Authorization: bce-auth-v1/{table-access-key}/2024-09-05T04:02:40Z/1800/x-bce-date/{signature}
Content-Type: application/json
Content-Length: {payloadSizeBytes}
x-bce-date: 2024-09-05T04:02:40Z响应示例
HTTP/1.1 200 OK
Date: Thu, 05 Sep 2024 12:12:02 GMT
Content-Type: application/json; charset=utf-8
Content-Length: {payloadSizeBytes}
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
{}查询database
描述
显示指定的database信息。
请求
| Verb | URI |
|---|---|
| GET | /api/v2/database/{dbname} |
请求参数
无
响应参数
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| id | string | database ID |
| name | string | database name |
| region | string | 所属百度智能云region |
| state | string | database当前状态，目前只有Normal状态： - Normal：instance处于正常状态 |
| createTime | string | database创建的UTC时间 |
| description | string | database的描述信息 |
错误码
| http_code | code | 说明 |
|---|---|---|
| 204 | - | database删除成功 |
| 400 | invalid | Bad Request，请求参数错误等，message按具体错误来定 |
| 401 | unauthorized | 鉴权失败，在此表示IAM认证鉴权失败 |
| 404 | not found | database不存在 |
| 500 | internal error | 服务器内部错误，message按具体错误来定 |
请求示例
GET /api/v2/database/test1 HTTP/1.1
HOST: bts.bd.baidubce.com
Authorization: bce-auth-v1/{table-access-key}/2024-05-24T13:41:13Z/1800/x-bce-date/{signature}
Content-Type: application/json
Content-Length: {payloadSizeBytes}
x-bce-date: 2024-05-24T13:41:13Z响应示例
HTTP/1.1 200 OK
Date: Sat, 18 Aug 2018 18:18:18 GMT
Content-Type: application/json; charset=utf-8
Content-Length: {payloadSizeBytes}
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
{
"id": "btsi-3D854DDD-AA5B-DCB5-778F-CC852EBCE8CC",
"name": "test1",
"region": "yq",
"state": "Normal",
"createTime": "2024-01-16T02:42:23Z"
}列举database
描述
列举账户一个Region内所有的database。
请求
| Verb | URI |
|---|---|
| GET | /api/v2/databases |
请求参数
无
响应参数
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| databases | list | database列表 |
| +id | string | database ID |
| +name | string | database name |
| +region | string | 所属百度智能云region |
| +state | string | database当前状态，目前只有Normal状态： - Normal：instance处于正常状态 |
| +createTime | string | database创建的UTC时间 |
| +storageType | string | 该database下bucket的默认存储类型 |
| +description | string | 描述信息 |
错误码
| http_code | code | 说明 |
|---|---|---|
| 200 | - | 请求成功 |
| 400 | invalid | Bad Request，请求参数错误等，message按具体错误来定 |
| 401 | unauthorized | 鉴权失败，在此表示IAM认证鉴权失败 |
| 500 | internal error | 服务器内部错误，message按具体错误来定 |
请求示例
GET /api/v2/databases HTTP/1.1
HOST: bts.bd.baidubce.com
Authorization: bce-auth-v1/{table-access-key}/2024-05-24T13:41:13Z/1800/x-bce-date/{signature}
Content-Type: application/json
Content-Length: {payloadSizeBytes}
x-bce-date: 2024-05-24T13:41:13Z响应示例
HTTP/1.1 200 OK
Date: Sat, 18 Aug 2024 18:18:18 GMT
Content-Type: application/json; charset=utf-8
Content-Length: {payloadSizeBytes}
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
{
"databases": [{
"id": "btsi-3D854DDD-AA5B-DCB5-778F-CC852EBCE8CC",
"name": "test1",
"region": "yq",
"state": "Normal",
"createTime": "2024-01-16T02:42:23Z"
}]
}