すべてのプロダクト
Search

このプロダクト

    ApsaraDB RDS:DescribeDBProxy

    ドキュメントセンター

    ApsaraDB RDS:DescribeDBProxy

    最終更新日:Apr 18, 2026

    この API は、RDS インスタンスの PolarProxy 設定を照会します。

    操作説明

    サポートされるエンジン

    • RDS MySQL

    • RDS PostgreSQL

    今すぐお試しください

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

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

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

    rm-bp1ja4f56s7us****
    RegionId

    string

    任意

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

    cn-hangzhou
    DBInstanceId

    string

    必須

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

    rm-bp1ja4f56s7us****
    DBProxyEngineType

    string

    任意

    非推奨のパラメーターです。このパラメーターを指定する必要はありません。

    normal
    ResourceGroupId

    string

    任意

    リソースグループの ID。

    rg-acfmy****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    DBProxyInstanceMinorVersions

    object

    DBProxyInstanceMinorVersions

    array

    プロキシインスタンスをアップグレードできるマイナーバージョンのコレクション。

    2.25.9

    string

    プロキシのアップグレード可能なバージョン。

    2.25.9_20251028
    DBProxyConnectStringItems

    object

    DBProxyConnectStringItems

    array<object>

    インスタンス用に作成されたプロキシ接続アドレスに関する情報で構成される配列。

    object

    インスタンス用に作成されたプロキシエンドポイント。

    DBProxyConnectString

    string

    プロキシ接続アドレス。

    gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com
    DBProxyConnectStringNetType

    string

    プロキシ接続アドレスのネットワークタイプ。プロキシ接続アドレスは、以前はプロキシターミナルと呼ばれていました。有効値：

    • OuterString：インターネット

    • InnerString：内部ネットワーク

    InnerString
    DBProxyConnectStringNetWorkType

    string

    データベースプロキシのネットワークタイプ。有効値：

    • 0：インターネット

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

    • 2：VPC

    2
    DBProxyConnectStringPort

    string

    プロキシ接続アドレスに関連付けられているポート。

    3306
    DBProxyEndpointId

    string

    バックエンドのプロキシ接続アドレスの ID。

    20****
    DBProxyEndpointName

    string

    プロキシ接続アドレスの名前。名前はプロキシ接続アドレスの ID に置き換えることができます。

    gos787jog2wk0ye1****
    DBProxyVpcId

    string

    データベースプロキシの VPC。

    vpc-uf6oobt****
    DBProxyVpcInstanceId

    string

    データベースプロキシインスタンスの ID。

    rm-bp145737x5****131161274792****
    DBProxyVswitchId

    string

    データベースプロキシの vSwitch。

    vsw-uf6l0pic17****
    DBProxyEngineType

    string

    内部パラメーターです。このパラメーターは無視できます。

    normal
    DBProxyInstanceCurrentMinorVersion

    string

    プロキシインスタンスのバージョン。

    1.13.11
    DBProxyInstanceLatestMinorVersion

    string

    プロキシインスタンスで利用可能な最新バージョン。

    1.13.12
    DBProxyInstanceName

    string

    プロキシインスタンスの名前。

    gos787jog2wk0ye1****
    DBProxyInstanceNum

    integer

    インスタンスで有効になっているプロキシの数。

    1
    DBProxyInstanceSize

    string

    このパラメーターは、ApsaraDB RDS for PostgreSQL インスタンスでのみ使用できます。有効になっているプロキシインスタンスの仕様。

    フォーマット：コア数/メモリ容量。

    たとえば、値が 4/8 の場合、プロキシインスタンスには 4 コアと 8 GB のメモリがあることを示します。

    4/8
    DBProxyInstanceStatus

    string

    プロキシインスタンスのステータス。

    • DBInstanceClassChanging：プロキシインスタンスの仕様が変更中です。

    • Creating：プロキシインスタンスは作成中です。

    • Running：プロキシインスタンスは実行中です。

    • Deleting：プロキシインスタンスは削除中です。

    Running
    DBProxyInstanceType

    string

    インスタンスで有効になっているデータベースプロキシのタイプ。有効値：

    • 1：共有データベースプロキシ

    • 2：専用データベースプロキシ

    • 3：汎用データベースプロキシ

    説明

    ApsaraDB RDS for PostgreSQL は共有データベースプロキシをサポートしていません。

    2
    DBProxyKindCode

    string

    内部パラメーターです。このパラメーターを指定する必要はありません。

    18
    DBProxyNodes

    object

    DBProxyNodes

    array<object>

    プロキシノード。

    object

    ノードリストの詳細。

    cpuCores

    string

    ノードの CPU コア数。

    2
    nodeId

    string

    プロキシノードの ID。

    pn-xxxxxxx01
    zoneId

    string

    ノードがデプロイされているゾーンの ID。

    cn-hangzhou-c
    DBProxyPersistentConnectionStatus

    string

    永続的接続のステータス。有効値：

    • Enabled

    • Disabled

    • Unsupported

    Disabled
    DBProxyServiceStatus

    string

    データベースプロキシのステータス。

    • Shutdown：無効

    • Startup：有効

    Startup
    DbProxyEndpointItems

    object

    DbProxyEndpointItems

    array<object>

    インスタンスのプロキシターミナル。

    object

    プロキシターミナルに関する情報。

    DbProxyEndpointAliases

    string

    プロキシ接続アドレスの説明。

    proxy-test
    DbProxyEndpointName

    string

    プロキシ接続アドレスの ID。

    gos787jog2wk0ye1****
    DbProxyEndpointType

    string

    プロキシ接続アドレスのタイプ。有効値：

    • Custom：カスタムプロキシ接続アドレス

    • RWSplit：デフォルトのプロキシ接続アドレス

    RWSplit
    DbProxyReadWriteMode

    string

    プロキシ接続アドレスの読み取り/書き込み属性。

    • ReadOnly

    • ReadWrite

    ReadWrite
    RequestId

    string

    リクエストの ID。

    909A69EE-71C8-4417-A0B9-FF085407E1E3
    ResourceGroupId

    string

    リソースグループの ID。

    rg-acfmy****
    DBProxyAVZones

    object

    DBProxyAVZones

    array

    データベースプロキシで利用可能なゾーンのリスト。

    string

    データベースプロキシで利用可能なゾーン。

    cn-shanghai-e

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    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.

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

    変更履歴

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