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

DescribeCloudBenchTasks 操作を呼び出して、ストレステストタスクをクエリできます。

操作説明

Database Autonomy Service (DAS) は、サービストラフィックのピークを処理するためにインスタンスをスケールアウトする必要があるかどうかを判断するのに役立つ、インテリジェントなストレステスト機能を提供します。詳細については、「インテリジェントストレステスト」をご参照ください。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

hdm:DescribeCloudBenchTasks

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Status	string	任意	タスクのステータス。有効な値: SUCCESS: タスクは成功です。 IGNORED: タスクは無視されます。 RUNNING: タスクは実行中です。 EXCEPTION: タスクは異常です。	SUCCESS
TaskType	string	任意	ストレステストタスクのタイプ。有効な値: pressure test (デフォルト): ソースインスタンスからキャプチャされたトラフィックを、宛先インスタンスでサポートされている最大再生レートで宛先インスタンスに再生するストレステストタスク。 smart pressure test: 連続ストレステストを実行するために生成されるストレステストタスク。タスクは、短期間にソースインスタンスからキャプチャされたトラフィックを分析し、ビジネスモデルとトラフィック分布の点でソースインスタンスのトラフィックに類似したトラフィックを生成します。これにより、ソースインスタンスからデータを収集するために必要な時間が短縮され、ストレージとパフォーマンスのコストが削減されます。	pressure test
StartTime	string	任意	クエリ対象の期間の開始時刻。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。	1596177993000
EndTime	string	任意	クエリ対象の期間の終了時刻。この値は、1970 年 1 月 1 日 00:00:00 UTC から経過したミリ秒数を表す UNIX タイムスタンプです。説明終了時刻は、開始時刻よりも後である必要があります。	1596177993001
PageNo	string	任意	ページ番号。値は正の整数である必要があります。デフォルト値: 1。	1
PageSize	string	任意	各ページに戻されるエントリの数。値は正の整数である必要があります。デフォルト値: 10。	10

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	返された HTTP ステータスコード。	200
Message	string	返されたデータ。説明リクエストが成功した場合、Successful が返されます。リクエストが失敗した場合、エラーコードなどのエラーメッセージが返されます。	Successful
RequestId	string	リクエスト ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	リクエストが成功したかどうかを示します。有効な値: true: リクエストは成功しました。 false: リクエストは失敗しました。	true
Data	object	返されたエントリの総数とエラーコードを含む詳細情報。
PageNo	integer	ページ番号。	1
PageSize	integer	各ページに返されるエントリの数。	10
Extra	string	予約パラメータ。	None
Total	integer	返されたエントリの総数。	2
List	object
cloudbenchTasks	array<object>	ストレステストタスクに関する詳細情報。
	object
DtsJobName	string	DTS タスクの名前。	RDS间迁移
ErrorMessage	string	タスクが失敗した場合に返されるエラーメッセージ。	DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\n\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].
External	string	追加情報。	Null
BackupType	string	バックアップタイプ。有効な値: TIMESTAMP: 時間によるバックアップ。 BACKUPID: バックアップセット ID によるバックアップ。	TIMESTAMP
UserId	string	Alibaba Cloud アカウントの ID。	1091411816252****
DstType	string	宛先インスタンスのタイプ。有効な値: Instance (デフォルト): ID で指定されたインスタンス。 ConnectionString: エンドポイントで指定されたインスタンス。	Instance
EcsInstanceId	string	ECS インスタンスの ID。	i-bp1ecr5go2go1****
DstInstanceUuid	string	宛先インスタンスの一意の ID。	hdm_d887b5ccf99fa0dc9a1e5aaac368****
TaskType	string	ストレステストタスクのタイプ。有効な値: pressure test (デフォルト): ソースインスタンスからキャプチャされたトラフィックを、宛先インスタンスでサポートされている最大再生レートで宛先インスタンスに再生するストレステストタスク。 smart pressure test: 連続ストレステストを実行するために生成されるストレステストタスク。タスクは、短期間にソースインスタンスからキャプチャされたトラフィックを分析し、ビジネスモデルとトラフィック分布の点でソースインスタンスのトラフィックに類似したトラフィックを生成します。これにより、ソースインスタンスからデータを収集するために必要な時間が短縮され、ストレージとパフォーマンスのコストが削減されます。	pressure test
BenchStep	string	ストレステストタスクのサブステップ。有効な値: NEW: タスクは初期化中です。 WAIT_BUY_ECS: ECS インスタンスが購入中です。 WAIT_START_ECS: ECS インスタンスが起動中です。 WAIT_INSTALL_JDK: JDK がインストール中です。 WAIT_INSTALL_DBGATEWAY: DBGateway がインストール中です。 ADD_SECURITY_IPS_STEP: セキュリティグループのホワイトリストが構成中です。 ARCHIVE: フル SQL データがアーカイブ中です。 DOWNLOAD: フル SQL ファイルがダウンロード中です。 PROCEED: フル SQL ファイルが前処理されています。 PRE_LOAD: フル SQL ファイルがプリロードされています。 VALIDATE: 機能が検証中です。 PRESSURE: パフォーマンスがテスト中です。	PROCEED
Version	string	ストレステストタスクのバージョン。有効な値: V2.0 V3.0	V3.0
EndState	string	完了後のストレステストタスクの状態。有効な値: WAIT_TARGET: ストレステストの宛先インスタンスが準備中です。 WAIT_DBGATEWAY: ストレステストのデプロイメントが準備中です。 WAIT_SQL: フル SQL データが準備中です。 WAIT_LOGIC: トラフィック再生が準備中です。説明ストレステストタスクが EndState パラメータで指定された状態になると、タスクは完了します。	WAIT_TARGET
SrcInstanceUuid	string	ソースインスタンスの一意の ID。	hdm_3063db6792965c080a4bcb6e6304****
ClientType	string	ストレステストクライアントのタイプ。有効な値: ECS: データベースゲートウェイを準備する必要があります。 DAS_ECS: DAS は ECS インスタンスを自動的に購入してデプロイします。	ECS
State	string	ストレステストタスクの状態。有効な値: WAIT_TARGET: ストレステストの宛先インスタンスが準備中です。 WAIT_DBGATEWAY: ストレステストのデプロイメントが準備中です。 WAIT_SQL: フル SQL データが準備中です。 WAIT_LOGIC: トラフィック再生が準備中です。	WAIT_TARGET
DstIp	string	予約パラメータ。	None
SrcPublicIp	string	予約パラメータ。	None
BackupId	string	バックアップセット ID。DescribeBackups 操作を呼び出して、バックアップリストをクエリできます。	229132
SqlCompleteReuse	string	再利用されるフル SQL 文に関する情報。	{"sqlUuid":"task_a37d2f07-45cb-4413-a2a6-c66c68**","metaUuid":"task_211e2561-5c0c-486b-864c-56b511**","sqlFile":"cl-1620057600000-1800626.sc","metaFile":"cl-1620057600000-1800626.meta"}
SmartPressureTime	integer	生成されたストレステストタスクの期間。単位: ミリ秒。	86400000
ArchiveState	integer	SQL データアーカイブのステータス。有効な値: 0: 開始されていません。 1: 完了。 2: エラー。 3: 実行中。 4: ダウンロードは不要です。	1
Status	string	ストレステストタスクのステータス。有効な値: SUCCESS: タスクは成功です。 IGNORED: タスクは無視されます。 RUNNING: タスクは実行中です。 EXCEPTION: タスクは異常です。	RUNNING
WorkDir	string	ストレステスト用に生成された一時ディレクトリ。	/tmp/bench/
ArchiveOssTableName	string	OSS でデータをアーカイブするテーブルの名前。	custins15546355_161604665****
DtsJobId	string	DTS データ移行タスクの ID。	i03e3zty16i****
DtsJobState	integer	DTS タスクのステータス。有効な値: NOT_STARTED: タスクは開始されていません。 PRE_CHECKING: タスクは事前チェック中です。 PRE_CHECK_FAILED: 事前チェックは失敗しました。 CHECKING: タスクはチェック中です。 MIGRATING: タスクは進行中です。 CATCHED: 宛先インスタンスはソースインスタンスに追いつきました。 SUSPENDING: タスクは一時停止中です。 MIGRATION_FAILED: 移行は失敗しました。 FINISHED: タスクは完了です。 INITIALIZING: タスクは同期の初期化中です。 INITIALIZE_FAILED: 同期の初期化は失敗しました。 SYNCHRONIZING: タスクは同期中です。 MODIFYING: 同期オブジェクトが変更中です。 SWITCHING: タスクは切り替え中です。 FAILED: タスクは失敗しました。	CHECKING
DstPort	integer	宛先インスタンスのポート番号。	3306
DtsJobClass	string	DTS タスクの仕様。説明データ移行タスクの仕様とパフォーマンスの詳細については、「データ移行タスクの仕様」をご参照ください。	medium
ClientGatewayId	string	ストレステストクライアントのデータベースゲートウェイの ID。	58598b2af48a0193dfc16fc6964ef****
Description	string	ストレステストタスクの説明。	test-das-bench-0501
ErrorCode	string	内部ストレステストタスクに対して返されるエラーコード。	10109
TableSchema	string	ストレステストに関係するテーブルの名前。	[{"TABLE_NAME":"customer1","TABLE_SCHEMA":"tpcc"}]
DtsJobStatus	string	DTS タスクのステータス。有効な値: NOT_STARTED: タスクは開始されていません。 PRE_CHECKING: タスクは事前チェック中です。 PRE_CHECK_FAILED: 事前チェックは失敗しました。 CHECKING: タスクはチェック中です。 MIGRATING: タスクは進行中です。 CATCHED: 宛先インスタンスはソースインスタンスに追いつきました。 SUSPENDING: タスクは一時停止中です。 MIGRATION_FAILED: 移行は失敗しました。 FINISHED: タスクは完了です。 INITIALIZING: タスクは同期の初期化中です。 INITIALIZE_FAILED: 同期の初期化は失敗しました。 SYNCHRONIZING: タスクは同期中です。 MODIFYING: 同期オブジェクトが変更中です。 SWITCHING: タスクは切り替え中です。 FAILED: タスクは失敗しました。	PRE_CHECK_FAILED
SrcInstanceArea	string	ソースインスタンスのデータベースタイプ。	RDS
BenchStepStatus	string	ストレステストのサブステップのステータス。有効な値: NEW: タスクは初期化中です。 RUNNING: タスクは実行中です。 FAILED: タスクは失敗しました。 FINISHED: タスクは完了です。 Terminated: タスクは終了しました。 Deleted: タスクは削除されました。	FINISHED
Source	string	タスクのソース。有効な値: DAS OPEN_API	DAS
ArchiveJobId	string	データアーカイブタスクの ID。	'202105211430070112231480820340758****
Topic	string	Kafka のコンシューマートピック。	das
RequestDuration	integer	ストレステストタスクの期間。単位: ミリ秒。	86400000
TaskId	string	タスク ID。	e5cec704-0518-430f-8263-76f4dcds****
Rate	integer	宛先インスタンスでのソースインスタンスからのトラフィックの再生レート。再生レートは正の整数である必要があります。有効な値: 0 から 30。デフォルト値: 1。	1

例

成功レスポンス

JSONJSON

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": {
    "PageNo": 1,
    "PageSize": 10,
    "Extra": "None",
    "Total": 2,
    "List": {
      "cloudbenchTasks": [
        {
          "DtsJobName": "RDS间迁移",
          "ErrorMessage": "DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\\n\\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].",
          "External": "Null",
          "BackupType": "TIMESTAMP",
          "UserId": "1091411816252****",
          "DstType": "Instance",
          "EcsInstanceId": "i-bp1ecr5go2go1****",
          "DstInstanceUuid": "hdm_d887b5ccf99fa0dc9a1e5aaac368****",
          "TaskType": "pressure test",
          "BenchStep": "PROCEED",
          "Version": "V3.0",
          "EndState": "WAIT_TARGET",
          "SrcInstanceUuid": "hdm_3063db6792965c080a4bcb6e6304****",
          "ClientType": "ECS",
          "State": "WAIT_TARGET",
          "DstIp": "None",
          "SrcPublicIp": "None",
          "BackupId": "229132",
          "SqlCompleteReuse": "{\"sqlUuid\":\"task_a37d2f07-45cb-4413-a2a6-c66c68****\",\"metaUuid\":\"task_211e2561-5c0c-486b-864c-56b511****\",\"sqlFile\":\"cl-1620057600000-1800626.sc\",\"metaFile\":\"cl-1620057600000-1800626.meta\"}",
          "SmartPressureTime": 86400000,
          "ArchiveState": 1,
          "Status": "RUNNING",
          "WorkDir": "/tmp/bench/",
          "ArchiveOssTableName": "custins15546355_161604665****",
          "DtsJobId": "i03e3zty16i****",
          "DtsJobState": 0,
          "DstPort": 3306,
          "DtsJobClass": "medium",
          "ClientGatewayId": "58598b2af48a0193dfc16fc6964ef****",
          "Description": "test-das-bench-0501",
          "ErrorCode": "10109",
          "TableSchema": "[{\"TABLE_NAME\":\"customer1\",\"TABLE_SCHEMA\":\"tpcc\"}]",
          "DtsJobStatus": "PRE_CHECK_FAILED",
          "SrcInstanceArea": "RDS",
          "BenchStepStatus": "FINISHED",
          "Source": "DAS",
          "ArchiveJobId": "'202105211430070112231480820340758****",
          "Topic": "das",
          "RequestDuration": 86400000,
          "TaskId": "e5cec704-0518-430f-8263-76f4dcds****",
          "Rate": 1
        }
      ]
    }
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

変更履歴

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