ExecuteMetaQuery - PolarDB - Alibaba Cloud Documentation Center

Executes a metadata query.

Operation description

Deletes a custom endpoint of a specified database instance and disables access through the domain name.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardbx:ExecuteMetaQuery

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
DBInstanceName	string	Yes	The primary instance ID.	pxsp-*********
Sql	string	Yes	The SQL statement to execute.	show databases;
StorageInstId	string	No	The data node (DN) instance ID.	pxc-xdb-s-*
		No	The maximum number of rows to return. Default value: 100. Valid values: 1 to 1000. The actual number of returned rows is the minimum value among the code hard limit, the Biz DB limit, and the outermost LIMIT clause in the SQL statement. To retrieve data continuously, implement pagination in the SQL statement.

Response elements

Element	Type	Description	Example
	object
Message	string	The additional information returned by the operation. success is returned if the request is successful. Otherwise, an error code is returned.	""
RequestId	string	Id of the request	A501A191-BD70-5E50-98A9-C2A486A82****
Success	boolean	Indicates whether the request is successful.	true
Data	object	The list of instance details.
Columns	array	The column names.
	string	The column names.	BIGINT
Rows	array<object>	The number of affected or returned rows. This field is available only for compute nodes (CNs).
	object	The number of affected or returned rows. This field is available only for compute nodes (CNs).
RowCount	integer	The total number of data rows.	97901
AppliedOffset	integer
AppliedRowLimit	integer
ReturnedRowCount	integer
HasMore	boolean
RecordsSizeBytes	integer
AccessDeniedDetail	object	The details about the access denial.
AuthAction	string	The description is the same as above.	xxx
AuthPrincipalType	string	The description is the same as above.	222
NoPermissionType	string	NoPermissionType	ImplicitDeny
PolicyType	string	PolicyType	PRIORITY
EncodedDiagnosticMessage	string	The diagnostic information.	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "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": false,
    "RecordsSizeBytes": 0
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "PRIORITY",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.