全部產品
Search
文件中心

ApsaraDB RDS:DescribeDBProxyEndpoint

更新時間:Oct 23, 2026

該介面用於查詢 RDS 執行個體資料庫代理的連線地址資訊。

介面說明

適用引擎

  • RDS MySQL

  • RDS PostgreSQL

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

rds:DescribeDBProxyEndpoint

get

*DBInstance。

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

  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
無

請求參數

名稱

類型

必填

描述

樣本值

DBInstanceId

string

是

執行個體 ID。可呼叫 DescribeDBInstances 取得。

rm-bp1ja4f56s7us****

DBProxyEndpointId

string

否

代理終端名稱。可呼叫 DescribeDBProxy 介面查詢。

keaxncrjluwu0gue****

DBProxyConnectString

string

否

代理連線地址。可呼叫 DescribeDBProxy 介面查詢。

testproxy****.rwlb.rds.aliyuncs.com

RegionId

string

否

地域 ID。可呼叫 DescribeRegions 取得。

cn-hangzhou

DBProxyEngineType

string

否

預留參數,無需配置。

normal

返回參數

名稱

類型

描述

樣本值

object

傳回參數詳情。

DBProxyConnectString

string

代理連線地址。

testproxy****.rwlb.rds.aliyuncs.com

DBProxyConnectStringNetType

string

代理連線地址的網路類型,取值:

  • InnerString:內網地址。

  • OuterString:外網地址。

InnerString

DBProxyConnectStringPort

string

代理連線地址連接埠。

3306

DBProxyEndpointId

string

代理連線地址 ID。

keaxncrjluwu0gue****

DBProxyEngineType

string

內部參數,無需關注。

normal

DBProxyFeatures

string

代理終端的設定資訊,格式為 JSON,包含下述參數:

  • TransactionReadSqlRouteOptimizeStatus:事務拆分設定,取值為 0(關閉)或 1(開啟)。

  • ConnectionPersist:連線池設定:取值為 0(關閉)、1(工作階段級連線池)或 2(事務級連線池)。

  • ReadWriteSpliting:讀寫分離設定,取值為 0(關閉)或 1(開啟)。

  • AZProximityAccess:就近存取,取值為 0(關閉)或 1(開啟)。

  • CausalConsistRead:讀取一致性設定:取值為 0(最終一致性)、1(工作階段一致性)或 2(全域一致性)。

  • HtapFilter:HTAP 行列自動分流,取值為 0(關閉)或 1(開啟)。

  • PinPreparedStmt:僅 RDS PostgreSQL 可見,內部參數。

說明

RDS PostgreSQL 僅支援修改 ReadWriteSpliting,TransactionReadSqlRouteOptimizeStatus 和 PinPreparedStmt 預設為 1。

TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1

DBProxyNodes

object

DBProxyNodes

array<object>

代理終端下關聯的代理節點清單。

object

代理節點詳情。

cpuCores

string

節點 CPU 核心數。

2

nodeId

string

可用區中代理節點 ID。

pn-xxxxxxx01

zoneId

string

節點所在的可用區 ID。

cn-hangzhou-c

DbProxyEndpointAliases

string

代理終端的備註資訊。

proxyterminal-test

DbProxyEndpointReadWriteMode

string

代理終端的讀寫類型,取值:

  • ReadWrite:讀寫模式。

  • ReadOnly:唯讀模式。

ReadWrite

DbProxyEndpointVswitchId

string

代理終端的交換器 ID。

vsw-****

DbProxyEndpointVpcId

string

代理終端的 VPC ID。

vpc-****

DbProxyEndpointZoneId

string

代理終端的可用區資訊。

cn-hangzhou-c

EndpointConnectItems

object

EndpointConnectItems

array<object>

代理連線地址的詳細資訊清單。

object

代理連線地址的詳細資訊。

DbProxyEndpointConnectString

string

代理連線地址。

testproxy****.rwlb.rds.aliyuncs.com

DbProxyEndpointNetType

string

網路類型,取值:

  • 0:公網

  • 1:傳統網路

  • 2:虛擬私有雲

2

DbProxyEndpointPort

string

服務連接埠,預設為 3306。

3306

ReadOnlyInstanceDistributionType

string

讀取權重分配模式,詳情請參見讀取權重分配。取值:

  • Standard:按規格權重自動分配。

  • Custom:自訂分配權重。

Standard

ReadOnlyInstanceMaxDelayTime

string

讀寫分離的延遲臨界值,當唯讀執行個體延遲時間超過該臨界值時,讀取流量不傳往該執行個體,單位:秒。

30

CausalConsistReadTimeout

string

一致性讀取逾時時間,單位:毫秒。預設為 10 毫秒,取值:0~60000。

10

ReadOnlyInstanceWeight

string

讀取權重分配資訊,即傳入主執行個體和唯讀執行個體的讀取請求權重,格式為 JSON,包含下述參數:

  • DBInstanceId:執行個體 ID。

  • DBInstanceType:執行個體類型,取值為 Master(主執行個體)或 ReadOnly(唯讀執行個體)。

  • NodeID:叢集系列中主執行個體主節點和備節點的節點 ID。

  • NodeType:叢集系列中的節點類型,取值為 Primary(主執行個體-主節點)或 Secondary(主執行個體-備節點)。

  • Weight:讀取請求權重,以 100 遞增,最大值為 10000。

[{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-t2****\",\"NodeType\":\"Primary\",\"Weight\":0}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-z9****\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",,\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-1c****\",\"NodeType\":\"Secondary\",\"Weight\":400}]]

RequestId

string

請求 ID。

847BA085-B377-4BFA-8267-F82345ECE1D2

DBProxyEndpointCostThresholdForDuckdb

string

HTAP 行列自動分流 SQL 執行代價臨界值。

30000

DBProxyEndpointMinSlaveCount

string

最小保留執行個體數。

2

樣本

正常返回樣本

JSON格式

{
  "DBProxyConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
  "DBProxyConnectStringNetType": "InnerString",
  "DBProxyConnectStringPort": "3306",
  "DBProxyEndpointId": "keaxncrjluwu0gue****",
  "DBProxyEngineType": "normal",
  "DBProxyFeatures": "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
  "DBProxyNodes": {
    "DBProxyNodes": [
      {
        "cpuCores": "2",
        "nodeId": "pn-xxxxxxx01",
        "zoneId": "cn-hangzhou-c"
      }
    ]
  },
  "DbProxyEndpointAliases": "proxyterminal-test",
  "DbProxyEndpointReadWriteMode": "ReadWrite",
  "DbProxyEndpointVswitchId": "vsw-****",
  "DbProxyEndpointVpcId": "vpc-****",
  "DbProxyEndpointZoneId": "cn-hangzhou-c",
  "EndpointConnectItems": {
    "EndpointConnectItems": [
      {
        "DbProxyEndpointConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
        "DbProxyEndpointNetType": "2",
        "DbProxyEndpointPort": "3306"
      }
    ]
  },
  "ReadOnlyInstanceDistributionType": "Standard",
  "ReadOnlyInstanceMaxDelayTime": "30",
  "CausalConsistReadTimeout": "10",
  "ReadOnlyInstanceWeight": "[{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-t2****\\\",\\\"NodeType\\\":\\\"Primary\\\",\\\"Weight\\\":0}, {\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-z9****\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",,\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-1c****\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}]]",
  "RequestId": "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "DBProxyEndpointCostThresholdForDuckdb": "30000",
  "DBProxyEndpointMinSlaveCount": "2"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 MaxscaleNotSupport Current custins can not support Maxscale. 操作失敗,執行個體不支援獨享代理,請檢查開通獨享代理的配置資訊。
400 InvalidEndPoint.Format The specified EndPoint is not valid. 專屬代理連線位址ID(DBProxyEndpointId)未傳,查詢不存在,請檢查Endpoint參數。
400 InvalidDBInstanceName Specified parameter DBInstanceName is not valid. 指定的執行個體名稱(DBInstanceName)無效,請檢查參數值是否為null或空字串。
400 Endpoint.NotFound The specified EndPoint is not valid. 操作失敗,指定的端點資訊未找到。
400 InvalidParameter The specified parameter is invalid. 無效的參數。
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 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. sql命令執行失敗或執行逾時。
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. 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. 客戶您好,該地域已裁撤。
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 IncorrectKindCode The current KindCode of the custins does not support the operation. 操作失敗,目前執行個體所屬環境類型不支援,請檢查介面支援的執行個體類型。
403 IncorrectDBInstanceType The current 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. 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 InvalidVpcInfo.NotFound Specified VPC info does not exist. 指定的VPC資訊不存在。
404 Endpoint.NotFound Specified endpoint is not found. 操作失敗,指定的端點資訊未找到。
404 Maxscale.NotFound The relative maxscale instance is not found. 操作失敗,未找到關聯的maxscale執行個體。
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. 指定的主機資訊不存在。

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

變更歷史

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