DescribeDBInstanceNetInfo - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

インスタンスのすべてのエンドポイントを照会します。

操作説明

サポートされるデータベースエンジン

MySQL
PostgreSQL
SQL Server
MariaDB

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:DescribeDBInstanceNetInfo

get

*DBInstance

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークンです。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。	ETnLKlblzczshOTUbOC****
DBInstanceId	string	必須	インスタンス ID。DescribeDBInstances 操作を呼び出して、インスタンス ID を照会できます。	rm-uf6wjk5****
Flag	integer	任意	予約済みのパラメーターです。このパラメーターを指定する必要はありません。	test
DBInstanceNetRWSplitType	string	任意	エンドポイントのタイプ。有効値： Normal：通常のエンドポイント ReadWriteSplitting：読み書き分離エンドポイント説明デフォルトでは、システムは両方のタイプのエンドポイントを返します。	Normal
GeneralGroupName	string	任意	インスタンスが属する専用クラスターの名前。このパラメーターは、インスタンスが RDS Standard Edition で MySQL を実行し、専用クラスターで作成されている場合にのみ有効です。	rgc-2ze****

レスポンスフィールド

フィールド	型	説明	例
	object
DBInstanceNetInfos	object
DBInstanceNetInfo	array<object>	インスタンスのエンドポイントに関する情報。
	array<object>
BabelfishPort	string	Babelfish が有効になっているインスタンスの Tabular Data Stream (TDS) ポート。説明このパラメーターは、ApsaraDB RDS for PostgreSQL インスタンスにのみ適用されます。ApsaraDB RDS for PostgreSQL の Babelfish の詳細については、「Babelfish の概要」をご参照ください。	1433
ConnectionString	string	インスタンスのエンドポイント。	rm-uf6w****.mysql.rds.aliyuncs.com
ConnectionStringType	string	エンドポイントのタイプ。有効値： Normal：通常のエンドポイント ReadWriteSplitting：読み書き分離エンドポイント	Normal
DBInstanceWeights	object
DBInstanceWeight	array<object>	インスタンスの重みに関する情報。説明このパラメーターは、インスタンスで読み書き分離機能が有効になっている場合にのみ返されます。
	object
Availability	string	インスタンスの可用性。有効値： Unavailable Available	Unavailable
DBInstanceId	string	インスタンス ID。	rm-uf6wjk5****
DBInstanceType	string	インスタンスのタイプ。有効値： Master：プライマリインスタンス Readonly：読み取り専用インスタンス	Master
Role	string	非推奨のパラメーターです。	无
Weight	string	インスタンスの重み。	100
DistributionType	string	読み取り重みを割り当てるために使用されるポリシー。このパラメーターは、読み書き分離エンドポイントに対してのみ返されます。有効値： Standard：システムは、インスタンスの仕様に基づいて、インスタンスとその読み取り専用インスタンスに読み取り重みを自動的に割り当てます。 Custom：インスタンスとその読み取り専用インスタンスに手動で読み取り重みを割り当てる必要があります。	Standard
ExpiredTime	string	ハイブリッドアクセスモードのクラシックネットワークにおけるインスタンスの残りの有効期間。単位：秒。	1209534
IPAddress	string	IP アドレス。	192.168.XX.XX
IPType	string	ネットワークタイプ。インスタンスがクラシックネットワークにある場合の有効値： Inner Public インスタンスが Virtual Private Cloud (VPC) にある場合の有効値： Private Public	Public
MaxDelayTime	string	レイテンシーしきい値。このパラメーターは、読み書き分離エンドポイントに対してのみ返されます。単位：秒。説明読み取り専用インスタンスのレイテンシーが指定されたしきい値を超えた場合、ApsaraDB RDS は読み取りリクエストをその読み取り専用インスタンスに転送しなくなります。	12
PGBouncerPort	string	PgBouncer ポート。説明このパラメーターは、PostgreSQL を実行するインスタンスで PgBouncer が有効になっている場合にのみ返されます。	6432
Port	string	インスタンスへの接続に使用されるポート。	3306
SecurityIPGroups	object
securityIPGroup	array<object>	インスタンスのホワイトリスト内の IP アドレス。
	object
SecurityIPGroupName	string	IP アドレスホワイトリストの名前。	Default
SecurityIPs	string	ホワイトリスト内の IP アドレス。	127.0.XX.XX
Upgradeable	string	IP バージョンを更新できるかどうかを示します。有効値： Enable Disabled 説明 IP バージョンは IPv4 から IPv6 に更新できます。	Disabled
VPCId	string	インスタンスの VPC ID。	vpc-uf6f7l4fg90*****
VSwitchId	string	vSwitch ID。	vsw-uf6adz52c2p****
InstanceNetworkType	string	インスタンスのネットワークタイプ。有効値： Classic：クラシックネットワーク VPC：Virtual Private Cloud (VPC)	VPC
RequestId	string	リクエストの ID。	777C4593-8053-427B-99E2-105593277CAB
SecurityIPMode	string	インスタンスのホワイトリストモード。有効値： normal：標準ホワイトリストモード safety：高セキュリティホワイトリストモード	safety

例

成功レスポンス

JSONJSON

{
  "DBInstanceNetInfos": {
    "DBInstanceNetInfo": [
      {
        "BabelfishPort": "1433",
        "ConnectionString": "rm-uf6w****.mysql.rds.aliyuncs.com",
        "ConnectionStringType": "Normal",
        "DBInstanceWeights": {
          "DBInstanceWeight": [
            {
              "Availability": "Unavailable",
              "DBInstanceId": "rm-uf6wjk5****",
              "DBInstanceType": "Master",
              "Role": "无",
              "Weight": "100"
            }
          ]
        },
        "DistributionType": "Standard",
        "ExpiredTime": "1209534",
        "IPAddress": "192.168.XX.XX",
        "IPType": "Public",
        "MaxDelayTime": "12",
        "PGBouncerPort": "6432",
        "Port": "3306",
        "SecurityIPGroups": {
          "securityIPGroup": [
            {
              "SecurityIPGroupName": "Default",
              "SecurityIPs": "127.0.XX.XX"
            }
          ]
        },
        "Upgradeable": "Disabled",
        "VPCId": "vpc-uf6f7l4fg90*****",
        "VSwitchId": "vsw-uf6adz52c2p****"
      }
    ]
  },
  "InstanceNetworkType": "VPC",
  "RequestId": "777C4593-8053-427B-99E2-105593277CAB",
  "SecurityIPMode": "safety"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	TimeoutRetryLater	Timeout, retry later.
400	InvalidDBInstanceName.NotFound	DB instance name not found.
400	IllegalParameter	Illegal parameter
400	Readins.NotFound	Readonly instance not found.
400	MissingRWSplistParam	Custins is missing rw split param.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

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

変更履歴

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