AI 助理
文档备案控制台
官方文档
首页

DescribeInstanceAuthInfo - 查询RDS AI应用实例认证信息

更新时间：
复制 MD 格式
产品详情
我的收藏

该接口用于查询RDS AI应用实例的认证信息。

接口说明

适用引擎

RDS PostgreSQL

相关功能文档

RDS Supabase

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

rdsai:DescribeInstanceAuthInfo

get

*全部资源

*

 无 无

请求语法

GET  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值
RegionId

string

否

地域。

cn-beijing
InstanceName

string

否

AI 应用的实例 ID。

ra-supabase-8moov5lxba****
BranchName

string

否

返回参数

名称

类型

描述

示例值

object

返回参数详情。

RequestId

string

请求 ID。

FE9C65D7-930F-57A5-A207-8C396329241C
JwtSecret

string

JWT 密钥。

g7jgepleljS8nxAwsOd2EDWkBWi7JcU1m2Gj****
ApiKeys

object

API Keys。

AnonKey

string

Supabase 的 ANON_KEY。

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJhbm9uIiwiaWF0IjoxNzU1Nzg1ODc1LCJleHAiOjEzMjY2NDI1ODc1fQ.EGNFdeWRZBsdB051EzQsBwvDJveC9IMEXWUCDLX****
ServiceKey

string

Supabase 的 SERVICE_ROLE_KEY。

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUz****J9.eyJpc3MiOiJzdXBhYmFzZSIsInJvbGUiOiJzZXJ2aWNlX3JvbGUiLCJpYXQiOjE3NTU3ODU4NzUsImV4cCI6MTMyNjY0MjU4NzV9.oJt4UF8cpSDOvjW39IM4fLp2750rEvxFnkNqcVM****
E2bApiKey

string

ConfigList

array<object>

认证信息列表。

object

认证信息配置。

Name

string

配置项名称。 取值：

  • GOTRUE_EXTERNAL_EMAIL_ENABLED：允许外部邮箱。

  • GOTRUE_SITE_URL：AI 应用发送邮件时显示的网站 URL。

  • GOTRUE_SMTP_PORT：SMTP 服务商的端口。

  • GOTRUE_SMTP_SENDER_NAME：邮件发送者的名称。

  • GOTRUE_SMTP_USER：SMTP 服务商的用户名。

  • GOTRUE_SMTP_PASS：SMTP 服务商的密钥。

  • GOTRUE_SMTP_ADMIN_EMAIL：SMTP 服务商的邮件地址。

  • GOTRUE_SMTP_HOST：SMTP 服务商的主机地址（Host）。

  • GOTRUE_MAILER_AUTOCONFIRM：是否开启自动确认。

  • GOTRUE_MAILER_OTP_EXP：一次性密码（OTP）的有效期限。单位为秒。

  • GOTRUE_MAILER_OTP_LENGTH：一次性密码（OTP）的验证码长度。取值为大于等于 6 的整数。

GOTRUE_SITE_URL
Value

string

配置项的值。

http://8.152. XXX.XXX
InstanceName

string

AI 应用的实例 ID。

ra-supabase-8moov5lxba****

BranchName

string

示例

正常返回示例

JSON格式

{
  "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": ""
}

错误码

HTTP status code

错误码

错误信息

描述
400 IncorrectInstanceState Current instance status does not support this operation. 当前实例状态不支持该操作
400 InvalidGroupName Specified group name is not valid. 分组名称无效
400 InvalidParameter The provided parameter is invalid. 无效的参数。
400 MasterInstanceNotExist Master instance does not exist. 主实例不存在。
403 InsufficientResourceCapacity There is not enough host resource inventory. 资源不足
404 UserNotFound User does not exist. 用户不存在。

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

变更历史

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

上一篇：DescribeInstanceEndpoints - 查询RDS AI应用实例连接地址信息下一篇：ModifyInstanceAuthConfig - 修改RDS AI应用实例认证信息配置