SaveVirtualDatasourceDdl - 向虚拟数据源中添加ddl语句

更新时间:2025-03-12 12:52:37

向您当前指定的业务空间下指定的虚拟数据源实例中添加ddl语句,析言GBI云服务会将您的ddl语句解析成相关的表结构信息并进行维护。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
dataanalysisgbi:SaveVirtualDatasourceDdlnone
*全部资源
*

请求语法

POST /gbi/virtualDatasource/addDdl2VirtualInstance HTTP/1.1

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
workspaceIdstring

当前请求所使用的百炼业务空间 id

llm-2v3934xtp49esw64
bodyobject

请求体参数

vdbIdstring

虚拟数据源实例 id

vdb-E0F693C8-9F72-5830-B81A-696C9D8EBBD1
ddlstring

create 类型数据库 ddl 语句,支持传入多条,多条之间请用换行符分割(“\n”)。

CREATE TABLE user (id int NOT NULL AUTO_INCREMENT comment 'ID',name varchar(10) NOT NULL comment '姓名', dept_id int NOT NULL comment '部门ID', salary bigint NULL DEFAULT 0 comment '薪水', PRIMARY KEY (`id`), KEY `idx_name` (`name`), KEY `d_id` (`dept_id`), CONSTRAINT `d_id` FOREIGN KEY (`dept_id`) REFERENCES `department` (`id`)) COMMENT='This is my table' ENGINE=InnoDB AUTO_INCREMENT=20094 DEFAULT CHARSET=utf8 ;

返回参数

名称类型描述示例值
名称类型描述示例值
object

Result

dataany

返回信息

true
errorMsgstring

错误描述信息

NoAuth
codestring

错误码

NoAuth
successboolean

true 接口调用成功,false 接口调用失败

true
requestIdstring

请求 id,每次请求都是唯一值,便于后续排查问题

72ABCA5B-1E93-55D3-8A61-6D8A03CC5C8B

示例

正常返回示例

JSON格式

{
  "data": "true",
  "errorMsg": "NoAuth",
  "code": "NoAuth",
  "success": true,
  "requestId": "72ABCA5B-1E93-55D3-8A61-6D8A03CC5C8B"
}

错误码

HTTP status code错误码错误信息描述
HTTP status code错误码错误信息描述
401NoAuthBad Request: Workspace.Illegal.Auth.当前所使用的账号无所指定业务空间的权限
401Internal.ErrorBad Request: Internal Error.内部错误,请联系客服人员排查

访问错误中心查看更多错误码。

  • 本页导读 (1)
  • 调试
  • 授权信息
  • 请求语法
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
AI助理

点击开启售前

在线咨询服务

你好,我是AI助理

可以解答问题、推荐解决方案等