CreateCustomEndpoint - PolarDB - Alibaba Cloud ドキュメントセンター

操作説明

今すぐお試しください

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

create

*PolarDBXInstance。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceName	string	必須	インスタンスの ID。	pxc-hzjasd****
Name	string	必須	アクセスの制御インスタンスの名前。名前の長さは 2～128 文字で、先頭は英字または漢字である必要があります。数字、アンダースコア (_)、ハイフン (-) を含めることができます。	ext-win-live-17
VpcId	string	必須	エンドポイントが属する仮想非公開クラウド (VPC) の ID。	vpc-bp1ndoug37dtwoedlmru0
VSwitchId	string	必須	vSwitch の ID。	vsw-*********
NodeIds	string	必須	RemindUnit (オブジェクトタイプ) が NODE (ノード) にセットされている場合に監視されるノードの ID。複数の ID はコンマ (,) で区切ります。単一のルールで最大値 50 個のノードを監視できます。	r-bp1l5kfgw8****c3iv
NodeAutoEnter	boolean	必須	ノードが追加または復旧された後、自動的にクラスターに参加してサービスの提供を開始するかどうかを指定します。	true
NodeRole	string	任意	クラウドネイティブ読み書き分離アーキテクチャのインスタンスにおける読み取り専用ノードのメトリクスをクエリするには、このパラメーターに READONLY を指定し、特定の NodeId も指定します。説明それ以外の場合は、このパラメーターを指定する必要がないか、MASTER を指定できます。	READONLY
RegionId	string	任意	インスタンスが属するリージョン。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエストの ID。	2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9
Data	object	返されたデータ。
CustomEndpointId	string	エンドポイントの ID。	pxe-c4gkgqg****7sgyg
DBInstanceName	string	インスタンスの ID。	pxc-*********

例

成功レスポンス

JSONJSON

{
  "RequestId": "2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9",
  "Data": {
    "CustomEndpointId": "pxe-c4gkgqg****7sgyg",
    "DBInstanceName": "pxc-*********"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	CustomEndpoint.ExceedLimit	the count of custom endpoints can not exceed limiting value.

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

変更履歴

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