GetKmsInstance - Key Management Service: Central de Documentação do Alibaba Cloud

Consulta os detalhes de uma instância KMS.

Descrição da operação

Para obter detalhes sobre a política de acesso que deve ser concedida a um usuário do Resource Access Management (RAM) ou a uma função do RAM para invocar esta operação de API, consulte Controle de acesso.

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

kms:GetKmsInstance

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
KmsInstanceId	string	Sim	O ID da instância KMS.	kst-bjj62f5ba3dnpb6v8****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes da instância KMS.
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.	46b4a94a-57d2-44b4-9810-1e87d31abb33
KmsInstance	object	Os detalhes da instância KMS.	3
InstanceId	string	O ID da instância KMS.	kst-bjj62f5ba3dnpb6v8****
InstanceName	string	O nome da instância KMS.	kst-bjj62f5ba3dnpb6v8****
Status	string	O status da instância KMS. Valores válidos: Uninitialized: não ativada Connecting: conectando Connected: ativada Disconnected: desconectada Error: anormal	Connected
CreateTime	string	A hora em que a instância KMS foi criada.	2023-09-05T12:44:20Z
Spec	integer	O desempenho de computação da instância KMS.	1000
KeyNum	integer	O número de chaves que podem ser criadas na instância KMS.	1000
SecretNum	string	O número de segredos que podem ser criados na instância KMS.	10
VpcNum	integer	O número total de VPCs que podem acessar a instância KMS.	5
VpcId	string	A VPC à qual a instância KMS está vinculada.	vpc-bp19z7cwmltad5dff****
ZoneIds	array	As zonas às quais a instância KMS está vinculada.	"cn-hangzhou-k", "cn-hangzhou-j"
	string
VswitchIds	array	Os vSwitches na VPC à qual a instância KMS está vinculada.	vsw-bp1i512amda6d10a0****
	string
EndDate	string	A hora de expiração da instância KMS.	2023-10-05T16:00:00Z
StartDate	string	A hora em que a instância KMS foi ativada.	2023-09-05T12:44:19Z
CaCertificateChainPem	string	O conteúdo do certificado CA da instância KMS.	-----BEGIN CERTIFICATE-----\r\nMIIDuzCCAqOgAwIBAgIJALTKwWAjvbMiMA0GCSqGSIb3DQEBCwUAMHQxCzAJBgNV****-----END CERTIFICATE-----
BindVpcs	object
BindVpc	array<object>	A lista de VPCs configuradas. Nota Se suas aplicações autogerenciadas estiverem implantadas em várias VPCs na mesma região, você poderá configurar VPCs diferentes da VPC à qual a instância KMS pertence (a VPC especificada quando a instância KMS é ativada) para a instância KMS. Essas VPCs podem pertencer à mesma conta do Alibaba Cloud ou a contas diferentes do Alibaba Cloud. Após a conclusão da configuração, as aplicações autogerenciadas nessas VPCs poderão acessar a instância KMS especificada.
	object	A lista de VPCs configuradas. Nota Se suas aplicações autogerenciadas estiverem implantadas em várias VPCs na mesma região, você poderá configurar VPCs diferentes da VPC vinculada à instância KMS para a instância KMS. Essas VPCs podem pertencer à mesma conta do Alibaba Cloud ou a contas diferentes do Alibaba Cloud. Após a conclusão da configuração, as aplicações autogerenciadas nessas VPCs poderão acessar a instância KMS especificada.
RegionId	string	A região à qual a VPC pertence.	cn-hangzhou
VpcId	string	O ID da VPC.	vpc-bp19z7djuhtad5dff****
VpcOwnerId	string	A conta do Alibaba Cloud à qual a VPC pertence.	190325303126****
VSwitchId	string	O vSwitch na VPC.	vsw-bp1i512amhdje10f1****
ChargeType	string	O método de cobrança da instância. Valores válidos: PREPAY: assinatura POSTPAY: pós-pago	POSTPAY
ProductVersion	string	A versão da instância KMS.	3
SaleStatus	string	O status de vendas.	Normal
Log	integer	Especifica se o registro de logs está ativado para a instância KMS. Valores válidos: 0: desativado 1: ativado	1
LogStorage	integer	A capacidade de armazenamento de logs. Unidade: GB.	100
ProductType	string	O tipo de produto. Assinatura: kms_ddi_public_cn: site da China kms_ddi_public_intl: site internacional Pós-pago: kms_ppi_public_cn: site da China kms_ppi_public_intl: site internacional	kms_ddi_public_cn

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "46b4a94a-57d2-44b4-9810-1e87d31abb33",
  "KmsInstance": {
    "InstanceId": "kst-bjj62f5ba3dnpb6v8****",
    "InstanceName": "kst-bjj62f5ba3dnpb6v8****",
    "Status": "Connected",
    "CreateTime": "2023-09-05T12:44:20Z",
    "Spec": 1000,
    "KeyNum": 1000,
    "SecretNum": "10",
    "VpcNum": 5,
    "VpcId": "vpc-bp19z7cwmltad5dff****",
    "ZoneIds": [
      ""
    ],
    "VswitchIds": [
      ""
    ],
    "EndDate": "2023-10-05T16:00:00Z",
    "StartDate": "2023-09-05T12:44:19Z",
    "CaCertificateChainPem": "-----BEGIN CERTIFICATE-----\\r\\nMIIDuzCCAqOgAwIBAgIJALTKwWAjvbMiMA0GCSqGSIb3DQEBCwUAMHQxCzAJBgNV****-----END CERTIFICATE-----",
    "BindVpcs": {
      "BindVpc": [
        {
          "RegionId": "cn-hangzhou",
          "VpcId": "vpc-bp19z7djuhtad5dff****",
          "VpcOwnerId": "190325303126****",
          "VSwitchId": "vsw-bp1i512amhdje10f1****"
        }
      ]
    },
    "ChargeType": "POSTPAY",
    "ProductVersion": "3",
    "SaleStatus": "Normal",
    "Log": 1,
    "LogStorage": 100,
    "ProductType": "kms_ddi_public_cn"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IllegalTimestamp	The input parameter Timestamp that is mandatory for processing this request is not supplied.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.