DescribeColdStorageInstance - PolarDB: Central de Documentação do Alibaba Cloud

Consulta instâncias de armazenamento frio.

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

polardb:DescribeColdStorageInstance

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Não	O ID do cluster PolarDB.	pc-wz9062015ly7526jc
NextToken	string	Não	Um token para recuperar a próxima página de resultados. Defina este parâmetro como o valor NextToken de uma chamada anterior. Você não precisa especificar este parâmetro na primeira chamada.	c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==
TableName	string	Não	O nome da tabela de dados.	account_log
DBName	string	Não	O nome do banco de dados.	test_db
EngineType	string	Não	O tipo do mecanismo suportado. O valor retornado é a soma dos valores dos tipos de mecanismo suportados. 1: Mecanismo de pesquisa 2: LindormTSDB 4: LindormTable 8: Mecanismo de arquivos Nota Por exemplo, se EngineType for 15 (8 + 4 + 2 + 1), a instância suporta o mecanismo de pesquisa, LindormTSDB, LindormTable e mecanismo de arquivos. Se EngineType for 6 (4 + 2), a instância suporta LindormTSDB e LindormTable.	2
RegionId	string	Não	O ID da região. Nota Para mais informações, consulte DescribeRegions. Se você não especificar este parâmetro, a operação consulta tarefas agendadas em todas as regiões da sua conta.	cn-hangzhou
MaxResults	integer	Não	Se você não especificar o parâmetro MaxResults, a consulta não será paginada. O valor do parâmetro MaxResults na resposta indica o número total de entradas. Se você especificar o parâmetro MaxResults, a consulta será paginada. MaxResults especifica o número de entradas a serem retornadas em cada página. Valores válidos: 1 a 100. O valor do parâmetro MaxResults na resposta indica o número de entradas na página atual. O valor recomendado é 20.	50
ExpireTime	integer	Não	A hora de expiração do cluster. Nota: Este parâmetro é retornado apenas para clusters por assinatura. Um valor vazio é retornado para clusters pago conforme o uso.	2020-11-14T16:00:00Z
PageNumber	string	Não	O número da página.	1
PageSize	string	Não	O número de entradas por página.	1
ObjectType	string	Não	O tipo de objeto. Valores válidos: TABLE, PARTITION_TABLE e LOB.	TABLE

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageRecordCount	integer	O número de entradas na página atual.	1
RequestId	string	O ID da solicitação.	C7A8EA8E-A140-5226-90D7-5BCB304D3DB6
NextToken	string	O token para recuperar a próxima página de resultados. Se este parâmetro não for retornado, todos os resultados foram retornados.	c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==
OssClusterEnabled	string	Indica se o bucket do OSS está ativado. true: ativado false: desativado	true
SupportOssCluster	string	Indica se o cluster suporta armazenamento frio. Se o cluster não suportar armazenamento frio, a opção não será exibida no console.	true
ObjectType	string	O tipo de objeto.	TABLE
MaxResults	integer	O número máximo de entradas retornadas. Valor padrão: 10.	1000
PageSize	integer	O número de entradas por página.	30
PageNumber	integer	O número da página.	1
TotalRecord	integer	O número total de entradas.	1
Tables	array<object>	A lista de instâncias de armazenamento frio.
	array<object>	Uma instância de armazenamento frio.
OssClusterId	string	O ID do cluster baseado em OSS.	pc-*****************
Partion	string	A partição da instância de armazenamento frio.	202509
Size	string	O tamanho do disco da instância de armazenamento frio. Unidade: GiB.	30
DB	string	O nome do banco de dados.	test_db
Table	string	O nome da tabela.	user
TableName	string	O nome da tabela.	test_table
DBName	string	O nome do banco de dados.	test_db
Status	string	O status da tarefa.	Running
FieldName	string	O nome do campo de objeto grande (LOB).	user
ChildObjects	array<object>	A lista de objetos filhos.
	object	Um objeto filho.
ObjectName	string	The object name.	img/1728554006462.png
ObjectType	string	The object type.	File
Size	string	The disk size. Unit: GiB.	10
Status	string	The status of the task. Valid values: Scheduled: The task is waiting to be executed. Running: The task is in progress. Succeed: The task is successful. Cancelling: The task is being stopped. Canceled: The task is stopped. Waiting: The task is waiting for a preset time. To query multiple statuses, separate them with commas (,). If you do not specify this parameter, all statuses are queried.	Running
OssClusterInfoList	array<object>	A lista de endereços OSS para as instâncias de armazenamento frio.
	object	O endereço OSS de uma instância de armazenamento frio.
OssClusterId	string	O ID da instância de armazenamento frio.	pc-*****************
Region	string	O ID da região onde a tarefa está localizada.	cn-hangzhou
Size	string	O tamanho da tabela de armazenamento frio. Unidade: GB.	50
CreatedTime	string	A hora em que o cluster foi criado.	2023-05-10T17:01:16Z

Exemplos

Resposta de sucesso

JSON formato

{
  "PageRecordCount": 1,
  "RequestId": "C7A8EA8E-A140-5226-90D7-5BCB304D3DB6",
  "NextToken": "c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==",
  "OssClusterEnabled": "true",
  "SupportOssCluster": "true",
  "ObjectType": "TABLE",
  "MaxResults": 1000,
  "PageSize": 30,
  "PageNumber": 1,
  "TotalRecord": 1,
  "Tables": [
    {
      "OssClusterId": "pc-*****************",
      "Partion": "202509",
      "Size": "30",
      "DB": "test_db",
      "Table": "user",
      "TableName": "test_table",
      "DBName": "test_db",
      "Status": "Running",
      "FieldName": "user",
      "ChildObjects": [
        {
          "ObjectName": "img/1728554006462.png",
          "ObjectType": "File",
          "Size": "10",
          "Status": "Running"
        }
      ]
    }
  ],
  "OssClusterInfoList": [
    {
      "OssClusterId": "pc-*****************",
      "Region": "cn-hangzhou",
      "Size": "50",
      "CreatedTime": "2023-05-10T17:01:16Z"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
400	Database.ConnectError	db instance %s connect failed, please check instance status and database processlist	Failed to connect to the database cluster. Check the cluster status and database process list.
400	Account.QueryError	Instance %s query account error	Failed to query accounts for cluster %s.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.