ExecuteMetaQuery - 执行元数据只读查询 - 云原生数据库 PolarDB

执行元数据查询

接口说明

删除指定数据库实例的自定义连接地址，关闭该域名的访问入口。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:ExecuteMetaQuery

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID	cn-hangzhou
DBInstanceName	string	是	主实例 ID。	pxsp-*********
Sql	string	是	需要执行的 SQL 语句。	show databases;
StorageInstId	string	否	数据节点(DN) 实例 ID	pxc-xdb-s-*
MaxResultRows	integer	否	本次最多返回的结果行数。缺省为 100，取值范围 1~1000；最终行数还会取代码硬上限、Biz DB 上限和 SQL 最外层 LIMIT 的最小值，连续取数请在 SQL 中自行分页。

返回参数

名称	类型	描述	示例值
	object
Message	string	接口额外返回信息，成功返回 success，错误返回对应错误码。	""
RequestId	string	Id of the request	A501A191-BD70-5E50-98A9-C2A486A82****
Success	boolean	请求是否成功。	true
Data	object	实例详情列表。
Columns	array	列名。
	string	列名。	BIGINT
Rows	array<object>	影响/返回行数。仅 CN 有该字段。
	object	影响/返回行数。仅 CN 有该字段。
RowCount	integer	总数据行数	97901
AppliedOffset	integer
AppliedRowLimit	integer
ReturnedRowCount	integer
HasMore	boolean
RecordsSizeBytes	integer
AccessDeniedDetail	object	访问被拒绝的详细原因。
AuthAction	string	说明如上。	xxx
AuthPrincipalType	string	说明如上。	222
NoPermissionType	string	NoPermissionType	ImplicitDeny
PolicyType	string	PolicyType	PRIORITY
EncodedDiagnosticMessage	string	诊断信息	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

示例

正常返回示例

JSON格式

{
  "Message": "\"\"",
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "Success": true,
  "Data": {
    "Columns": [
      "BIGINT"
    ],
    "Rows": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "RowCount": 97901,
    "AppliedOffset": 0,
    "AppliedRowLimit": 0,
    "ReturnedRowCount": 0,
    "HasMore": true,
    "RecordsSizeBytes": 0
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "PRIORITY",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

错误码

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

变更历史

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