DescribeCloudbenchTask による特定のストレステストタスクのクエリ - DAS

特定のストレステストタスクを照会します。

操作説明

この API を呼び出すと、タスクのステータス、タイプ、タイムスタンプに基づいて特定のストレステストタスクを取得できます。これにより、ご利用のインスタンスがトラフィックスパイクを効果的に処理するためにスケールアップが必要かどうかを確認できます。詳細については、「インテリジェントストレステスト」をご参照ください。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskId	string	必須	一意のタスク ID です。DescribeCloudBenchTasks API を呼び出してタスク ID を取得できます。	e5cec704-0518-430f-8263-76f4dcds****

レスポンスフィールド

フィールド	型	説明	例
	object
Code	string	返された状態コードです。	200
Message	string	返されたメッセージです。説明リクエストが成功した場合、このパラメーターは Successful を返します。リクエストが失敗した場合、このパラメーターはエラーコードなどの例外情報を返します。	Successful
RequestId	string	リクエスト ID です。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	リクエストが成功したかどうかを示します。 true：リクエストが成功しました。 false：リクエストが失敗しました。	true
Data	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 です。	109141182625****
DstType	string	宛先インスタンスのタイプです。有効な値は以下のとおりです。 Instance（デフォルト）：インスタンス ID。 ConnectionString：インスタンスのエンドポイント。	Instance
EcsInstanceId	string	ECS インスタンス ID です。	i-bp1ecr5go2go1****
DstInstanceUuid	string	宛先インスタンスの一意識別子です。	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：Database Gateway をインストール。 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_LOGIC
SrcInstanceUuid	string	ソースインスタンスの一意識別子です。	a364e414-e68b-4e5c-9166-65b3a153****
ClientType	string	ストレステストマシンのタイプです。有効な値は以下のとおりです。 ECS：ご自身で Database Gateway を準備する必要があります。 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-**-a2a6-c66c62","metaUuid":"task_211e2561-5c0c-486b-864c-56b511","sqlFile":"cl-1620057600000-1800626.sc","metaFile":"cl-1620057600000-180**.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	内部ストレステストタスクから返されたエラーコードです。	10910
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_CHECKING
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	ストレステストタスクの持続時間です。	864000
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": {
    "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": "109141182625****",
    "DstType": "Instance",
    "EcsInstanceId": "i-bp1ecr5go2go1****",
    "DstInstanceUuid": "hdm_d887b5ccf99fa0dc9a1e5aaac368****",
    "TaskType": "pressure test",
    "BenchStep": "PROCEED",
    "Version": "V3.0",
    "EndState": "WAIT_LOGIC",
    "SrcInstanceUuid": "a364e414-e68b-4e5c-9166-65b3a153****",
    "ClientType": "ECS",
    "State": "WAIT_TARGET",
    "DstIp": "None",
    "SrcPublicIp": "None",
    "BackupId": "229132",
    "SqlCompleteReuse": "{\"sqlUuid\":\"task_a37d2f07-45cb-****-a2a6-c66c62****\",\"metaUuid\":\"task_211e2561-5c0c-486b-864c-56b511****\",\"sqlFile\":\"cl-1620057600000-1800626.sc\",\"metaFile\":\"cl-1620057600000-180****.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": "10910",
    "TableSchema": "[{\"TABLE_NAME\":\"customer1\",\"TABLE_SCHEMA\":\"tpcc\"}]",
    "DtsJobStatus": "PRE_CHECKING",
    "SrcInstanceArea": "RDS",
    "BenchStepStatus": "FINISHED",
    "Source": "DAS",
    "ArchiveJobId": "'202105211430070112231480820340758****",
    "Topic": "das",
    "RequestDuration": 864000,
    "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.

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

変更履歴

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