執行數據庫命令。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| mpserverless:RunDBCommand |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SpaceId | string | 是 | 服務空間 ID。 | ach41172-adba-4af1-b2e5-63fc5f56a649 |
| Body | string | 是 | 請求數據庫時的命令，格式為 JSON String。 包含兩個必須字段：
集合操作命令：
索引操作命令：
數據操作命令：
例如：
| {"command":"findOne","collection":"test_collection","query":{"name":"tome"}} |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "F75E60FA-7583-4E2E-AC14-6C608F89804",
"Result": "{\"_id\":\"5d107e5af957c439d505b95b\",\"age\":1,\"name\":\"aaaaa\",\"time\":1561362071732}",
"AffectedDocs": 1
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史
該接口功能較復雜，以下舉例說明部分使用方法，供參考：
獲取集合列表
params 入參：
{
"SpaceId": "mp-c68e6766-2bda-4263-916d-****",
"Body": "{\"command\":\"collections\"}"
}
data 結果：
{
"AffectedDocs":5,
"RequestId":"4CFE11BE-536C-58DD-****",
"Success":true,
"Result":"[\"album\",\"photo\",\"test\",\"users\",\"wallpaper\"]"
}
創建集合
params 入參：
{
"SpaceId": "mp-c68e6766-2bda-4263-916d-****",
"Body": "{\"command\":\"createCollection\", \"name\":\"mytable\"}"
}
data 結果：
{
"AffectedDocs":1,
"RequestId":"042ED29A-3148-5133-ABEA-****",
"Success":true,
"Result":"[\"mytable\"]"
}
創建索引
給集合 mytable 創建非唯一組合索引，按照 userId 升序、userName 降序。
params 入參：
{
"SpaceId": "mp-c68e6766-2bda-4263-916d-****",
"Body": "{\"command\":\"createIndex\", \"collection\":\"mytable\", \"field\":{\"userId\":1,\"userName\":-1}, \"options\":{\"name\":\"idx-userid-username\", \"unique\":false} }"
}
data 結果：
{
"AffectedDocs":0,
"RequestId":"C67E7C63-EB30-506E-BF28-****",
"Success":true,
"Result":"idx-userid-username"
}
獲取索引列表
params 入參：
{
"SpaceId": "mp-c68e6766-2bda-4263-916d-****",
"Body": "{\"command\":\"listIndexes\", \"collection\":\"mytable\"}"
}
data 結果：
{
"AffectedDocs": 2,
"RequestId": "8B8F315A-FBCA-560E-8C85-****",
"Success": true,
"Result": "[{\"v\":2,\"key\":{\"_id\":1},\"name\":\"_id_\",\"ns\":\"db_ALYEZT****_mp-c68e6766-2bda-4263-916d-****.mytable\"},{\"v\":2,\"key\":{\"userId\":1,\"userName\":-1},\"name\":\"idx-userid-username\",\"ns\":\"db_ALYEZT****_mp-c68e6766-2bda-4263-916d-****.mytable\"}]"
}
刪除索引
params 入參：
{
"SpaceId": "mp-c68e6766-2bda-4263-916d-****",
"Body": "{\"command\":\"dropIndex\", \"collection\":\"mytable\", \"indexName\":\"idx-userid-username\"}"
}
data 結果：
{
"AffectedDocs": 0,
"RequestId": "1EE343F7-9DE8-534C-AE12-****",
"Success": true
}
插入一條數據
params 入參：
{
"SpaceId": "mp-c68e6766-2bda-4263-916d-****",
"Body": "{\"command\":\"insertOne\", \"collection\":\"mytable\", \"doc\":{\"userId\":1, \"userName\":\"張三\"}}"
}
data 結果：
{
"AffectedDocs": 1,
"RequestId": "B1032DBA-51CF-5E47-91C5-****",
"Success": true,
"Result": "{\"insertedId\":\"636496e2f43e60aba4939f5f\",\"ok\":1,\"n\":1}"
}
查詢前十條數據
params 入參：
{
"SpaceId": "mp-c68e6766-2bda-4263-916d-****",
"Body": "{\"command\":\"find\", \"collection\":\"mytable\", \"query\":{}, \"options\":{\"skip\":0, \"limit\":10}}"
}
data 結果：
{
"AffectedDocs": 2,
"RequestId": "AB1F4B1C-F6E6-5E49-AB4B-****",
"Success": true,
"Result": "[{\"_id\":\"636496e2f43e60aba4939f5f\",\"userName\":\"張三\",\"userId\":1},{\"_id\":\"636496ef819ce88b66f34b6d\",\"userName\":\"李四\",\"userId\":2}]"
}