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

Consulta os detalhes de uma instância.

Descrição da operação

Consulta as informações de status de uma instância de Autoridade Certificadora Privada (PCA) que você comprou por meio do console do Serviço de Certificado SSL usando o ID da instância. As informações incluem o status da instância, o número total de certificados e o número de certificados emitidos.

Antes de invocar esta operação, você deve comprar uma CA privada por meio do console do serviço de gerenciamento de certificados digitais. Para mais informações, consulte Comprar uma CA privada.

Limite de QPS

O limite de QPS para um único usuário é de 10 invocações por segundo. Se o limite for excedido, as invocações de API serão limitadas, o que pode afetar seus serviços. Invoque esta operação com uma frequência razoável.

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

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	cas_dv-cn-123

O InstanceId é obtido de ListInstances após você comprar um plano de certificado por meio do BSS. Você deve primeiro concluir a compra no console do Serviço de Gerenciamento de Certificados ou por meio da API do BSS. Para IDs de instância no formato cas-upload-*, você deve chamar a operação UploadUserCertificate para fazer o upload do certificado e obter o ID da instância.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
AutoReissue	string	Especifica se a hospedagem automática está ativada. Valores válidos: enable: Ativado. disable: Desativado.	enable
AutoReissueFlag	integer	Especifica se a versão atual inclui hospedagem automática. Valores válidos: 1: Incluído. 0: Não incluído.	1
AverageWaitingTime	string	O tempo médio de espera para a emissão de um certificado desta especificação, em segundos.	120
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. O formato é ID do certificado + "-" + ID da região do site. Este ID é comumente usado nos serviços do Alibaba Cloud. Para o site chinês, o formato é ID do certificado + "-cn-hangzhou". Para o site internacional, o formato é ID do certificado + "-ap-southeast-1". Por exemplo, se o ID do certificado for 123, o CertIdentifier para o site chinês é "123-cn-hangzhou" e, para o site internacional, é "123-ap-southeast-1".	22783111-cn-hangzhou
CertificateId	integer	O ID do certificado.	1234567890
CertificateName	string	O nome da instância. Quando um certificado é emitido, este nome é usado como o nome padrão do certificado.	123
CertificateNotAfter	integer	A hora de expiração do certificado mais recente. O valor é um carimbo de data e hora UNIX com precisão de segundos. Se nenhum certificado for emitido, este parâmetro estará vazio.	1801324800000
CertificateNotBefore	integer	A hora de início do certificado mais recente. O valor é um carimbo de data e hora UNIX com precisão de segundos. Se nenhum certificado for emitido, este parâmetro estará vazio.	1781568000000
CertificateRevokeTime	integer	A hora de revogação do certificado mais recente. O valor é um carimbo de data e hora UNIX com precisão de segundos.	1801324800000
CertificateStatus	string	O status do certificado. Valores válidos: issued: Emitido. revoked: Revogado. willExpire: Expirando em breve. expired: Expirado.	issued
CertificateType	string	O tipo do certificado. Valores válidos: DV, OV e EV.	DV
City	string	A cidade onde a empresa ou organização do usuário que comprou o certificado está localizada. Este campo é obrigatório ao gerar uma CSR. Valor padrão: Beijing.	Beijing
CompanyId	integer	O ID das informações da empresa.	47305
ContactIdList	array	A lista de IDs de contato.
	integer	O ID do contato.	123
CountryCode	string	O código do país ou região onde a organização especificada no certificado está localizada. Por exemplo, CN indica China e US indica os Estados Unidos. Este campo é obrigatório ao gerar uma CSR. Valor padrão: CN.	CN
Csr	string	A solicitação de assinatura de certificado no formato PEM.	-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----
DeploymentResourceCount	integer	O número de recursos de serviço em nuvem implantados.	30
DeploymentUseCount	integer	A cota usada para implantação em servidores em nuvem.	30
DingGroupList	array<object>	A lista de grupos do DingTalk associados para serviços de especialistas.
	object	O grupo do DingTalk associado para serviços de especialistas.
DingGroupInstanceId	string	O ID da instância do grupo do DingTalk para serviços de especialistas.	123
DingGroupName	string	O nome do grupo do DingTalk para serviços de especialistas.	123
DingGroupType	string	O tipo do grupo do DingTalk para serviços de especialistas. Valores válidos: expedite: Assistência na solicitação. remote: Implantação offline.	remote
DingGroupUrl	string	O link para entrar no grupo do DingTalk para serviços de especialistas.	https://123.com
Domain	string	O nome de domínio vinculado ao certificado.	example.com
DomainValidationList	array<object>	A lista de nomes de domínio a serem validados.
	object	O nome de domínio a ser validado.
Cname	string	O valor do registro CNAME para autorização sem verificação. Este parâmetro pode estar vazio.	123.com
CnameKey	string	O prefixo usado para validação de CNAME.	abc
Domain	string	O nome de domínio a ser validado.	example.com
RootDomain	string	O nome de domínio raiz.	example.com
ValidationKey	string	O registro de host.	@
ValidationType	string	O tipo de validação. Valores válidos: TXT, HTTP e CNAME.	TXT
ValidationValue	string	O valor do registro de host para validação.	123
FullDomainCount	integer	O número de nomes de domínio exatos.	1
GenerateCsrMethod	string	O método usado para gerar a CSR. Valores válidos: online: Gerado pelo sistema. O campo Csr é ignorado. upload: Enviado pelo usuário. O campo Csr é obrigatório.	online
InstanceEndTime	integer	A hora de expiração da instância. O valor é um carimbo de data e hora UNIX com precisão de segundos. Se nenhum certificado tiver sido emitido, este parâmetro estará vazio.	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 e hora UNIX com precisão de segundos. Se nenhum certificado tiver sido emitido, este parâmetro estará vazio.	1801324800000
InstanceType	string	O tipo da instância. Valores válidos: BUY: Certificado oficial. TEST: Certificado de teste.	TEST
KeyAlgorithm	string	O algoritmo do certificado. Valores válidos: RSA_2048 RSA_3072 RSA_4096 ECC_256 SM2	RSA_2048
MonitorExpandFlag	integer	Especifica se a cota para monitoramento de nomes de domínio pode ser expandida. Valores válidos: 1: Sim. 0: Não.	1
MonitorUseCount	integer	A cota usada para monitoramento de nomes de domínio.	10
OrderEndTime	integer	A hora de término da compra da instância. O valor é um carimbo de data e hora UNIX usado para determinar a duração da compra da instância.	1801324800000
OrderProgress	string	O progresso do pedido.	{ "orderProgress": [ { "certificateId": 12345, "certificateName": "example.com", "notBefore": 1727000000000, "notAfter": 1735000000000, "stages": [ { "name": "apply", "title": "apply", "status": "completed", "time": 1726990000000 }, { "name": "domainValidation", "title": "domainValidation", "status": "completed", "time": 1727000000000 }, { "name": "issue", "title": "issue", "status": "completed", "time": 1727000000000 } ] } ] }
OrderStartTime	integer	A hora de início da compra da instância. O valor é um carimbo de data e hora UNIX com precisão de segundos, usado para determinar o prazo limite para reembolsos.	1801324800000
PendingResult	string	O resultado retornado pela CA durante a última operação no certificado.	pending
Province	string	A província ou região onde a empresa está localizada. Este campo é obrigatório ao gerar uma CSR. Valor padrão: Beijing.	Beijing
RequestId	string	O ID da solicitação. É um identificador exclusivo gerado pelo Alibaba Cloud para a solicitação e pode ser usado para solução de problemas.	B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9
ResourceGroupId	string	O ID do grupo de recursos.	rg-aek****wia
Spec	string	As especificações 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 certificado mais recente foi enviado para análise. willExpire: Expirando em breve. expired: Expirado. refund: Reembolsado. normal: Normal. closed: Desligado e indisponível.	inactive
Tags	array<object>	A lista de tags.
	object	A lista de tags.
TagKey	string	A chave da tag.	test
TagValue	string	O valor da tag.	test
TotalDeploymentCount	integer	A cota total para implantação em servidores em nuvem.	60
TotalMonitorCount	integer	A cota total para monitoramento de nomes de domínio.	80
UpgradeStatus	string	O status de upgrade da instância. Valores válidos: none: A instância não passou por upgrade. payed: O upgrade da instância foi pago. issued: O certificado mais recente foi emitido para o upgrade da instância.	none
ValidationMethod	string	O método de validação para a solicitação de certificado. Valores válidos: DNS: Validação de DNS, usando registros TXT ou CNAME. HTTP: Validação de arquivo.	DNS
VersionType	string	O tipo de versão. Valores válidos: FOTA: Upgrade do sistema. APP: Upgrade do aplicativo.	0
WildcardDomainCount	integer	O número de nomes de domínio curinga.	0

Exemplos

Resposta de sucesso

JSON formato

{
  "AutoReissue": "enable",
  "AutoReissueFlag": 1,
  "AverageWaitingTime": "120",
  "Brand": "DigiCert",
  "CertIdentifier": "22783111-cn-hangzhou",
  "CertificateId": 1234567890,
  "CertificateName": "123",
  "CertificateNotAfter": 1801324800000,
  "CertificateNotBefore": 1781568000000,
  "CertificateRevokeTime": 1801324800000,
  "CertificateStatus": "issued",
  "CertificateType": "DV",
  "City": "Beijing",
  "CompanyId": 47305,
  "ContactIdList": [
    123
  ],
  "CountryCode": "CN",
  "Csr": "-----BEGIN CERTIFICATE REQUEST-----   ...... -----END CERTIFICATE REQUEST-----",
  "DeploymentResourceCount": 30,
  "DeploymentUseCount": 30,
  "DingGroupList": [
    {
      "DingGroupInstanceId": "123",
      "DingGroupName": "123",
      "DingGroupType": "remote",
      "DingGroupUrl": "https://123.com"
    }
  ],
  "Domain": "example.com",
  "DomainValidationList": [
    {
      "Cname": "123.com",
      "CnameKey": "abc",
      "Domain": "example.com",
      "RootDomain": "example.com",
      "ValidationKey": "@",
      "ValidationType": "TXT",
      "ValidationValue": "123"
    }
  ],
  "FullDomainCount": 1,
  "GenerateCsrMethod": "online",
  "InstanceEndTime": 1801324800000,
  "InstanceId": "cas_dv-cn-123",
  "InstanceStartTime": 1801324800000,
  "InstanceType": "TEST",
  "KeyAlgorithm": "RSA_2048",
  "MonitorExpandFlag": 1,
  "MonitorUseCount": 10,
  "OrderEndTime": 1801324800000,
  "OrderProgress": "{\n  \"orderProgress\": [\n    {\n      \"certificateId\": 12345,\n      \"certificateName\": \"example.com\",\n      \"notBefore\": 1727000000000,\n      \"notAfter\": 1735000000000,\n      \"stages\": [\n        { \"name\": \"apply\", \"title\": \"apply\", \"status\": \"completed\", \"time\": 1726990000000 },\n        { \"name\": \"domainValidation\", \"title\": \"domainValidation\", \"status\": \"completed\", \"time\": 1727000000000 },\n        { \"name\": \"issue\", \"title\": \"issue\", \"status\": \"completed\", \"time\": 1727000000000 }\n      ]\n    }\n  ]\n}",
  "OrderStartTime": 1801324800000,
  "PendingResult": "pending",
  "Province": "Beijing",
  "RequestId": "B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9",
  "ResourceGroupId": "rg-aek****wia",
  "Spec": "ss.dv.t",
  "Status": "inactive",
  "Tags": [
    {
      "TagKey": "test",
      "TagValue": "test"
    }
  ],
  "TotalDeploymentCount": 60,
  "TotalMonitorCount": 80,
  "UpgradeStatus": "none",
  "ValidationMethod": "DNS",
  "VersionType": "0",
  "WildcardDomainCount": 0
}

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.