DescribeDBProxy - ApsaraDB RDS - Alibaba Cloud Documentation Center

Antarmuka ini digunakan untuk mengkueri detail pengaturan proxy database dari instans RDS.

Deskripsi operasi

Engine yang didukung

RDS MySQL
RDS PostgreSQL

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans. Panggil DescribeDBInstances untuk memperolehnya.	rm-bp1ja4f56s7us****
RegionId	string	No	ID region. Panggil DescribeRegions untuk memperolehnya.	cn-hangzhou
DBInstanceId	string	Yes	ID instans. Panggil DescribeDBInstances untuk memperolehnya.	rm-bp1ja4f56s7us****
DBProxyEngineType	string	No	Parameter usang, tidak perlu dikonfigurasi.	normal
ResourceGroupId	string	No	ID grup sumber daya.	rg-acfmy****

Elemen respons

Element	Type	Description	Example
	object	Detail parameter yang dikembalikan.
DBProxyInstanceMinorVersions	object
DBProxyInstanceMinorVersions	array	Daftar versi instans proxy yang dapat ditingkatkan.	2.25.9
	string	Versi proxy yang dapat ditingkatkan.	2.25.9_20251028
DBProxyConnectStringItems	object
DBProxyConnectStringItems	array<object>	Daftar informasi connection string untuk proxy database.
	object	Detail informasi connection string untuk proxy database.
DBProxyConnectString	string	The database proxy endpoint.	gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com
DBProxyConnectStringNetType	string	The network type of the database proxy endpoint. A database proxy endpoint is formerly referred to as a proxy terminal. Valid values: OuterString: Internet InnerString: internal network	InnerString
DBProxyConnectStringNetWorkType	string	The network type of the database proxy. Valid values: 0: Internet 1: classic network 2: virtual private cloud (VPC)	2
DBProxyConnectStringPort	string	The port that is associated with the database proxy endpoint.	3306
DBProxyEndpointId	string	The ID of the backend database proxy endpoint.	20****
DBProxyEndpointName	string	The name of the database proxy endpoint. The name can be replaced by the ID of the database proxy endpoint.	gos787jog2wk0ye1****
DBProxyVpcId	string	The VPC of the database proxy.	vpc-uf6oobt****
DBProxyVpcInstanceId	string	The ID of the database proxy instance.	rm-bp145737x5**131161274792**
DBProxyVswitchId	string	The vSwitch of the database proxy.	vsw-uf6l0pic17****
DBProxyEngineType	string	Parameter internal, tidak perlu diperhatikan.	normal
DBProxyInstanceCurrentMinorVersion	string	Versi saat ini dari instans proxy.	1.13.11
DBProxyInstanceLatestMinorVersion	string	Versi terbaru dari instans proxy.	1.13.12
DBProxyInstanceName	string	Nama instans proxy.	gos787jog2wk0ye1****
DBProxyInstanceNum	integer	Jumlah instans proxy yang diaktifkan.	1
DBProxyInstanceSize	string	Parameter ini hanya didukung oleh RDS PostgreSQL. Menunjukkan ukuran aktual dari spesifikasi instans proxy. Format: `CPU/Memori`. Contoh: 4/8 menunjukkan 4 core CPU dan memori 8 GB.	4/8
DBProxyInstanceStatus	string	Status berjalannya instans proxy. DBInstanceClassChanging: sedang mengubah konfigurasi Creating: sedang dibuat Running: sedang berjalan Deleting: sedang dihapus	Running
DBProxyInstanceType	string	Tipe layanan proxy. 1: proxy bersama 2: proxy dedicated 3: proxy serbaguna Catatan RDS PostgreSQL tidak mendukung proxy bersama.	2
DBProxyKindCode	string	Parameter internal, tidak perlu diperhatikan.	18
DBProxyNodes	object
DBProxyNodes	array<object>	Daftar node proxy.
	object	Detail dari daftar node.
cpuCores	string	The number of CPU cores of the node.	2
nodeId	string	The ID of the proxy node.	pn-xxxxxxx01
zoneId	string	The ID of the zone in which the node is deployed.	cn-hangzhou-c
DBProxyPersistentConnectionStatus	string	Status persistensi koneksi. Nilai yang valid: Enabled: diaktifkan Disabled: dinonaktifkan Unsupported: instans tidak mendukung pengaktifan persistensi koneksi	Disabled
DBProxyServiceStatus	string	Status saklar fitur proxy database. Shutdown: dinonaktifkan Startup: diaktifkan	Startup
DbProxyEndpointItems	object
DbProxyEndpointItems	array<object>	Daftar informasi endpoint proxy.
	object	Detail informasi endpoint proxy.
DbProxyEndpointAliases	string	The description of the database proxy endpoint.	proxy-test
DbProxyEndpointName	string	The ID of the database proxy endpoint.	gos787jog2wk0ye1****
DbProxyEndpointType	string	The type of the database proxy endpoint. Valid values: Custom: custom database proxy endpoint RWSplit: default database proxy endpoint	RWSplit
DbProxyReadWriteMode	string	The read and write attributes of the database proxy endpoint. ReadOnly ReadWrite	ReadWrite
RequestId	string	ID permintaan.	909A69EE-71C8-4417-A0B9-FF085407E1E3
ResourceGroupId	string	ID grup sumber daya.	rg-acfmy****
DBProxyAVZones	object
DBProxyAVZones	array	Daftar zona tempat layanan proxy berada.
	string	Zona tempat layanan proxy berada.	cn-shanghai-e

Contoh

Respons sukses

JSONformat

{
  "DBProxyInstanceMinorVersions": {
    "DBProxyInstanceMinorVersions": [
      "2.25.9_20251028"
    ]
  },
  "DBProxyConnectStringItems": {
    "DBProxyConnectStringItems": [
      {
        "DBProxyConnectString": "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
        "DBProxyConnectStringNetType": "InnerString",
        "DBProxyConnectStringNetWorkType": "2",
        "DBProxyConnectStringPort": "3306",
        "DBProxyEndpointId": "20****",
        "DBProxyEndpointName": "gos787jog2wk0ye1****",
        "DBProxyVpcId": "vpc-uf6oobt****",
        "DBProxyVpcInstanceId": "rm-bp145737x5****131161274792****",
        "DBProxyVswitchId": "vsw-uf6l0pic17****"
      }
    ]
  },
  "DBProxyEngineType": "normal",
  "DBProxyInstanceCurrentMinorVersion": "1.13.11",
  "DBProxyInstanceLatestMinorVersion": "1.13.12",
  "DBProxyInstanceName": "gos787jog2wk0ye1****",
  "DBProxyInstanceNum": 1,
  "DBProxyInstanceSize": "4/8",
  "DBProxyInstanceStatus": "Running",
  "DBProxyInstanceType": "2",
  "DBProxyKindCode": "18",
  "DBProxyNodes": {
    "DBProxyNodes": [
      {
        "cpuCores": "2",
        "nodeId": "pn-xxxxxxx01",
        "zoneId": "cn-hangzhou-c"
      }
    ]
  },
  "DBProxyPersistentConnectionStatus": "Disabled",
  "DBProxyServiceStatus": "Startup",
  "DbProxyEndpointItems": {
    "DbProxyEndpointItems": [
      {
        "DbProxyEndpointAliases": "proxy-test",
        "DbProxyEndpointName": "gos787jog2wk0ye1****",
        "DbProxyEndpointType": "RWSplit",
        "DbProxyReadWriteMode": "ReadWrite"
      }
    ]
  },
  "RequestId": "909A69EE-71C8-4417-A0B9-FF085407E1E3",
  "ResourceGroupId": "rg-acfmy****",
  "DBProxyAVZones": {
    "DBProxyAVZones": [
      "cn-shanghai-e"
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	RWSplitNetTypeNotExists	Specified rw split net type is not eixsts.
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.
400	InvalidInstanceLevelExtraInfo	Specified class code has error extra info.
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	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
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	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
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	InvalideStatus.Format	The instance status does not support this operation.
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.
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	IncorrectKindCode	Current custins kindCode does not support this operation.
403	IncorrectDBInstanceType	The database instance type does not support the operation.
403	IncorrectDBInstanceEngine	Current DB Instance engine 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	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.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.