すべてのプロダクト
Search
ドキュメントセンター

PolarDB:ModifyCustomEndpoint

最終更新日:Sep 10, 2026

カスタムエンドポイントの構成を変更します。

操作説明

PolarDB-X では、デフォルトのプライマリエンドポイントおよび読み取り専用エンドポイントに加えて、カスタムエンドポイントを作成して、より柔軟な読み書き分離、負荷分散、またはビジネス隔離戦略を実装できます。ModifyCustomEndpoint 操作を使用すると、インスタンスを再起動せずにこれらのカスタムエンドポイントの属性を動的に調整できます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardbx:ModifyCustomEndpoint

update

*PolarDBXInstance。

acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}

なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

RegionId

string

任意

インスタンスが属するリージョンの ID。

cn-zhangjiakou

DBInstanceName

string

必須

インスタンス ID。

mydatabase

CustomEndpointId

string

必須

カスタムエンドポイントの ID。

cep-002

Name

string

任意

名前。

セカンダリエンドポイント

NodeIds

string

任意

ノード ID。

ノード3

NodeAutoEnter

boolean

任意

ノードの追加または復旧後、ノードが自動的にクラスターに参加してサービスの提供を開始するかどうかを指定します。

true

NodeRole

string

任意

ノードのロール。

master

レスポンスフィールド

フィールド

型

説明

例

object

レスポンススキーマ。

RequestId

string

リクエスト ID。

1A586DCB-39A6-4050-81CC-C7BD4CCDB49F

例

成功レスポンス

JSONJSON

{
  "RequestId": "1A586DCB-39A6-4050-81CC-C7BD4CCDB49F"
}

エラーコード

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

変更履歴

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