ListDatabases - Hologres - Alibaba Cloud Documentation Center

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

hologram:ListDatabases

list

*All Resource

*

None

Request syntax

GET /api/v1/instances/{instanceId}/listDatabases HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The instance ID.	hgpostcn-cn-jfj3zckut008

Request parameters

Parameter	Type	Required	Description	Example
external	boolean	No	Specifies whether to list only foreign tables. If you set this parameter to `true`, only foreign tables are listed. If you set this parameter to `false` or do not specify it, all tables are listed.	false

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	0C4935F5-6217-569A-902F-931B2F3E28BA
DatabaseList	array<object>	The list of databases.
	object	The list of databases.
Name	string	The database name.	my_db
PermissionModel	string	The permission model. For more information, see Hologres permission models.	SPM
Privilege	string	The permission.	developer
External	boolean	Indicates whether the table is a foreign table. `true`: The table is a foreign table. `false`: The table is not a foreign table.	false
Success	string	Indicates whether the request was successful.	true
ErrorCode	string	The error code.	null
ErrorMessage	string	The error message.	null
HttpStatusCode	string	The HTTP status code.	200

Examples

Success response

JSON format

{
  "RequestId": "0C4935F5-6217-569A-902F-931B2F3E28BA",
  "DatabaseList": [
    {
      "Name": "my_db",
      "PermissionModel": "SPM",
      "Privilege": "developer",
      "External": false
    }
  ],
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.