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

ユーザー定義のカスタムドメインのリストを照会します。

操作説明

この操作は、ユーザーが設定したカスタムエンドポイントのリストを取得し、非公開接続または VPC エンドポイントサービスの設定の管理と表示を容易にします。

今すぐお試しください

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

list

*PolarDBXInstance。

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	インスタンスが存在するリージョン。	cn-hangzhou
DBInstanceName	string	必須	インスタンスの名前。	pxc-xxx
CustomEndpointIds	string	任意	カスタムエンドポイントの ID。	pxe-b6e****no4pfap1s
CheckDeleteCN	boolean	任意	CN ノードが削除されているかどうかを確認するかどうかを指定します。	true

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。	6352AC16-76BF-5135-B1EA-ED49293526E6
Data	object	データ構造体。
CanDeleteCount	integer	ノードを削除できるかどうかを示します。	0
Endpoints	array<object>	エンドポイントの詳細。
	object	エンドポイントの詳細。
CustomEndpointId	string	カスタムエンドポイントの ID。	pxe-b6e****o4pfap1s
Name	string	カスタムエンドポイントの名前。	Name
DBInstanceName	string	インスタンスの ID。	pxc-hz****zoxherr7
ConnectionString	string	インスタンスのエンドポイント。	pxc-shra****zq0j01.polarx.rds.aliyuncs.com
Port	integer	インスタンスへの接続に使用されるポート。	3306
VpcId	string	エンドポイントが存在する仮想非公開クラウド（VPC）の ID。	vpc-uf61h****dj1zg5fqp5x7
VSwitchId	string	vSwitch の ID。	vsw-8vbkw****5yh4nrd639ih
NodeAutoEnter	string	ノードが追加または復旧された後、自動的にクラスターに参加してサービスの提供を開始するかどうかを示します。	true
NodeRole	string	クラウドネイティブの読み取り/書き込み分離アーキテクチャインスタンスの読み取り専用ノードのメトリクスをクエリするには、このパラメーターを READONLY にセットし、NodeId パラメーターを指定します。説明その他の場合、このパラメーターを指定する必要はありません。または MASTER にセットできます。	same_azone_as_last
CnNames	array	["pxc-i-vb1sqa7llp","pxc-i-bemprx50ad"]。
	string	文字列。	string
Status	string	カスタムエンドポイントのステータス。	created

例

成功レスポンス

JSONJSON

{
  "RequestId": "6352AC16-76BF-5135-B1EA-ED49293526E6",
  "Data": {
    "CanDeleteCount": 0,
    "Endpoints": [
      {
        "CustomEndpointId": "pxe-b6e****o4pfap1s",
        "Name": "Name",
        "DBInstanceName": "pxc-hz****zoxherr7",
        "ConnectionString": "pxc-shra****zq0j01.polarx.rds.aliyuncs.com",
        "Port": 3306,
        "VpcId": "vpc-uf61h****dj1zg5fqp5x7",
        "VSwitchId": "vsw-8vbkw****5yh4nrd639ih",
        "NodeAutoEnter": "true",
        "NodeRole": "same_azone_as_last",
        "CnNames": [
          "string"
        ],
        "Status": "created"
      }
    ]
  }
}

エラーコード

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

変更履歴

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