すべてのプロダクト
Search

このプロダクト

    ApsaraDB RDS:DescribeDBProxyEndpoint

    ドキュメントセンター

    ApsaraDB RDS:DescribeDBProxyEndpoint

    最終更新日:Apr 18, 2026

    この API は、RDS インスタンスのプロキシ接続アドレスを取得するために使用されます。

    操作説明

    サポートされるエンジン

    • RDS MySQL

    • RDS PostgreSQL

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    rds:DescribeDBProxyEndpoint

    get

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    • rds:ResourceTag
    • rds:ResourceTag
    • rds:ResourceTag
    		 なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。DescribeDBInstances 操作を呼び出して、インスタンス ID を照会できます。

    rm-bp1ja4f56s7us****
    DBProxyEndpointId

    string

    任意

    プロキシエンドポイントの ID。DescribeDBProxy 操作を呼び出して、この ID を照会できます。

    keaxncrjluwu0gue****
    DBProxyConnectString

    string

    任意

    プロキシ接続文字列。DescribeDBProxy 操作を呼び出して、この接続文字列を照会できます。

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

    string

    任意

    リージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。

    cn-hangzhou
    DBInstanceId

    string

    必須

    インスタンス ID。DescribeDBInstances 操作を呼び出して、インスタンス ID を照会できます。

    rm-bp1ja4f56s7us****
    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

    プロキシエンドポイントの機能設定。値は、セミコロンで区切られたキーと値のペアの文字列です。この文字列には、次のキーが含まれます：

    • TransactionReadSqlRouteOptimizeStatus：トランザクション分割を有効にするかどうかを指定します。有効な値：0 (無効) および 1 (有効)。

    • ConnectionPersist：接続プールタイプを指定します。有効な値：0 (無効)、1 (セッションレベル接続プール)、および 2 (トランザクションレベル接続プール)。

    • ReadWriteSpliting：読み書き分離を有効にするかどうかを指定します。有効な値：0 (無効) および 1 (有効)。

    • AZProximityAccess：近接アクセス機能。有効な値：0 (無効) および 1 (有効)。

    • CausalConsistRead：読み取り整合性レベルを指定します。有効な値：0 (結果整合性)、1 (セッションの一貫性)、および 2 (グローバル整合性)。

    • HtapFilter：HTAP リクエストの自動ルーティング。有効な値：0 (無効) および 1 (有効)。

    • PinPreparedStmt：ApsaraDB RDS for PostgreSQL インスタンスでのみ表示される予約済みの内部パラメーターです。

    説明

    ApsaraDB RDS for 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

    プロキシエンドポイントの VSwitch ID。

    vsw-****
    DbProxyEndpointVpcId

    string

    プロキシエンドポイントの VPC ID。

    vpc-****
    DbProxyEndpointZoneId

    string

    プロキシエンドポイントが作成されたアベイラビリティゾーンの ID。

    cn-hangzhou-c
    EndpointConnectItems

    object

    EndpointConnectItems

    array<object>

    プロキシ接続文字列に関する詳細のリスト。

    object

    プロキシ接続文字列の詳細。

    DbProxyEndpointConnectString

    string

    プロキシ接続文字列。

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

    string

    ネットワークタイプ。有効な値：

    • 0：パブリックネットワーク

    • 1：クラシックネットワーク

    • 2：VPC

    2
    DbProxyEndpointPort

    string

    サービスポート。デフォルト値は 3306 です。

    3306
    ReadOnlyInstanceDistributionType

    string

    読み取り重み分散モード。詳細については、「読み取り重みの割り当て」をご参照ください。有効な値：

    • Standard：システムは、インスタンスの仕様に基づいて読み取り重みを自動的に割り当てます。

    • Custom：インスタンスのカスタム読み取り重みを指定します。

    Standard
    ReadOnlyInstanceMaxDelayTime

    string

    読み書き分離のレイテンシーしきい値。読み取り専用インスタンスのレプリケーション遅延がこのしきい値を超えると、読み取りリクエストはそのインスタンスにルーティングされません。単位：秒。

    30
    CausalConsistReadTimeout

    string

    一貫性のある読み取りのタイムアウト (ミリ秒)。有効な値：0～60000。デフォルト：10。

    10
    ReadOnlyInstanceWeight

    string

    読み取り重み分散。値は、プライマリインスタンスと読み取り専用インスタンスの読み取り重みを指定する JSON 文字列です。次のフィールドが含まれます：

    • DBInstanceId：インスタンス ID。

    • DBInstanceType：インスタンスタイプ。有効な値：Master (プライマリインスタンス) および ReadOnly (読み取り専用インスタンス)。

    • NodeID：インスタンスが RDS Cluster Edition を実行している場合の、プライマリインスタンスのプライマリノードまたはセカンダリノードの ID。

    • NodeType：RDS Cluster Edition を実行するインスタンスのノードタイプ。有効な値：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

    DBProxyEndpointMinSlaveCount

    string

    保持する読み取り専用インスタンスの最小数。

    2

    例

    成功レスポンス

    JSONJSON

    {
  "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": "",
  "DBProxyEndpointMinSlaveCount": "2"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 MaxscaleNotSupport Current custins can not support Maxscale.
    400 InvalidEndPoint.Format The specified EndPoint is not valid.
    400 InvalidDBInstanceName Specified parameter DBInstanceName is not valid.
    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.
    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 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.
    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.
    403 InvalidVpcInfo.NotFound Specified VPC info does not exist.
    404 Endpoint.NotFound Specified endpoint is not found.
    404 Maxscale.NotFound The relative maxscale instance is not found.
    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.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。