ListInstances - : Central de Documentação do Alibaba Cloud

Obtém uma lista de instâncias.

Descrição da operação

Consulta as informações de status das instâncias da Autoridade Certificadora Privada (PCA) que você comprou por meio do console de Certificados SSL, especificando os IDs das instâncias de CA privada. Por exemplo, você pode consultar o status de uma instância de CA, o número de certificados digitais incluídos e o número de certificados digitais emitidos.

Antes de invocar esta operação, você deve ter comprado uma CA privada por meio do console do Serviço de Gerenciamento de Certificados. Para mais informações, consulte Comprar uma CA privada.

Limite de QPS

O limite de QPS por usuário para esta operação é de 10 chamadas por segundo. Se o limite for excedido, a invocação da API será limitada, o que pode afetar seus negócios. Invoque esta operação conforme necessário.

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

yundun-cert:ListInstances

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Keyword	string	Não	A palavra-chave para busca fuzzy. Corresponde a nomes de domínio, nomes de instâncias ou IDs de recursos correspondentes.	test
Status	string	Não	O status da instância. Valores válidos: inactive: Uso pendente. pending: Em análise. O certificado mais recente está sendo enviado para análise. willExpire: A instância está prestes a expirar. expired: A instância expirou. refund: Reembolsada. normal: Normal. closed: Desligada e indisponível.	inactive
Brand	string	Não	A marca da CA. Valores válidos: WoSign, CFCA, DigiCert, GeoTrust, GlobalSign, vTrus e Alibaba.	Digicert
CertificateType	string	Não	O tipo do certificado. Valores válidos: DV, OV e EV.	DV
CertificateStatus	string	Não	O status do certificado. Valores válidos: issued: Emitido. revoked: Revogado. willExpire: Prestes a expirar. expired: Expirado. Valores válidos: expired : Expirado. willExpire : Prestes a expirar. issued : Emitido. revoked : Revogado.	issued
InstanceType	string	Não	O tipo da instância. Valores válidos: BUY (certificado oficial) e TEST (certificado de teste).	BUY
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-ae******4wia
ShowSize	integer	Não	O número de instâncias a serem exibidas por página em uma consulta paginada. Define o número de instâncias exibidas por página. Valor padrão: 10. Valor máximo: 100.	10
CurrentPage	integer	Não	O número da página atual em uma consulta paginada. Define o número da página atual. Valor padrão: 1.	1
ServerDeployFlag	integer	Não	Especifica se devem ser retornadas apenas instâncias que atendem às condições de implantação no servidor. Valores válidos: 1: sim. 0: não.	1
AutoReissueFlag	integer	Não	Especifica se a instância é gerenciada. Valores válidos: 1 (gerenciada) e 0 (não gerenciada).	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
CurrentPage	integer	O número da página atual em uma consulta paginada.	1
DisableReissueCount	integer	O número de instâncias para as quais a renovação gerenciada não está ativada.	80
EnableReissueCount	integer	O número de instâncias para as quais a renovação gerenciada está ativada.	100
InstanceList	array<object>	A lista de instâncias.
	object	A instância.
AutoReissue	string	Indica se a renovação gerenciada automática está ativada. Valores válidos: enable: Ativada. disable: Não ativada.	enable
Brand	string	A marca da CA. Valores válidos: WoSign, CFCA, DigiCert, GeoTrust, GlobalSign, vTrus e Alibaba.	DigiCert
CertIdentifier	string	O ID global do certificado, no formato de ID do certificado + "-" + ID da região do site. Este ID é comumente usado nos serviços do Alibaba Cloud. Valores válidos: Para o site da China: ID do certificado + "-cn-hangzhou". Para o site da China (chinês): ID do certificado + "-ap-southeast-1". Por exemplo, se o ID do certificado for 123, o CertIdentifier no site da China será "123-cn-hangzhou" e o CertIdentifier no site da China (chinês) será "123-ap-southeast-1".	21795675-cn-hangzhou
CertificateDomain	string	O nome de domínio do certificado emitido mais recente.	abc.com,www.abc.com
CertificateId	integer	O ID do certificado.	18541349
CertificateName	string	O nome do certificado.	cert-13216408
CertificateNotAfter	integer	A hora de término do certificado mais recente. O valor é um carimbo de data/hora UNIX em segundos. Este valor estará vazio se nenhum certificado tiver sido emitido.	1801324800000
CertificateNotBefore	integer	A hora de início do certificado mais recente. O valor é um carimbo de data/hora UNIX em segundos. Este valor estará vazio se nenhum certificado tiver sido emitido.	1776988800000
CertificateRevokeTime	integer	A hora de revogação do certificado mais recente. O valor é um carimbo de data/hora UNIX em segundos.	1801324800000
CertificateStatus	string	O status do certificado. Valores válidos: issued: Emitido. revoked: Revogado. willExpire: Prestes a expirar. expired: Expirado.	issued
CertificateType	string	O tipo do certificado. Valores válidos: DV, OV e EV.	DV
Domain	string	O nome de domínio anexado ao certificado.	test.com
FullDomainCount	integer	O número de nomes de domínio com correspondência exata.	1
InstanceEndTime	integer	A hora de expiração da instância. O valor é um carimbo de data/hora UNIX em segundos. Este valor estará vazio se nenhum certificado tiver sido emitido.	1801324800000
InstanceId	string	O ID da instância.	cas_dv-cn-123
InstanceStartTime	integer	A hora de início da instância. O valor é um carimbo de data/hora UNIX em segundos. Este valor estará vazio se nenhum certificado tiver sido emitido.	1801324800000
InstanceType	string	O tipo da instância. Valores válidos: BUY (certificado oficial) e TEST (certificado de teste).	BUY
KeyAlgorithm	string	O algoritmo do certificado. Valor padrão: RSA_2048. Valores válidos: RSA_2048 RSA_3072 RSA_4096 ECC_256 SM2	RSA_2048
OrderEndTime	integer	A hora de término em que a instância foi comprada. O valor é um carimbo de data/hora UNIX em segundos. Este valor é usado para determinar a duração da compra da instância.	1801324800000
OrderStartTime	integer	A hora de início em que a instância foi comprada. O valor é um carimbo de data/hora UNIX em segundos. Este valor é usado para determinar o prazo limite para reembolso.	1801324800000
PendingResult	string	O resultado retornado pela CA durante a última operação do certificado.	pending
ResourceGroupId	string	O ID do grupo de recursos.	123
Spec	string	A especificação da instância comprada.	ss.dv.t
Status	string	O status da instância. Valores válidos: inactive: Uso pendente. pending: Em análise. O envio do certificado mais recente está em análise. willExpire: A instância está prestes a expirar. expired: A instância expirou. refund: Reembolsada. normal: Normal. closed: Desligada e indisponível.	inactive
UsingProductList	array	A lista de implantação de serviços em nuvem para o certificado mais recente.
	string	O serviço em nuvem de implantação.	['DCDN', 'VOD', 'CDN', 'OSS']
VersionType	string	O tipo de versão. Valores válidos: basic (Edição Básica), standard (Edição Padrão), professional (Edição Profissional) e ultimate (Edição Ultimate). Valores válidos: standard : Edição Padrão. ultimate : Edição Ultimate. basic : Edição Básica. professional : Edição Profissional.	professional
WildcardDomainCount	integer	O número de nomes de domínio curinga.	0
RequestId	string	O ID da solicitação.	12345678-1234-1234-1234-123456789ABC
ShowSize	integer	O número de registros exibidos por página.	20
TotalCount	integer	O número total de instâncias.	12

Exemplos

Resposta de sucesso

JSON formato

{
  "CurrentPage": 1,
  "DisableReissueCount": 80,
  "EnableReissueCount": 100,
  "InstanceList": [
    {
      "AutoReissue": "enable",
      "Brand": "DigiCert",
      "CertIdentifier": "21795675-cn-hangzhou",
      "CertificateDomain": "abc.com,www.abc.com",
      "CertificateId": 18541349,
      "CertificateName": "cert-13216408",
      "CertificateNotAfter": 1801324800000,
      "CertificateNotBefore": 1776988800000,
      "CertificateRevokeTime": 1801324800000,
      "CertificateStatus": "issued",
      "CertificateType": "DV",
      "Domain": "test.com",
      "FullDomainCount": 1,
      "InstanceEndTime": 1801324800000,
      "InstanceId": "cas_dv-cn-123",
      "InstanceStartTime": 1801324800000,
      "InstanceType": "BUY",
      "KeyAlgorithm": "RSA_2048",
      "OrderEndTime": 1801324800000,
      "OrderStartTime": 1801324800000,
      "PendingResult": "pending",
      "ResourceGroupId": "123",
      "Spec": "ss.dv.t",
      "Status": "inactive",
      "UsingProductList": [
        "['DCDN', 'VOD', 'CDN', 'OSS']"
      ],
      "VersionType": "professional",
      "WildcardDomainCount": 0
    }
  ],
  "RequestId": "12345678-1234-1234-1234-123456789ABC",
  "ShowSize": 20,
  "TotalCount": 12
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.