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

ApsaraDB RDS インスタンスで作成されたアカウントに関する詳細を照会します。

操作説明

サポートされるデータベースエンジン

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:DescribeAccounts

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。 DescribeDBInstances 操作を呼び出して、インスタンス ID を照会できます。説明このパラメーターは、RDS Cluster Edition で SQL Server 2017 を実行する RDS インスタンスではサポートされていません。	rm-bp1v6z81ho9******
AccountName	string	任意	データベースアカウントの名前。	zhttest
PageSize	integer	任意	1 ページあたりのエントリ数。有効値：30～200。デフォルト値：30。	30
PageNumber	integer	任意	ページ番号。デフォルト値：1。ページは 1 から始まります。	1

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Accounts	object
DBInstanceAccount	array<object>	アカウントに関する情報。
	array<object>	アカウントの詳細。
AccountDescription	string	アカウントの説明。	测试数据库账号
AccountName	string	データベースアカウントの名前。	test1
AccountStatus	string	アカウントのステータス。有効値： Unavailable Available	Available
AccountType	string	アカウントのタイプ。有効値： Normal：標準アカウント Super：特権アカウント Sysadmin：システム管理者アカウント。SQL Server を実行しているインスタンスでのみサポートされます。	Normal
BypassRLS	string	アカウントが行レベルセキュリティ (RLS) 権限を持っているかどうかを示します。有効値： t：アカウントは RLS 権限を持っています。 f：アカウントは RLS 権限を持っていません。説明このパラメーターは、PostgreSQL を実行するインスタンスに対してのみ返されます。	f
CheckPolicy	boolean	パスワードポリシーが適用されているかどうかを示します。説明このパラメーターは、SQL Server を実行するインスタンスに対してのみ返されます。	true
CreateDB	string	アカウントにデータベースを作成する権限があるかどうかを示します。有効値： t：アカウントにはデータベースを作成する権限があります。 f：アカウントにはデータベースを作成する権限がありません。説明このパラメーターは、PostgreSQL を実行するインスタンスに対してのみ返されます。	t
CreateRole	string	アカウントにロールを作成する権限があるかどうかを示します。有効値： t：アカウントにはロールを作成する権限があります。 f：アカウントにはロールを作成する権限がありません。説明このパラメーターは、PostgreSQL を実行するインスタンスに対してのみ返されます。	t
DBInstanceId	string	アカウントが属するインスタンスの ID。	rm-bp1v6z81ho9******
DatabasePrivileges	object
DatabasePrivilege	array<object>	アカウントに付与されている権限に関する詳細。
	object
AccountPrivilege	string	権限のタイプ。有効値： ReadWrite：読み取り/書き込み権限。 ReadOnly：読み取り専用権限。 DDLOnly：DDL のみの権限。 DMLOnly：DML のみの権限。 Custom：カスタム権限。 SQL コマンドを使用して、アカウントの権限を変更できます。	ReadWrite
AccountPrivilegeDetail	string	アカウントに付与されている権限。詳細については、「アカウント権限」をご参照ください。	SELECT,INSERT
DBName	string	データベースの名前。	test1
PasswordExpireTime	string	パスワードの有効期限。説明このパラメーターは、SQL Server を実行するインスタンスに対してのみ返されます。	2024-10-21
PrivExceeded	string	アカウントによって管理されるデータベースの数が上限を超えているかどうかを示します。有効値： 1：アカウントによって管理されるデータベースの数が上限を超えています。 0：アカウントによって管理されるデータベースの数が上限を超えていません。	0
Replication	string	アカウントにレプリケーション権限があるかどうかを示します。有効値： t：アカウントにはレプリケーション権限があります。 f：アカウントにはレプリケーション権限がありません。説明このパラメーターは、PostgreSQL を実行するインスタンスに対してのみ返されます。	t
ValidUntil	string	パスワードの有効期限。有効値： infinity：パスワードは無期限です。 Empty：有効期限が指定されていません。実際の有効期限：yyyy-MM-ddTHH:mm:ssZ の形式の協定世界時 (UTC)。例：2022-10-01T00:00:00Z。説明このパラメーターは、PostgreSQL を実行するインスタンスに対してのみ返されます。	2022-10-01T00:00:00Z
PageNumber	integer	ページ番号。	1
RequestId	string	リクエスト ID。	17F2EA6C-3CA2-528D-A263-DC29707AD652
SystemAdminAccountFirstActivationTime	string	システム管理者アカウントが最初に有効化された時刻。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。時刻は協定世界時 (UTC) で表示されます。説明このパラメーターは、SQL Server を実行するインスタンスに対してのみ返されます。	2023-10-17T07:51:22Z
SystemAdminAccountStatus	string	システム管理者アカウントが有効化されたかどうかを示します。有効値： true：システム管理者アカウントが有効化されました。 false：システム管理者アカウントが無効化されました。説明システム管理者アカウントは、SQL Server を実行するインスタンスでのみサポートされます。インスタンスが SQL Server を実行している場合、このパラメーターの値が返されます。インスタンスが別のデータベースエンジンを実行している場合、このパラメーターの値は返されません。	True
TotalRecordCount	integer	返されたエントリの総数。	3
ResourceGroupId	string	リソースグループ ID。	rg-acfmy****

例

成功レスポンス

JSONJSON

{
  "Accounts": {
    "DBInstanceAccount": [
      {
        "AccountDescription": "测试数据库账号",
        "AccountName": "test1",
        "AccountStatus": "Available",
        "AccountType": "Normal",
        "BypassRLS": "f",
        "CheckPolicy": true,
        "CreateDB": "t",
        "CreateRole": "t",
        "DBInstanceId": "rm-bp1v6z81ho9******",
        "DatabasePrivileges": {
          "DatabasePrivilege": [
            {
              "AccountPrivilege": "ReadWrite",
              "AccountPrivilegeDetail": "SELECT,INSERT",
              "DBName": "test1"
            }
          ]
        },
        "PasswordExpireTime": "2024-10-21",
        "PrivExceeded": "0",
        "Replication": "t",
        "ValidUntil": "2022-10-01T00:00:00Z"
      }
    ]
  },
  "PageNumber": 1,
  "RequestId": "17F2EA6C-3CA2-528D-A263-DC29707AD652",
  "SystemAdminAccountFirstActivationTime": "2023-10-17T07:51:22Z",
  "SystemAdminAccountStatus": "True",
  "TotalRecordCount": 3,
  "ResourceGroupId": "rg-acfmy****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	%s	DB Operation Failed:%s.
400	IO.Exception	IO exception, retry later.
400	Database.ConnectError	Database connect error. please check instance status and database processlist
400	InvalidDBInstanceStatus.NotSupport	The Specified instance status is not supported to query account list.
400	InvalidEngine.Malformed	Specified engine is not valid.
400	Account.QueryError	Query Account failed, please check your input value.
400	SqlExcutionFailed	Database is already open and can only have one user at a time.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ConcurrentLimit	The request processing has been concurrent limit.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
400	DbossGeneralError	The instance is being created. Please wait.
400	InvalidCharacter.DbOrAccount	The database name or account name contains invalid characters.
400	NoAvailablePaymentMethod	No payment method is specified for account. We recommend that you add a payment method.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.
408	NetworkOrSqlTimeoutError	Failed to create login due to potential SQL Server overload or other issues that may cause the login creation fail. Please retry later.

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

変更履歴

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