实例操作
更新时间：2025-08-21
新建实例
描述
创建一个实例，要求名称不能和同Region内现有任何一个实例重名，限制字符个数3-255，满足正则：[a-zA-Z_][a-za-z0-9\_]{2,254}。 实例名称不能包含 [‘baidu’, ‘bidu’, ‘bce’, ‘bts’] 这几个单词，不能以‘__’（两个下划线）开头。
请求参数
| 参数名称 | 是否必须 | 参数类型 | 说明 |
|---|---|---|---|
| storageType | 否 | String | 该实例下表的默认存储类型，仅支持HighPerformance和CommonPerformance两种。若创建表时未指定存储类型，则默认使用所属实例的表存储类型 |
返回参数
无
示例
Plain Text
1let Client = require('@baiducloud/sdk').BtsClient;
2let myClient = new Client.BtsClient(config);
3
4let createInstanceRequest = new Client.CreateInstanceRequest();
5createInstanceRequest.storageType = 'HighPerformance';
6
7myClient.createInstance('{instanceName}', createInstanceRequest)
8 .then(response => console.log(response)) // 成功
9 .catch(error => console.error(error)); // 失败删除实例
描述
删除一个实例，要求实例下不存在任何表，否则删除失败。删除实例是一个同步操作过程，一旦返回成功，实例将不复存在。
请求参数
无
返回参数
无
示例
Plain Text
1let Client = require('@baiducloud/sdk').BtsClient;
2let myClient = new Client.BtsClient(config);
3
4myClient.dropInstance('{instanceName}')
5 .then(response => console.log(response)) // 成功
6 .catch(error => console.error(error)); // 失败列举实例
描述
列出账户一个Region内创建的所有实例。
请求参数
无
返回参数
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| instances | Array | 实例列表 |
| +id | String | 实例 ID |
| +name | String | 实例名称 |
| +region | String | 所属百度智能云Region |
| +state | String | 实例当前状态，目前只有Normal状态： - Normal：instance处于正常状态 |
| +createTime | String | 实例创建的UTC时间 |
| +storageType | String | 该实例下表的默认存储类型 |
示例
Plain Text
1let Client = require('@baiducloud/sdk').BtsClient;
2let myClient = new Client.BtsClient(config);
3
4myClient.listInstances()
5 .then(response => console.log(response)) // 成功
6 .catch(error => console.error(error)); // 失败显示实例信息
描述
显示指定实例信息。
请求参数
无
返回参数
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| id | String | 实例 ID |
| name | String | 实例名称 |
| region | String | 所属百度智能云Region |
| state | String | 实例当前状态，目前只有Normal状态： - Normal：instance处于正常状态 |
| createTime | String | 实例创建的UTC时间 |
| storageType | String | 该实例下表的默认存储类型 |
示例
Plain Text
1let Client = require('@baiducloud/sdk').BtsClient;
2let myClient = new Client.BtsClient(config);
3
4myClient.showInstance('{instanceName}')
5 .then(response => console.log(response)) // 成功
6 .catch(error => console.error(error)); // 失败