DescribeCloudbenchTask - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Consulta uma tarefa específica de teste de estresse.

Descrição da operação

Chame esta API para obter uma tarefa específica de teste de estresse pelo status da tarefa, tipo e timestamp. Isso ajuda a verificar se sua instância precisa ser escalada para lidar efetivamente com picos de tráfego. Para mais informações, consulte Teste de estresse inteligente.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hdm:DescribeCloudbenchTask

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
TaskId	string	Sim	O ID exclusivo da tarefa. Você pode chamar a API DescribeCloudBenchTasks para obter o ID da tarefa.	e5cec704-0518-430f-8263-76f4dcds****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
Code	string	O código de status retornado.	200
Message	string	A mensagem retornada. Nota Quando a solicitação é bem-sucedida, este parâmetro retorna Successful. Quando a solicitação falha, este parâmetro retorna informações de exceção, como códigos de erro.	Successful
RequestId	string	O ID da solicitação.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indica se a solicitação foi bem-sucedida: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Data	object	A lista de informações detalhadas, incluindo o número total de itens de informação e códigos de erro.
DtsJobName	string	O nome da tarefa DTS.	Migration between RDS instances
ErrorMessage	string	A mensagem de erro para uma tarefa com falha.	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	Informações adicionais.	Null
BackupType	string	O tipo de backup. Valores válidos: TIMESTAMP: Por horário de backup. BACKUPID: Por ID do conjunto de backup.	TIMESTAMP
UserId	string	O ID da conta Alibaba Cloud.	109141182625****
DstType	string	O tipo da instância de destino. Valores válidos: Instance (padrão): ID da instância. ConnectionString: endereço de conexão da instância.	Instance
EcsInstanceId	string	O ID da instância ECS.	i-bp1ecr5go2go1****
DstInstanceUuid	string	O identificador exclusivo da instância de destino.	hdm_d887b5ccf99fa0dc9a1e5aaac368****
TaskType	string	O tipo de tarefa de teste de estresse. Valores válidos: pressure test (padrão): Teste de estresse inteligente. O tráfego capturado da instância de origem é reproduzido na instância de destino na velocidade máxima suportada pelo tipo da instância de destino. smart pressure test: Teste de estresse gerado. Ao analisar e aprender o tráfego capturado da instância de origem em um curto período de tempo, é gerado tráfego com modelos de negócios e distribuição de tráfego semelhantes ao tráfego original para teste de estresse contínuo. Isso reduz o tempo necessário para coletar dados da instância de origem e diminui os custos de armazenamento e a sobrecarga de desempenho.	pressure test
BenchStep	string	A subetapa do teste de estresse. Valores válidos: NEW: inicialização da tarefa. WAIT_BUY_ECS: adquirir uma nova instância ECS. WAIT_START_ECS: iniciar a instância ECS. WAIT_INSTALL_JDK: instalar o JDK. WAIT_INSTALL_DBGATEWAY: instalar o Database Gateway. ADD_SECURITY_IPS_STEP: configurar a whitelist do grupo de segurança. ARCHIVE: arquivamento completo de SQL. DOWNLOAD: baixar o arquivo SQL completo. PROCEED: pré-processar o arquivo SQL completo. PRE_LOAD: pré-carregar o arquivo SQL completo. VALIDATE: validação de funcionalidade. PRESSURE: teste de estresse de desempenho.	PROCEED
Version	string	A versão da tarefa de teste de estresse. Valores válidos: V2.0 V3.0	V3.0
EndState	string	O status após o término da tarefa de teste de estresse. Valores válidos: WAIT_TARGET: preparar a instância de destino para o teste de estresse. WAIT_DBGATEWAY: preparar para a implantação do teste de estresse. WAIT_SQL: preparar o SQL completo. WAIT_LOGIC: preparar para iniciar a reprodução do tráfego. Nota Quando a tarefa de teste de estresse conclui o status definido em EndState, a tarefa atingirá diretamente o status de concluída.	WAIT_LOGIC
SrcInstanceUuid	string	O identificador exclusivo da instância de origem.	a364e414-e68b-4e5c-9166-65b3a153****
ClientType	string	O tipo de máquina de teste de estresse. Valores válidos: ECS: Você precisa preparar seu próprio Database Gateway. DAS_ECS: ECS adquirido e implantado automaticamente pelo DAS.	ECS
State	string	O status atual da tarefa de teste de estresse. Valores válidos: WAIT_TARGET: preparar a instância de destino para o teste de estresse. WAIT_DBGATEWAY: preparar para a implantação do teste de estresse. WAIT_SQL: preparar o SQL completo. WAIT_LOGIC: preparar para iniciar a reprodução do tráfego.	WAIT_TARGET
DstIp	string	Parâmetro reservado.	None
SrcPublicIp	string	Parâmetro reservado.	None
BackupId	string	O ID do conjunto de backup. Você pode obtê-lo chamando a operação DescribeBackups para consultar a lista de backups.	229132
SqlCompleteReuse	string	As informações de reutilização do SQL completo.	{"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	O tempo do teste de estresse gerado em milissegundos.	86400000
ArchiveState	integer	O status de arquivamento de SQL. Valores válidos: 0: Não iniciado. 1: Concluído. 2: Erro. 3: Em execução. 4: Download não necessário.	1
Status	string	O status de execução da tarefa de teste de estresse. Valores válidos: SUCCESS: bem-sucedido. IGNORED: ignorado. RUNNING: em execução. EXCEPTION: anormal.	RUNNING
WorkDir	string	O diretório temporário gerado para o teste de estresse.	/tmp/bench/
ArchiveOssTableName	string	O nome da tabela OSS para arquivamento.	custins15546355_161604665****
DtsJobId	string	O ID da tarefa de migração DTS.	i03e3zty16i****
DtsJobState	integer	O status da tarefa DTS. Valores válidos: NOT_STARTED: não iniciada. PRE_CHECKING: pré-verificação em andamento. PRE_CHECK_FAILED: pré-verificação falhou. CHECKING: verificação em andamento. MIGRATING: migração em andamento. CATCHED: alcançado. SUSPENDING: pausando. MIGRATION_FAILED: migração falhou. FINISHED: concluída. INITIALIZING: sincronização inicial. INITIALIZE_FAILED: sincronização inicial falhou. SYNCHRONIZING: sincronização em andamento. MODIFYING: alteração do objeto de sincronização em andamento. SWITCHING: alternância em andamento. FAILED: falhou.	CHECKING
DstPort	integer	A porta da instância de destino.	3306
DtsJobClass	string	A especificação da tarefa DTS.	medium
ClientGatewayId	string	O ID do database gateway da máquina de teste de estresse.	58598b2af48a0193dfc16fc6964ef****
Description	string	A descrição da tarefa de teste de estresse.	test-das-bench-0501
ErrorCode	string	O código de erro retornado pela tarefa interna de teste de estresse.	10910
TableSchema	string	Os nomes das tabelas envolvidas no teste de estresse.	[{"TABLE_NAME":"customer1","TABLE_SCHEMA":"tpcc"}]
DtsJobStatus	string	O status da tarefa DTS. Valores válidos: NOT_STARTED: não iniciada. PRE_CHECKING: pré-verificação em andamento. PRE_CHECK_FAILED: pré-verificação falhou. CHECKING: verificação em andamento. MIGRATING: migração em andamento. CATCHED: alcançado. SUSPENDING: pausando. MIGRATION_FAILED: migração falhou. FINISHED: concluída. INITIALIZING: sincronização inicial. INITIALIZE_FAILED: sincronização inicial falhou. SYNCHRONIZING: sincronização em andamento. MODIFYING: alteração do objeto de sincronização em andamento. SWITCHING: alternância em andamento. FAILED: falhou.	PRE_CHECKING
SrcInstanceArea	string	O tipo de banco de dados da instância de origem.	RDS
BenchStepStatus	string	O status da subetapa do teste de estresse. Valores válidos: NEW: inicialização da tarefa. RUNNING: em execução. FAILED: falhou. FINISHED: concluída. Terminated: terminada. Deleted: excluída.	FINISHED
Source	string	A origem da tarefa. Valores válidos: DAS. OPEN_API.	DAS
ArchiveJobId	string	O ID da tarefa de arquivamento.	'202105211430070112231480820340758****
Topic	string	O tópico de consumo Kafka.	das
RequestDuration	integer	A duração da tarefa de teste de estresse.	864000
TaskId	string	O ID da tarefa.	e5cec704-0518-430f-8263-76f4dcds****
Rate	integer	O multiplicador de teste de estresse. O multiplicador de reprodução deve ser um número inteiro positivo variando de 0 a 30. O valor padrão é 1.	1

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.