DescribeCloudbenchTask による特定のストレステストタスクのクエリ - DAS - Alibaba Cloud - Database Autonomy Service

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

操作説明

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

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TaskId	string	必須	タスク ID。 DescribeCloudBenchTasks 操作を呼び出してタスク 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	Data Transmission Service (DTS) タスクの名前。	RDS インスタンス間の移行
ErrorMessage	string	タスクが失敗したときに返されるエラーメッセージ。	DTS-070211: ソース DB の接続に失敗しました。原因: [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:データベースサーバーへの接続を作成できませんでした。再接続を 3 回試行しましたが、断念しました。][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:通信リンクの失敗\n\nサーバーに正常に送信された最後のパケットは 0 ミリ秒前です。ドライバーはサーバーからパケットを受信していません。][java.net.ConnectException:接続タイムアウト (Connection timed out)] 詳細については、[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	ターゲットインスタンスの一意の 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: データベースゲートウェイのインストール中。 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: ストレステスト Deployment を準備中。 WAIT_SQL: フル SQL を準備中。 WAIT_LOGIC: トラフィック再生の開始を準備中。説明ストレステストタスクが EndState で指定された状態を実行した後、タスクは直接完了状態になります。	WAIT_LOGIC
SrcInstanceUuid	string	ソースインスタンスの UUID。	a364e414-e68b-4e5c-9166-65b3a153****
ClientType	string	ストレステストマシンのタイプ。有効な値: ECS: データベースゲートウェイを自分で準備する必要があります。 DAS_ECS: DAS によって自動的に購入およびデプロイされた ECS インスタンス。	ECS
State	string	ストレステストタスクの現在の状態。有効な値: WAIT_TARGET: ストレステスト用のターゲットインスタンスを準備中。 WAIT_DBGATEWAY: ストレステスト Deployment を準備中。 WAIT_SQL: フル SQL を準備中。 WAIT_LOGIC: トラフィック再生の開始を準備中。	WAIT_TARGET
DstIp	string	予約済みパラメーター。	None
SrcPublicIp	string	予約済みパラメーター。	None
BackupId	string	バックアップセット ID。 DescribeBackups 操作を呼び出してバックアップセット ID を取得できます。	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 消費 Topic。	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": "Migration between RDS instances",
    "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.	この操作を実行する権限がありません。

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

変更履歴

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