すべてのプロダクト
Search

このプロダクト

    ApsaraDB RDS:ModifyDBProxy

    ドキュメントセンター

    ApsaraDB RDS:ModifyDBProxy

    最終更新日:Apr 18, 2026

    インスタンスのデータベースプロキシ機能を有効化または変更します。

    操作説明

    サポートされるデータベースエンジン

    • MySQL

    • PostgreSQL

    説明

    2023 年 10 月 17 日より、RDS Cluster Edition を実行する ApsaraDB RDS for MySQL インスタンスでは、ユニットごとに 1 つの無料の専用データベースプロキシが段階的に提供されます。 詳細については、「[特別オファー/価格変更] RDS Cluster Edition の ApsaraDB RDS for MySQL インスタンスに専用プロキシを1つ無料で提供」をご参照ください。

    関連ドキュメント

    説明

    この操作を呼び出す前に、以下のトピックをお読みになり、この操作の前提条件と影響を十分に理解していることを確認してください。

    今すぐお試しください

    この 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:ModifyDBProxy

    update

    *DBInstance

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

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

    rm-uf6wjk5****
    ConfigDBProxyService

    string

    必須

    データベースプロキシ機能を有効にするか無効にするかを指定します。 有効な値：

    • Startup：機能を有効にします。

    • Shutdown：機能を無効にします。

    • Modify：機能の構成を変更します。

    Startup
    DBProxyInstanceNum

    string

    任意

    有効にするプロキシインスタンスの数。 有効な値：1～16。 デフォルト値：1。

    説明

    有効にするプロキシインスタンスの数を増やすと、データベースプロキシのリクエスト処理能力が向上します。 インスタンスの負荷を監視し、そのモニタリングデータに基づいて、適切な数のプロキシインスタンスを指定できます。

    1
    RegionId

    string

    任意

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

    cn-hangzhou
    InstanceNetworkType

    string

    任意

    インスタンスのネットワークタイプ。 VPC ネットワークタイプのみがサポートされています。 値を VPC に設定します。

    説明

    インスタンスのデータベースプロキシ機能を有効にする場合は、このパラメーターを指定する必要があります。

    VPC
    VPCId

    string

    任意

    インスタンスが属する VPC の ID。 DescribeDBInstanceAttribute 操作を呼び出して ID をクエリできます。

    説明

    インスタンスのデータベースプロキシ機能を有効にする場合は、このパラメーターを指定する必要があります。

    vpc-****
    VSwitchId

    string

    任意

    インスタンスが属する vSwitch の ID。 DescribeDBInstanceAttribute 操作を呼び出して ID をクエリできます。

    説明

    インスタンスのデータベースプロキシ機能を有効にする場合は、このパラメーターを指定する必要があります。

    vsw-****
    DBProxyEngineType

    string

    任意

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

    normal
    DBProxyInstanceType

    string

    任意

    データベースプロキシのタイプ。 有効な値：

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

    • exclusive (デフォルト)：専用データベースプロキシ

    exclusive
    DBInstanceId

    string

    必須

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

    rm-uf6wjk5****
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-acfmy****
    PersistentConnectionStatus

    string

    任意

    接続保持を有効にするかどうかを指定します。 有効な値：

    • Enabled

    • Disabled

    説明

    • このパラメーターは、MySQL を実行するインスタンスでのみ使用できます。

    • 接続保持を変更する場合は、ConfigDBProxyService パラメーターを Modify に設定する必要があります。

    Disabled
    DBProxyNodes

    array<object>

    任意

    プロキシノード。

    object

    任意

    プロキシノードの詳細。

    cpuCores

    string

    任意

    ノードの CPU コア数。 有効な値：1～16。

    説明

    このパラメーターは、DBProxyNodes パラメーターを設定する際に必須です。

    1
    nodeCounts

    string

    任意

    ゾーン内のプロキシノードの数。 有効な値：1 および 2。

    説明

    このパラメーターは、DBProxyNodes パラメーターを設定する際に必須です。

    2
    zoneId

    string

    任意

    ノードが存在するゾーンの ID。

    説明

    このパラメーターは、DBProxyNodes パラメーターを設定する際に必須です。

    cn-hangzhou-c

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

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

    RequestId

    string

    リクエスト ID。

    FC452BB1-EED8-4278-95C7-0324B3710DF1

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "FC452BB1-EED8-4278-95C7-0324B3710DF1"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 MaxscaleAlreadyExist The Maxscale is already existed.
    400 MaxscaleNotSupport Maxscale not supported
    400 NetWork.NotFound NetWork.NotFound
    400 InvalidVpcParameter Either VPC ID or vSwitch ID is incorrect. Please check again.
    400 MaxscaleInternalError Database proxy status is CLASS_CHANGING.
    400 InvalidDBInstanceName Specified parameter DBInstanceName is not valid.
    400 InvalidOptimizationCategory.Format Specified optimization category is not valid.
    400 MinorVersionNotSupport The current database minor version does not support the operation.
    400 InvalidParameters.Format Specified parameter is not valid
    400 InvalidTunnelId Specified conn tunnel is not valid.
    400 InvalidRegion.Format Specified Region is not valid.
    400 InvalidDBProxyNodes.General general-purpose proxy does not support more than 2 nodes.
    400 InvalidDBProxyNodes.ZoneIdAndNodeCounts The number of node count and zone count is mismatch.
    400 InvalidDBProxyNodes.ZoneId The number of zone is request 1 or 2.
    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.
    400 InvalidDBProxyNodes.ZoneIdNotUnique ZoneIds is not unique.
    400 MaxscaleServiceLinkedRole.NotFound Service linked role 'AliyunServiceRoleForRDSProxyOnEcs' not found.
    400 MappingInstanceLevel.NotFound Can not find the mapping instance level.
    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 InvalidConnVPCId Specified conn vpc id is not valid.
    403 IncorrectDBInstanceType The database instance type does not support the operation.
    403 IncorrectDBInstanceEngine Current DB Instance engine does not support this operation. 現在のインスタンスがロックされているため、この操作は一時的にサポートされません。
    403 IncorrectKindCode Current custins kindCode does not support this operation.
    403 IncorrectDBInstanceState Current DB instance state does not support this operation.
    403 InvalidVswitchId Specified conn vswitch id is not valid.
    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 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 MaxscaleCreating The relative maxscale instance is being created or deleted.
    404 Maxscale.NotFound The relative maxscale instance is not found.
    404 InvalidVSwitchId.NotFound The specified VSwitch is invalid.
    404 InvalidParam The parameter is invalid.
    404 InsufficientResourceCapacity The target availability zone does not have sufficient resources.
    404 InvalidDBInstance.NotFound The specified instance does not exist or is not supported.
    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.

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

    変更履歴

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