すべてのプロダクト
Search

このプロダクト

    :ModifyDBEndpointAddress

    ドキュメントセンター

    :ModifyDBEndpointAddress

    最終更新日:Dec 11, 2025

    PolarDB クラスターのエンドポイント (プライマリエンドポイント、デフォルトのクラスターエンドポイント、カスタムクラスターエンドポイント、プライベートドメイン名など) を変更します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    polardb:ModifyDBEndpointAddress

    update

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBClusterId

    string

    必須

    クラスター ID。

    説明

    DescribeDBClusters 操作を呼び出して、ご利用のアカウント内のすべてのクラスター (クラスター ID を含む) の詳細をクエリできます。

    pc-***************
    DBEndpointId

    string

    必須

    エンドポイント ID。

    説明

    DescribeDBClusterEndpoints 操作を呼び出して、エンドポイント ID をクエリできます。

    pe-****************
    NetType

    string

    必須

    エンドポイントのネットワークタイプ。有効な値：

    • Public：パブリックネットワーク。

    • Private：プライベートネットワーク。

    Public
    ConnectionStringPrefix

    string

    任意

    エンドポイントの新しいプレフィックス。プレフィックスは、次の要件を満たす必要があります：

    • 小文字、数字、ハイフン (-) で構成する必要があります。

    • 先頭は英字、末尾は英数字である必要があります。

    • 長さは 6～30 文字である必要があります。

    example
    PrivateZoneAddressPrefix

    string

    任意

    プライベートドメイン名のプレフィックス。プレフィックスは、次の要件を満たす必要があります：

    • 小文字、数字、ハイフン (-) で構成する必要があります。

    • 先頭は英字、末尾は英数字である必要があります。

    • 長さは 6～30 文字である必要があります。

    説明

    • PolarDB クラスターの各プライベートエンドポイントにプライベートドメイン名をアタッチできます。ドメイン名は、現在のリージョン内の指定された VPC (Virtual Private Cloud) でのみ有効になります。プライベートドメイン名は PrivateZone を使用して管理されます。これらは、CNAME (Canonical Name) レコードを使用して PolarDB クラスターのプライベートエンドポイントにマッピングされます。PrivateZone はこの機能に対して少額の料金を請求します。詳細については、「料金」をご参照ください。

    • このパラメーターは、NetType が Private に設定されている場合にのみ有効です。

    aliyundoc
    PrivateZoneName

    string

    任意

    プライベートドメインゾーンの名前。

    説明

    このパラメーターは、NetType が Private に設定されている場合にのみ有効です。

    aliyundoc.com
    Port

    string

    任意

    ポート番号。有効な値：3000～5999。

    説明

    • このパラメーターは、PolarDB for MySQL クラスターでのみサポートされます。このパラメーターを空のままにした場合、デフォルトのポート番号 3306 が使用されます。

    3306

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    D0CEC6AC-7760-409A-A0D5-E6CD86******

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

    エラーレスポンス

    JSONJSON

    {
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC"
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 DnsConflict ParamsError.DnsConflict(Dns is already used, ConnAddrCust:%s).
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records.

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

    変更履歴

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