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

この API は、ApsaraDB RDS インスタンスのデータベースプロキシのパフォーマンスデータをクエリします。

操作説明

対応エンジン

RDS MySQL
RDS PostgreSQL

説明

2023年10月17日以降、ApsaraDB RDS MySQL Cluster Edition は、各エッジゾーンのインスタンスごとに無料の専用データベースプロキシを 1 つ順次提供します。詳細については、「特典： RDS MySQL Cluster Edition 向けの無料専用データベースプロキシ 1 つの提供」をご参照ください。

今すぐお試しください

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

get

*DBInstance

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。DescribeDBInstances オペレーションを呼び出して、インスタンス ID をクエリできます。	rm-t4n3a****
DBProxyInstanceType	string	任意	データベースプロキシインスタンスのタイプ。有効な値： common ：汎用データベースプロキシ exclusive ：専用データベースプロキシ	exclusive
StartTime	string	必須	クエリ対象の時間範囲の開始時刻。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC である必要があります。	2019-09-19T01:00:00Z
EndTime	string	必須	クエリ対象の時間範囲の終了時刻。終了時刻は開始時刻より後の時刻である必要があります。ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC である必要があります。	2019-09-21T18:00:00Z
RegionId	string	必須	リージョン ID。DescribeRegions オペレーションを呼び出して最新のリージョンリストをクエリできます。	cn-hangzhou
MetricsName	string	必須	クエリ対象のパフォーマンスメトリクス。インスタンスが MySQL を実行している場合、インスタンスの CPU 使用率を示す Maxscale_CpuUsage パフォーマンスメトリクスのみをクエリできます。インスタンスが PostgreSQL を実行している場合、以下のパフォーマンスメトリクスをクエリできます： Maxscale_TotalConns ：1 秒あたりの接続数 Maxscale_CurrentConns ：確立された接続数 Maxscale_DownFlows ：アウトバウンドトラフィック Maxscale_UpFlows ：インバウンドトラフィック Maxscale_QPS ：QPS Maxscale_MemUsage ：メモリ使用量 Maxscale_CpuUsage ：CPU 使用率複数のパフォーマンスメトリクスをクエリする場合は、各メトリクスをカンマ (,) で区切ります。1 回のリクエストで最大 6 つのパフォーマンスメトリクスを指定できます。	Maxscale_CpuUsage
DBInstanceId	string	必須	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-t4n3a****
DBProxyEngineType	string	任意	予約済みパラメーター。このパラメーターを指定する必要はありません。	normal
Dimension	string	任意	ディメンション。	service,node server,node service

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
EndTime	string	クエリの終了時刻。	2019-09-21T18:00:00Z
StartTime	string	クエリの開始時刻。	2019-09-19T01:00:00Z
DBInstanceId	string	インスタンス ID。	lsme****
RequestId	string	リクエスト ID。	DD31056F-A0CE-41D7-AD39-689B6ABAE982
DBProxyEngineType	string	内部パラメーター。このパラメーターを指定する必要はありません。	normal
PerformanceKeys	object
PerformanceKey	array<object>	パフォーマンスのリスト。
	array<object>	パフォーマンス情報。
ValueFormat	string	返されるパフォーマンスメトリックの値の形式。	docker_container_cpu
Key	string	パフォーマンスパラメーター。	cpu_ratio
Values	object
PerformanceValue	array<object>	パフォーマンスメトリクス。
	object	パフォーマンスの値の詳細。
Date	string	パフォーマンスメトリックの値が記録された日時。時刻は ISO 8601 規格に準拠したyyyy-MM-ddTHH:mm:ssZ 形式です。時刻は UTC で表示されます。	2019-10-10T09:00:00Z
Value	string	パフォーマンスメトリックの値。	2.83
Service	string	サービスディメンション。	mr-xxx
Node	string	プロキシノード ID。	pn-xxx
Server	string	データベースノード ID。	rn-xxx

例

成功レスポンス

JSONJSON

{
  "EndTime": "2019-09-21T18:00:00Z",
  "StartTime": "2019-09-19T01:00:00Z",
  "DBInstanceId": "lsme****",
  "RequestId": "DD31056F-A0CE-41D7-AD39-689B6ABAE982",
  "DBProxyEngineType": "normal",
  "PerformanceKeys": {
    "PerformanceKey": [
      {
        "ValueFormat": "docker_container_cpu",
        "Key": "cpu_ratio",
        "Values": {
          "PerformanceValue": [
            {
              "Date": "2019-10-10T09:00:00Z",
              "Value": "2.83"
            }
          ]
        },
        "Service": "mr-xxx",
        "Node": "pn-xxx",
        "Server": "rn-xxx"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidDBInstanceName	Specified parameter DBInstanceName is not valid.
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	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.
400	NoAvailablePaymentMethod	No payment method is specified for account. We recommend that you add a payment method.
400	InvalidTargetEntity.Malformed	the specified target entity is not found.
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	ParamNotFound	The parameter is not found for the interface.
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	Endpoint.NotFound	Specified endpoint is not found.
404	InvalidDBInstanceName.NotFound	The DBInstanceId provided does not exist in our records.
404	Maxscale.NotFound	The relative maxscale instance is not found.
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.
408	InvalidOthers.Timeout	Query timed out.Please try again or narrow down the query scope.	リクエストタイムアウトです。再試行するか、時間の範囲を縮小してください

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

変更履歴

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

ApsaraDB RDS:DescribeDBProxyPerformance