Use DescribeInstanceAuthInfo to query authentication information for RDS Supabase - ApsaraDB RDS - Alibaba Cloud - ApsaraDB RDS

Queries the authentication information of an RDS AI application instance.

Operation description

Applicable engine

RDS PostgreSQL

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

rdsai:DescribeInstanceAuthInfo

get

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-beijing
InstanceName	string	No	The instance ID of the AI application.	ra-supabase-8moov5lxba****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329241C
JwtSecret	string	The JWT secret.	g7jgepleljS8nxAwsOd2EDWkBWi7JcU1m2Gj****
ApiKeys	object	API Keys。
AnonKey	string	The ANON_KEY of Supabase.	eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz**J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJhbm9uIiwiaWF0IjoxNzU1Nzg1ODc1LCJleHAiOjEzMjY2NDI1ODc1fQ.EGNFdeWRZBsdB051EzQsBwvDJveC9IMEXWUCDLX**
ServiceKey	string	The SERVICE_ROLE_KEY of Supabase.	eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz**J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJzZXJ2aWNlX3JvbGUiLCJpYXQiOjE3NTU3ODU4NzUsImV4cCI6MTMyNjY0MjU4NzV9.oJt4UF8cpSDOvjW39IM4fLp2750rEvxFnkNqcVM**
E2bApiKey	string
ConfigList	array<object>	The list of authentication configurations.
	object	The authentication configuration.
Name	string	The name of the configuration item. Valid values: GOTRUE_EXTERNAL_EMAIL_ENABLED: external email enabled. GOTRUE_SITE_URL: the website URL displayed when the AI application sends emails. GOTRUE_SMTP_PORT: the port of the SMTP provider. GOTRUE_SMTP_SENDER_NAME: the name of the email sender. GOTRUE_SMTP_USER: the username of the SMTP provider. GOTRUE_SMTP_PASS: the secret key of the SMTP provider. GOTRUE_SMTP_ADMIN_EMAIL: the email address of the SMTP provider. GOTRUE_SMTP_HOST: the host address of the SMTP provider. GOTRUE_MAILER_AUTOCONFIRM: specifies whether to enable automatic confirmation. GOTRUE_MAILER_OTP_EXP: the validity period of the one-time password (OTP). Unit: seconds. GOTRUE_MAILER_OTP_LENGTH: the length of the one-time password (OTP) verification code. The value must be an integer greater than or equal to 6.	GOTRUE_SITE_URL
Value	string	The value of the configuration item.	http://8.152. XXX.XXX
InstanceName	string	The instance ID of the AI application.	ra-supabase-8moov5lxba****
BranchName	string

Examples

Success response

JSON format

{
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329241C",
  "JwtSecret": "g7jgepleljS8nxAwsOd2EDWkBWi7JcU1m2Gj****",
  "ApiKeys": {
    "AnonKey": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJhbm9uIiwiaWF0IjoxNzU1Nzg1ODc1LCJleHAiOjEzMjY2NDI1ODc1fQ.EGNFdeWRZBsdB051EzQsBwvDJveC9IMEXWUCDLX****",
    "ServiceKey": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJzZXJ2aWNlX3JvbGUiLCJpYXQiOjE3NTU3ODU4NzUsImV4cCI6MTMyNjY0MjU4NzV9.oJt4UF8cpSDOvjW39IM4fLp2750rEvxFnkNqcVM****",
    "E2bApiKey": ""
  },
  "ConfigList": [
    {
      "Name": "GOTRUE_SITE_URL",
      "Value": "http://8.152. XXX.XXX"
    }
  ],
  "InstanceName": "ra-supabase-8moov5lxba****\n",
  "BranchName": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectInstanceState	Current instance status does not support this operation.	The operation is not supported in the current instance state.
400	InvalidGroupName	Specified group name is not valid.	Invalid group name
400	InvalidParameter	The provided parameter is invalid.	Invalid parameter.
400	MasterInstanceNotExist	Master instance does not exist.	The primary instance does not exist.
403	InsufficientResourceCapacity	There is not enough host resource inventory.	Insufficient resources
404	UserNotFound	User does not exist.	User does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

ApsaraDB RDS:DescribeInstanceAuthInfo