DescribeAccounts - ApsaraDB RDS - Alibaba Cloud Documentation Center

Mengkueri informasi akun instans RDS.

Deskripsi operasi

Mesin yang didukung

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

rds:DescribeAccounts

get

*DBInstance

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

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans. Anda dapat memanggil DescribeDBInstances untuk mendapatkan nilai tersebut. Catatan Instans seri kluster SQL Server 2017 tidak didukung.	rm-bp1v6z81ho9******
AccountName	string	No	Nama akun database.	zhttest
PageSize	integer	No	Jumlah catatan per halaman. Nilai valid: 30 hingga 200. Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman. Nilai default: 1. Nilai harus lebih besar dari 0 dan tidak lebih besar dari nilai maksimum Integer.	1

Elemen respons

Element	Type	Description	Example
	object	Detail tentang parameter tanggapan.
Accounts	object
DBInstanceAccount	array<object>	Daftar informasi akun.
	array<object>	Detail akun adalah sebagai berikut.
AccountDescription	string	The description of the account.	测试数据库账号
AccountName	string	The name of the database account.	test1
AccountStatus	string	The status of the account. Valid values: Unavailable Available	Available
AccountType	string	The type of the account. Valid values: Normal: standard account Super: privileged account Sysadmin: system admin account, which is supported only for instances running SQL Server	Normal
BypassRLS	string	Indicates whether the account has the row-level security (RLS) permissions. Valid values: t: The account has the RLS permissions. f: The account does not have the RLS permissions. Catatan This parameter is returned only for instances that run PostgreSQL.	f
CheckPolicy	boolean	Indicates whether the password policy is applied. Catatan This parameter is returned only for instances that run SQL Server.	true
CreateDB	string	Indicates whether the account has the permissions to create databases. Valid values: t: The account has the permissions to create databases. f: The account does not have the permissions to create databases. Catatan This parameter is returned only for instances that run PostgreSQL.	t
CreateRole	string	Indicates whether the account has the permissions to create roles. Valid values: t: The account has the permissions to create roles. f: The account does not have the permissions to create roles. Catatan This parameter is returned only for instances that run PostgreSQL.	t
DBInstanceId	string	The ID of the instance to which the account belongs.	rm-bp1v6z81ho9******
DatabasePrivileges	object
DatabasePrivilege	array<object>	The details about the permissions that are granted to the account.
	object
AccountPrivilege	string	The type of the permissions. Valid values: ReadWrite: read and write permissions. ReadOnly: read-only permissions. DDLOnly: DDL-only permissions. DMLOnly: DML-only permissions. Custom: custom permissions. You can modify the permissions of the account by using SQL commands.	ReadWrite
AccountPrivilegeDetail	string	The permissions that are granted to the account. For more information, see Account permissions.	SELECT,INSERT
DBName	string	The name of the database.	test1
PasswordExpireTime	string	The expiration time of the password. Catatan This parameter is returned only for instances that run SQL Server.	2024-10-21
PrivExceeded	string	Indicates whether the number of databases that are managed by the account exceeds the upper limit. Valid values: 1: The number of databases that are managed by the account exceeds the upper limit. 0: The number of databases that are managed by the account does not exceed the upper limit.	0
Replication	string	Indicates whether the account has the replication permissions. Valid values: t: The account has the replication permissions. f: The account does not have the replication permissions. Catatan This parameter is returned only for instances that run PostgreSQL.	t
ValidUntil	string	The expiration time of the password. Valid values: infinity: The password never expires. Empty: The expiration time is not specified. Actual expiration time: in the format of yyyy-MM-ddTHH:mm:ssZ in UTC. Example: 2022-10-01T00:00:00Z. Catatan This parameter is returned only for instances that run PostgreSQL.	2022-10-01T00:00:00Z
PageNumber	integer	Nomor halaman.	1
RequestId	string	ID permintaan.	17F2EA6C-3CA2-528D-A263-DC29707AD652
SystemAdminAccountFirstActivationTime	string	Pengatur waktu ketika akun istimewa pertama kali diaktifkan. format adalah yyyy-MM-ddTHH:mm:ssZ (waktu UTC). Catatan Parameter ini hanya dikembalikan untuk instans SQL Server.	2023-10-17T07:51:22Z
SystemAdminAccountStatus	string	Apakah akun istimewa diaktifkan. Nilai valid: True: diaktifkan False: dinonaktifkan Catatan Hanya instans SQL Server yang mendukung akun istimewa dan mengembalikan nilai untuk parameter ini. Nilai kembali kosong untuk instans mesin lainnya.	True
TotalRecordCount	integer	Jumlah total catatan.	3
ResourceGroupId	string	ID kelompok sumber daya.	rg-acfmy****

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message
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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.