Bir RDS örneğinin PolarProxy ayarlarını sorgular.
Operation description
Desteklenen Motorlar
RDS MySQL
RDS PostgreSQL
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DBInstanceId |
string |
Yes |
Örnek kimliği. Örnek kimliğini sorgulamak için DescribeDBInstances işlemini çağırabilirsiniz. |
rm-bp1ja4f56s7us**** |
| RegionId |
string |
No |
Bölge kimliği. En güncel bölge listesini sorgulamak için DescribeRegions işlemini çağırabilirsiniz. |
cn-hangzhou |
| DBInstanceId |
string |
Yes |
Örnek kimliği. Örnek kimliğini sorgulamak için DescribeDBInstances işlemini çağırabilirsiniz. |
rm-bp1ja4f56s7us**** |
| DBProxyEngineType |
string |
No |
Kullanımdan kaldırılmış bir parametre. Bu parametreyi belirtmenize gerek yoktur. |
normal |
| ResourceGroupId |
string |
No |
Kaynak grubu kimliği. |
rg-acfmy**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Yanıt parametreleri. |
||
| DBProxyInstanceMinorVersions |
object |
2.25.9 |
|
| DBProxyInstanceMinorVersions |
array |
Proxy örneğinin yükseltilebileceği alt sürüm koleksiyonu. |
2.25.9 |
|
string |
Proxy için yükseltilebilir sürümler. |
2.25.9_20251028 |
|
| DBProxyConnectStringItems |
object |
||
| DBProxyConnectStringItems |
array<object> |
Örnek için oluşturulan veritabanı proxy uç noktası hakkındaki bilgilerden oluşan bir dizi. |
|
|
object |
Örnek için oluşturulan proxy uç noktası. |
||
| DBProxyConnectString |
string |
The proxy endpoint connection address. |
gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com |
| DBProxyConnectStringNetType |
string |
Veritabanı proxy uç noktasının ağ türü. Veritabanı proxy uç noktası, daha önce proxy terminali olarak adlandırılıyordu. Geçerli değerler:
|
InnerString |
| DBProxyConnectStringNetWorkType |
string |
Veritabanı proxy'sinin ağ türü. Geçerli değerler:
|
2 |
| DBProxyConnectStringPort |
string |
Veritabanı proxy uç noktasıyla ilişkili bağlantı noktası. |
3306 |
| DBProxyEndpointId |
string |
Arka uç veritabanı proxy uç noktasının kimliği. |
20**** |
| DBProxyEndpointName |
string |
Veritabanı proxy uç noktasının adı. Ad, veritabanı proxy uç noktasının kimliği ile değiştirilebilir. |
gos787jog2wk0ye1**** |
| DBProxyVpcId |
string |
Veritabanı proxy'sinin VPC'si. |
vpc-uf6oobt**** |
| DBProxyVpcInstanceId |
string |
Veritabanı proxy örneğinin kimliği. |
rm-bp145737x5****131161274792**** |
| DBProxyVswitchId |
string |
Veritabanı proxy'sinin vSwitch'i. |
vsw-uf6l0pic17**** |
| DBProxyEngineType |
string |
Dahili bir parametre. Bu parametreyi yok sayabilirsiniz. |
normal |
| DBProxyInstanceCurrentMinorVersion |
string |
Proxy örneğinin sürümü. |
1.13.11 |
| DBProxyInstanceLatestMinorVersion |
string |
Proxy örneği için kullanılabilen en son sürüm. |
1.13.12 |
| DBProxyInstanceName |
string |
Proxy örneğinin adı. |
gos787jog2wk0ye1**** |
| DBProxyInstanceNum |
integer |
Örnekte etkinleştirilen proxy sayısı. |
1 |
| DBProxyInstanceSize |
string |
Bu parametre yalnızca ApsaraDB RDS for PostgreSQL örnekleri için kullanılabilir. Etkinleştirilen proxy örneğinin teknik özellikleri. Biçim: Çekirdek sayısı/Bellek kapasitesi. Örneğin, 4/8 değeri proxy örneğinin 4 çekirdeğe ve 8 GB belleğe sahip olduğunu gösterir. |
4/8 |
| DBProxyInstanceStatus |
string |
Proxy örneğinin durumu.
|
Running |
| DBProxyInstanceType |
string |
Örnekte etkinleştirilen veritabanı proxy'sinin türü. Geçerli değerler:
Not
ApsaraDB RDS for PostgreSQL, paylaşımlı veritabanı proxy'lerini desteklemez. |
2 |
| DBProxyKindCode |
string |
Dahili bir parametre. Bu parametreyi belirtmenize gerek yoktur. |
18 |
| DBProxyNodes |
object |
||
| DBProxyNodes |
array<object> |
Proxy düğümleri. |
|
|
object |
Düğüm listesinin ayrıntıları. |
||
| cpuCores |
string |
Düğümün CPU çekirdeği sayısı. |
2 |
| nodeId |
string |
Proxy düğümünün kimliği. |
pn-xxxxxxx01 |
| zoneId |
string |
Düğümün konuşlandırıldığı bölgenin kimliği. |
cn-hangzhou-c |
| DBProxyPersistentConnectionStatus |
string |
Kalıcı bağlantıların durumu. Geçerli değerler:
|
Disabled |
| DBProxyServiceStatus |
string |
Veritabanı proxy'sinin durumu.
|
Startup |
| DbProxyEndpointItems |
object |
||
| DbProxyEndpointItems |
array<object> |
Örneğin proxy terminalleri. |
|
|
object |
Proxy terminali hakkındaki bilgiler. |
||
| DbProxyEndpointAliases |
string |
Veritabanı proxy uç noktasının açıklaması. |
proxy-test |
| DbProxyEndpointName |
string |
Veritabanı proxy uç noktasının kimliği. |
gos787jog2wk0ye1**** |
| DbProxyEndpointType |
string |
Veritabanı proxy uç noktasının türü. Geçerli değerler:
|
RWSplit |
| DbProxyReadWriteMode |
string |
Veritabanı proxy uç noktasının okuma ve yazma öznitelikleri.
|
ReadWrite |
| RequestId |
string |
İstek kimliği. |
909A69EE-71C8-4417-A0B9-FF085407E1E3 |
| ResourceGroupId |
string |
Kaynak grubu kimliği. |
rg-acfmy**** |
| DBProxyAVZones |
object |
||
| DBProxyAVZones |
array |
Veritabanı proxy'si için kullanılabilir olan bölgelerin listesi. |
|
|
string |
Veritabanı proxy'si için kullanılabilir olan bölge. |
cn-shanghai-e |
Examples
Success response
JSON format
{
"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"
]
}
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | RWSplitNetTypeNotExists | Specified rw split net type is not eixsts. | |
| 400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string. |
| 400 | InvalidInstanceLevelExtraInfo | Specified class code has error extra info. | The specified class code contains incorrect additional information. |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | A package instance is not allowed to operate independently. |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 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. | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication. |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | Your account available limit is less than 0, please recharge before trying to purchase. |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | Failed to call commodity service return. |
| 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. | Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, 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. | 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. | Hello customer, this area has been abolished. |
| 400 | Price.CommoditySys | Commodity system call exception. | Commodity system call exception. |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | Insufficient available balance. |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | There is a problem with the period you selected, please choose again. |
| 400 | pay.noCreditCard | Account not bound to credit card. | The account is not bound to a 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. | 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. | No payment method has been specified for your account. We recommend that you add a payment method. |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | Your basic information is not complete, please complete your basic information before operation. |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | Your account is abnormal, please contact customer service for details. |
| 400 | Api.NotSupport | Specified api is not supported. | The current interface does not support. |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor. |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | The DBInstanceId provided does not exist. |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | The current instance type does not support the specified storage type. |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica. |
| 400 | KmsApiError | User secret key invalid. | The user key is invalid. |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | A system error occurs when the sales expression is verified. |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | The account does not exist. |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | SQL command execution failed or timed out |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | The current instance engine version not support coldDataEnabled. |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | The current instance minor version not support coldDataEnabled. |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | This operation is not supported by the instance type. |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | The link address name is duplicate. Please reset the connection string. |
| 400 | RequiredParam.NotFound | Required input param is not found. | A required parameter is missing. |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | Parameter error, please check the parameters. |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | 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. | The instance status does not support this operation. |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | Specified Released Keep Policy is not valid. |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | This operation is not supported for the database engine of the instance. |
| 400 | Pay.NoCreditCard | No credit cards. | No credit cards. |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | The vpc network type instance does not support this operation. |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | Specified DB instance mirror ins already existed. |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | The specified DB instance class stops selling. |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | The specified database does not exist in the backup set. |
| 400 | OrdTCommodityQueryError | Failed to query for product. | Failed to query product. |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | The instance has been released, please verify and place an order. |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | The region is no longer supported. |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | The request processing has failed due to external service failure. |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | 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. | The request failed to be processed due to an RDS API failure. |
| 403 | IncorrectKindCode | Current custins kindCode does not support this operation. | The operation failed. The operation is not supported for the database engine that is run on the RDS instance. |
| 403 | IncorrectDBInstanceType | The database instance type does not support the operation. | The operation failed. The operation is not supported for the database engine of the RDS instance. |
| 403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | The operation failed. The operation is not supported for the database engine that is run on the RDS instance. |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | The instance has an unpaid order. Please pay first and try again. |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | The scale-in target capacity cannot be less than the current storage space usage |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | SSD cloud disks do not support this operation. Upgrade to ESSD. |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | The user is not authorized to perform this operation. |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | The specified VSwitchId is in an invalid format or is empty. |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | This operation is not supported for the current minor engine version. |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | There is no available zone for inventory. |
| 403 | NotInFlowController | Sorry,no permission. | Sorry,no permission. |
| 403 | InvalidKmsKey | Kms key is disabled. | The KMS key is disabled. |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | The specified database instance type does not support this operation. |
| 404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | The name of the RDS instance cannot be found. Check the name of the RDS instance. |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | The instance does not have permissions to access Key Management Service (KMS). |
| 404 | Request.NotFound | The requested resource is not available. | The requested resources are unavailable. |
| 404 | HostInfo.NotFound | The specified host info is not found. | The specified host information does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.