DescribeReplicaSetRole API 概要 - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

MongoDB インスタンスのロール情報と接続詳細を取得します。

操作説明

この操作は、レプリカセットインスタンスとシングルノードインスタンスに適用されます。シャードクラスターインスタンスには適用されません。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:DescribeReplicaSetRole

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。	dds-bpxxxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータ。
RequestId	string	リクエスト ID。	DB4A0595-FCA9-437F-B2BB-25DBFC009D3E
DBInstanceId	string	インスタンス ID。	dds-bpxxxxxxxx
ReplicaSets	object	レプリカセットの詳細。
ReplicaSet	array<object>	レプリカセット内のノードのリスト。
	object	ノードの詳細。
ConnectionPort	string	ノードの接続ポート。	3717
ReplicaSetRole	string	レプリカセットにおけるノードのロール。 Primary：プライマリノード。 Secondary：セカンダリノード。	Primary
ExpiredTime	string	クラシックネットワークのエンドポイントが有効期限切れになるまでの残り時間 (秒)。	1209582
ConnectionDomain	string	ノードの接続エンドポイント。	dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
NetworkType	string	エンドポイントのネットワークタイプ。 VPC：VPC。 Classic：クラシックネットワーク。 Public：パブリックネットワーク。	VPC
RoleId	string	ノードのロール ID。	651xxxxx
ConnectionType	string	接続タイプ。	SRV
ConnectionStringSuffix	string	接続文字列のドメイン名サフィックス。	.mongodb.rds.aliyuncs.com

例

成功レスポンス

JSONJSON

{
  "RequestId": "DB4A0595-FCA9-437F-B2BB-25DBFC009D3E",
  "DBInstanceId": "dds-bpxxxxxxxx",
  "ReplicaSets": {
    "ReplicaSet": [
      {
        "ConnectionPort": "3717",
        "ReplicaSetRole": "Primary",
        "ExpiredTime": "1209582",
        "ConnectionDomain": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
        "NetworkType": "VPC",
        "RoleId": "651xxxxx",
        "ConnectionType": "SRV"
      }
    ]
  },
  "ConnectionStringSuffix": ".mongodb.rds.aliyuncs.com\n"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
403	Forbidden	User not authorized to operate on the specified resource.

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

変更履歴

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