CreateAgenticSqlExecuteCredential - 创建 SQL 执行临时凭证-数据管理 DMS-阿里云帮助中心

接口说明

凭证用于通过数据网关（OneQuery）执行 SQL，可限定到实例级别或数据库级别。凭证固定属性：

有效期：创建后 10 分钟
最大连接次数：500 次

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:CreateAgenticSqlExecuteCredential

create

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
DatabaseUuid	string	否	数据库 UUID。传入后凭证限定到该数据库，可调用 ListDatabases 获取。	6c4e8a2b-xxxx-xxxx-xxxx-0f1d2e3c4b5a
CatalogUuid	string	否	实例 UUID。	9f8e7d6c-xxxx-xxxx-xxxx-1a2b3c4d5e6f
CatalogName	string	否	实例名称。	rm-bp1xxxxxxxx
QualifiedName	string	否	数据库全限定名。需与 CatalogUuid 或 CatalogName 配合使用。 MySQL 数据库：与库名相同。 PostgreSQL 数据库等带 schema 的类型：database.schema。	test_db

需要至少传入 DatabaseUuid、CatalogUuid、CatalogName 中的一个。不同入参组合可指定不同的凭证级别：

DatabaseUuid：凭证为数据库级别。若同时传入 CatalogUuid / CatalogName / QualifiedName，则必须与该数据库的实际信息一致，否则报错。
(CatalogUuid 或 CatalogName) + QualifiedName：凭证为数据库级别。在指定实例下按 QualifiedName 查找数据库。CatalogUuid 与 CatalogName 同时传入时必须一致。
CatalogUuid 或 CatalogName：凭证为实例级别，不限定数据库。CatalogUuid 与 CatalogName 同时传入时必须一致。

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	34E01EDD-6A16-4CF0-9541-C644D1BE01AA
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
ErrorMessage	string	调用失败时，返回的错误信息。	UnknownError
ErrorCode	string	错误码。	INVALID_PARAMETER
Data	object	临时凭证信息。
AccessKey	string	凭证 AccessKey。	ak_xxxxxxxx
AccessSecret	string	凭证 AccessSecret，仅在创建时返回一次，请妥善保存。	xxxxxxxx
ExpireTime	string	凭证过期时间，格式：yyyy-MM-dd HH:mm:ss。	2026-10-13 12:00:00
MaxConnectTimes	integer	凭证支持的总连接次数。	500
CatalogUuid	string	实例 UUID。	9f8e7d6c-xxxx-xxxx-xxxx-1a2b3c4d5e6f
CatalogName	string	实例名称。	rm-bp1xxxxxxxx
DatabaseUuid	string	数据库 UUID。如果凭证为实例级别，值为空。	6c4e8a2b-xxxx-xxxx-xxxx-0f1d2e3c4b5a
QualifiedName	string	数据库全限定名。凭证为实例级别时，值为空。	test_db

示例

正常返回示例

JSON格式

{
  "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "INVALID_PARAMETER",
  "Data": {
    "AccessKey": "ak_xxxxxxxx",
    "AccessSecret": "xxxxxxxx",
    "ExpireTime": "2026-10-13 12:00:00",
    "MaxConnectTimes": 500,
    "CatalogUuid": "9f8e7d6c-xxxx-xxxx-xxxx-1a2b3c4d5e6f",
    "CatalogName": "rm-bp1xxxxxxxx",
    "DatabaseUuid": "6c4e8a2b-xxxx-xxxx-xxxx-0f1d2e3c4b5a",
    "QualifiedName": "test_db"
  }
}

错误码

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

变更历史

更多信息，参考变更详情。