DescribeInstanceAuthInfo - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

RDS AI アプリケーションインスタンスの認証情報を照会します。

操作説明

対象エンジン

RDS PostgreSQL

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rdsai:DescribeInstanceAuthInfo

get

*All Resource

*

なし

リクエスト構文

GET  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	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 キー。
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 アプリケーションがメールを送信する際に表示される Web サイト 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 プロバイダーのホストアドレス。 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

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ	説明
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.	ユーザーが存在しません。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。

ApsaraDB RDS:DescribeInstanceAuthInfo