All Products
Search
Document Center

ApsaraDB RDS:DescribeInstanceAuthInfo

Last Updated:Jan 08, 2026

Queries the authentication information about an RDS Supabase instance.

Operation description

Supported database engine

RDS PostgreSQL

References

RDS Supabase

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rdsai:DescribeInstanceAuthInfoget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The operation that you want to perform. Set the value to DescribeInstanceAuthInfo.

cn-beijing
InstanceNamestringNo

The region ID.

ra-supabase-8moov5lxba****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

87249A6F-xxx-804C-E1E0AD1FAD90
JwtSecretstring

The JWT key.

i5o1XAp4sR*****oyOb3O
ApiKeysobject

The API keys.

AnonKeystring

The ANON_KEY of Supabase.

eyxxxJ9.ey****
ServiceKeystring

The SERVICE_ROLE_KEY of Supabase.

eyxxxJ9.ey****KfQ.DaYxxxt4Q
ConfigListarray<object>

The authentication configurations.

configListobject

The authentication configuration.

Namestring

The name of the configuration item. Valid values:

  • GOTRUE_EXTERNAL_EMAIL_ENABLED: Enables authentication via external email addresses.
  • GOTRUE_SITE_URL: the URL that is displayed in the emails sent from the instance.
  • GOTRUE_SMTP_PORT: the port of the SMTP service provider.
  • GOTRUE_SMTP_SENDER_NAME: the name of the sender of the email.
  • GOTRUE_SMTP_USER: the username of the SMTP service provider.
  • GOTRUE_SMTP_PASS: the key of the SMTP service provider.
  • GOTRUE_SMTP_ADMIN_EMAIL: the email address of the SMTP service provider.
  • GOTRUE_SMTP_HOST: The host address of the SMTP service 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 verification code length of the one-time password (OTP). The value must be an integer greater than or equal to 6.
GOTRUE_SITE_URL
Valuestring

The value of the configuration item.

http://8.152. XXX.XXX
InstanceNamestring

The ID of the RDS Supabase instance.

ra-supabase-8moov5lxba****

Examples

Sample success responses

JSONformat

{
  "RequestId": "87249A6F-xxx-804C-E1E0AD1FAD90",
  "JwtSecret": "i5o1XAp4sR*****oyOb3O",
  "ApiKeys": {
    "AnonKey": "eyxxxJ9.ey****",
    "ServiceKey": "eyxxxJ9.ey****KfQ.DaYxxxt4Q"
  },
  "ConfigList": [
    {
      "Name": "GOTRUE_SITE_URL",
      "Value": "http://8.152. XXX.XXX"
    }
  ],
  "InstanceName": "ra-supabase-8moov5lxba****\n"
}

Error codes

HTTP status codeError codeError messageDescription
400IncorrectInstanceStateCurrent instance status does not support this operation.The operation is not supported in the current instance state.
400InvalidGroupNameSpecified group name is not valid.Invalid group name
400InvalidParameterThe provided parameter is invalid.Invalid parameter.
400MasterInstanceNotExistMaster instance does not exist.The primary instance does not exist.
403InsufficientResourceCapacityThere is not enough host resource inventory.Insufficient resources
404UserNotFoundUser does not exist.User does not exist.

For a list of error codes, visit the Service error codes.