获取SQL实例信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:GetSqlInstance | Read |
|
| 无 |
请求语法
GET /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例 id | ha-cn-pl32rf0**** |
| database | string | 是 | 数据库名称 | general |
| sqlInstanceId | long | 是 | sql 实例 id | 5978 |
| version | long | 否 | 实例版本 | 1 |
返回参数
示例
正常返回示例
JSON格式
{
"requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
"result": {
"gmtCreate": "1719220182844",
"gmtModified": "1719221186114",
"instanceId": 0,
"version": 1,
"comment": "init version",
"relatedTemplateId": 1,
"content": "select * from test",
"kvpairs": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
"dynamicParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
"templateParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
"staticParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
"combineParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}"
}
}错误码
访问错误中心查看更多错误码。