DescribeAccounts - ApsaraDB RDS

該介面用於查詢 RDS 執行個體的帳號資訊。

介面說明

適用引擎。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

rds:DescribeAccounts

get

*DBInstance

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

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

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。可呼叫 DescribeDBInstances 取得。	rm-bp1v6z81ho9******
AccountName	string	否	資料庫帳號名稱。	zhttest
PageSize	integer	否	每頁記錄數，取值：30~200。預設值：30。	30
PageNumber	integer	否	頁碼。預設值：1。取值為大於 0 且不超過 Integer 的最大值。	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 支援）：具備超級許可權（SA）的帳號 GlobalRO（僅 SQL Server 支援）：全域唯讀帳號	Normal
BypassRLS	string	是否擁有安全性原則 RLS 許可權，傳回值如下： t：是 f：否說明僅 PostgreSQL 執行個體返回該參數。	f
CheckPolicy	boolean	是否應用密碼原則說明僅 SQLServer 執行個體返回該參數。	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	密碼到期時間說明僅 SQLServer 執行個體返回該參數。	2024-10-21
PrivExceeded	string	帳號管理的資料庫是否超過最大數量限制，傳回值如下： 1：是 0：否	0
Replication	string	是否擁有複製許可權，傳回值如下： t：是 f：否說明僅 PostgreSQL 執行個體返回該參數。	t
ValidUntil	string	密碼失效時間，傳回值如下： infinity：永不到期。返回為空：未設定。返回實際密碼失效時間。例如：2022-10-01T00:00:00Z，格式為：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）說明僅 PostgreSQL 執行個體返回該參數。	2022-10-01T00:00:00Z
PageNumber	integer	頁碼。	1
RequestId	string	請求 ID。	17F2EA6C-3CA2-528D-A263-DC29707AD652
SystemAdminAccountFirstActivationTime	string	超級權限帳號首次啟用時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。說明僅 SQL Server 執行個體傳回此參數。	2023-10-17T07:51:22Z
SystemAdminAccountStatus	string	超級權限帳號是否啟用，傳回值如下： True：已啟用 False：未啟用說明僅 SQL Server 執行個體支援超級權限帳號，該參數會有傳回值。其他引擎執行個體的傳回值為空。	True
TotalRecordCount	integer	總記錄數。	3
ResourceGroupId	string	資源群組 ID。	rg-acfmy****

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
400	%s	DB Operation Failed:%s.
400	IO.Exception	IO exception, retry later.	IO 異常。
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.	資料庫類型驗證失敗。資料庫類型取值範圍為 MySQL、SQL Server、PostgreSQL、PPAS。
400	Account.QueryError	Query Account failed, please check your input value.	查詢帳號失敗，請檢查請求參數。例如 RDS MySQL 帳號名稱可能含特殊字元。
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.	SQL 命令執行失敗或執行逾時。
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.	您的帳戶可用額度小於 0，請先儲值後再嘗試購買。
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.	提供的 DBInstanceId 不存在。
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.	您的阿里雲端帳號不存在，或者您的 AccessKey 已經過期。
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.	DB 執行個體引擎類型不支援此操作。
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	VPC 網路類型執行個體不支援此操作。
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.	執行個體正在建立中，請稍候。或者 RDS SQL Server 帳號名稱可能含特殊字元。
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.	由於 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.	SSD 磁碟不支援此操作，請升級至 ESSD。
403	InvalidUserOperatorPermission	The user permission does not support this operation.	使用者權限不支援此操作。
403	InvalidVswitchId	Specified conn vswitch id is not valid.	指定的 VSwitchId 格式不正確或為空。
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.	Kms key 已停用。
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	目前資料庫執行個體層級不支援此操作。
403	GuardDBInstanceNotSupport	Guard instance 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.	由於潛在的 SQL Server 過載或執行個體帳號過多，導致查詢逾時失敗。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。