Kueri tugas uji stres menggunakan DescribeCloudBenchTasks - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Mengkueri tugas uji stres.

Deskripsi operasi

Database Autonomy Service (DAS) provides an intelligent stress testing feature that helps you determine to scale out your instance to handle service traffic peaks. For more information, see Intelligent stress testing.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

hdm:DescribeCloudBenchTasks

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Status	string	No	Status tugas. Nilai valid: SUCCESS: Tugas berhasil. IGNORED: Tugas diabaikan. RUNNING: Tugas berjalan. EXCEPTION: Tugas tidak normal.	SUCCESS
TaskType	string	No	Jenis tugas uji stres. Nilai valid: pressure test (default): Tugas uji stres yang memutar ulang Trafik yang ditangkap dari Instans sumber pada Instans tujuan dengan laju pemutaran maksimum yang didukung Instans tujuan. smart pressure test: Tugas uji stres yang dibuat untuk melakukan uji stres berkelanjutan. Tugas ini menganalisis Trafik yang ditangkap dari Instans sumber dalam periode singkat dan menghasilkan Trafik yang mirip dengan Trafik pada Instans sumber dalam hal model bisnis dan distribusi Trafik. Hal ini mengurangi waktu yang diperlukan untuk mengumpulkan data dari Instans sumber serta menurunkan biaya penyimpanan dan performa.	pressure test
StartTime	string	No	Awal Rentang Waktu untuk kueri. Nilai ini adalah Stempel waktu UNIX yang menunjukkan jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC.	1596177993000
EndTime	string	No	Akhir Rentang Waktu untuk kueri. Nilai ini adalah Stempel waktu UNIX yang menunjukkan jumlah milidetik yang telah berlalu sejak 1 Januari 1970, 00:00:00 UTC. Catatan Waktu akhir harus lebih lambat daripada Waktu mulai.	1596177993001
PageNo	string	No	Nomor halaman. Nilai harus berupa bilangan bulat positif. Nilai default: 1.	1
PageSize	string	No	Jumlah entri per halaman. Nilai harus berupa bilangan bulat positif. Nilai default: 10.	10

Elemen respons

Element	Type	Description	Example
	object
Code	string	The HTTP status code returned.	200
Message	string	The data returned. Catatan If the request is successful, Successful is returned. If the request fails, an error message such as an error code is returned.	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	object	The detailed information, including the total number of entries returned and the error codes.
PageNo	integer	The page number.	1
PageSize	integer	The number of entries returned on each page.	10
Extra	string	The reserved parameter.	None
Total	integer	The total number of entries returned.	2
List	object
cloudbenchTasks	array<object>	The detailed information about the stress testing tasks.
	object
DtsJobName	string	The name of the DTS task.	RDS间迁移
ErrorMessage	string	The error message returned if the task fails.	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	The additional information.	Null
BackupType	string	The backup type. Valid values: TIMESTAMP: backup by time. BACKUPID: backup by backup set ID.	TIMESTAMP
UserId	string	The ID of the Alibaba Cloud account.	1091411816252****
DstType	string	The type of the destination instance. Valid values: Instance (default): an instance that is specified by its ID. ConnectionString: an instance that is specified by its endpoint.	Instance
EcsInstanceId	string	The ID of the ECS instance.	i-bp1ecr5go2go1****
DstInstanceUuid	string	The unique ID of the destination instance.	hdm_d887b5ccf99fa0dc9a1e5aaac368****
TaskType	string	The type of the stress testing task. Valid values: pressure test (default): A stress testing task that replays the traffic captured from the source instance on the destination instance at the maximum playback rate that is supported by the destination instance. smart pressure test: A stress testing task that is generated to perform continuous stress testing. The task analyzes the traffic that is captured from a source instance in a short period of time and generates traffic that is similar to the traffic on the source instance in terms of business model and traffic distribution. This reduces the time that is required to collect data from the source instance and lowers the costs of storage and performance.	pressure test
BenchStep	string	The sub-step of the stress testing task. Valid values: NEW: The task is being initialized. WAIT_BUY_ECS: An ECS instance is being purchased. WAIT_START_ECS: The ECS instance is being started. WAIT_INSTALL_JDK: JDK is being installed. WAIT_INSTALL_DBGATEWAY: A DBGateway is being installed. ADD_SECURITY_IPS_STEP: A whitelist is being configured for the security group. ARCHIVE: Full SQL data is being archived. DOWNLOAD: The full SQL file is being downloaded. PROCEED: The full SQL file is being pre-processed. PRE_LOAD: The full SQL file is being preloaded. VALIDATE: The feature is being validated. PRESSURE: Performance is being tested.	PROCEED
Version	string	The version of the stress testing task. Valid values: V2.0 V3.0	V3.0
EndState	string	The state of the stress testing task after it is complete. Valid values: WAIT_TARGET: The destination instance for stress testing is being prepared. WAIT_DBGATEWAY: The stress testing deployment is being prepared. WAIT_SQL: Full SQL data is being prepared. WAIT_LOGIC: The traffic playback is being prepared. Catatan After the stress testing task enters the state specified by the EndState parameter, the task becomes complete.	WAIT_TARGET
SrcInstanceUuid	string	The unique ID of the source instance.	hdm_3063db6792965c080a4bcb6e6304****
ClientType	string	The type of the stress testing client. Valid values: ECS: You must prepare a database gateway. DAS_ECS: DAS automatically purchases and deploys an ECS instance.	ECS
State	string	The state of the stress testing task. Valid values: WAIT_TARGET: The destination instance for stress testing is being prepared. WAIT_DBGATEWAY: The stress testing deployment is being prepared. WAIT_SQL: Full SQL data is being prepared. WAIT_LOGIC: The traffic playback is being prepared.	WAIT_TARGET
DstIp	string	The reserved parameter.	None
SrcPublicIp	string	The reserved parameter.	None
BackupId	string	The backup set ID. You can call the DescribeBackups operation to query the backup list.	229132
SqlCompleteReuse	string	The information about the full SQL statements that are reused.	{"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	The duration of the generated stress testing task. Unit: milliseconds.	86400000
ArchiveState	integer	The status of SQL data archiving. Valid values: 0: Not started. 1: Complete. 2: Error. 3: Running. 4: No download required.	1
Status	string	The status of the stress testing task. Valid values: SUCCESS: The task is successful. IGNORED: The task is ignored. RUNNING: The task is running. EXCEPTION: The task is abnormal.	RUNNING
WorkDir	string	The temporary directory generated for stress testing.	/tmp/bench/
ArchiveOssTableName	string	The name of the table to which data is archived in OSS.	custins15546355_161604665****
DtsJobId	string	The ID of the DTS data migration task.	i03e3zty16i****
DtsJobState	integer	The status of the DTS task. Valid values: NOT_STARTED: The task is not started. PRE_CHECKING: The task is in precheck. PRE_CHECK_FAILED: The precheck failed. CHECKING: The task is being checked. MIGRATING: The task is in progress. CATCHED: The destination instance has caught up with the source instance. SUSPENDING: The task is paused. MIGRATION_FAILED: The migration failed. FINISHED: The task is complete. INITIALIZING: The task is in initial synchronization. INITIALIZE_FAILED: The initial synchronization failed. SYNCHRONIZING: The task is in synchronization. MODIFYING: The synchronization object is being changed. SWITCHING: The task is being switched. FAILED: The task failed.	CHECKING
DstPort	integer	The port number of the destination instance.	3306
DtsJobClass	string	The specifications of the DTS task. Catatan For more information about the specifications and performance of data migration tasks, see Specifications of data migration tasks.	medium
ClientGatewayId	string	The ID of the database gateway for the stress testing client.	58598b2af48a0193dfc16fc6964ef****
Description	string	The description of the stress testing task.	test-das-bench-0501
ErrorCode	string	The error code returned for the internal stress testing task.	10109
TableSchema	string	The names of the tables that are involved in the stress testing.	[{"TABLE_NAME":"customer1","TABLE_SCHEMA":"tpcc"}]
DtsJobStatus	string	The status of the DTS task. Valid values: NOT_STARTED: The task is not started. PRE_CHECKING: The task is in precheck. PRE_CHECK_FAILED: The precheck failed. CHECKING: The task is being checked. MIGRATING: The task is in progress. CATCHED: The destination instance has caught up with the source instance. SUSPENDING: The task is paused. MIGRATION_FAILED: The migration failed. FINISHED: The task is complete. INITIALIZING: The task is in initial synchronization. INITIALIZE_FAILED: The initial synchronization failed. SYNCHRONIZING: The task is in synchronization. MODIFYING: The synchronization object is being changed. SWITCHING: The task is being switched. FAILED: The task failed.	PRE_CHECK_FAILED
SrcInstanceArea	string	The database type of the source instance.	RDS
BenchStepStatus	string	The status of the stress testing sub-step. Valid values: NEW: The task is being initialized. RUNNING: The task is running. FAILED: The task failed. FINISHED: The task is complete. Terminated: The task is terminated. Deleted: The task is deleted.	FINISHED
Source	string	The source of the task. Valid values: DAS OPEN_API	DAS
ArchiveJobId	string	The ID of the data archiving task.	'202105211430070112231480820340758****
Topic	string	The consumer topic in Kafka.	das
RequestDuration	integer	The duration of the stress testing task. Unit: milliseconds.	86400000
TaskId	string	The task ID.	e5cec704-0518-430f-8263-76f4dcds****
Rate	integer	The playback rate of the traffic from the source instance on the destination instance. The playback rate must be a positive integer. Valid values: 0 to 30. Default value: 1.	1

Contoh

Respons sukses

JSONformat

{
  "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
        }
      ]
    }
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.