Todos os produtos
Search
Central de documentação

Key Management Service:SetSecretPolicy

Última atualização: Jun 28, 2026

Define a política de acesso para um segredo em uma instância KMS.

Descrição da operação

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

SecretName

string

Sim

O nome ou o Alibaba Cloud Resource Name (ARN) do segredo.

Nota

Ao acessar um segredo em outra conta Alibaba Cloud, você deve especificar o ARN do segredo. O ARN de um segredo está no formato acs:kms:${region}:${account}:secret/${secret-name}.

secret_test

PolicyName

string

Não

O nome da política de segredo. O valor pode ser apenas `default`.

default

Policy

string

Sim

O conteúdo da política de segredo. O valor deve estar no formato JSON. O valor pode ter até 32.768 bytes de comprimento.

Uma política de segredo contém os seguintes elementos:

  • Version: A versão da política de segredo. O valor pode ser apenas 1.

  • Statement: A declaração da política de segredo. Cada política de segredo pode conter uma ou mais declarações.

O código a seguir mostra o formato de uma política de segredo:

{
    "Version": "1",
    "Statement": [
        {
            "Sid": "Enable RAM User Permissions",
            "Effect": "Allow",
            "Principal": {
              "RAM": ["acs:ram::12345678****:*"]
            },
            "Action": [
                "kms:*"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

A seção a seguir descreve os elementos em uma declaração:

  • Sid: Opcional. O identificador personalizado da declaração. O valor pode ter até 128 caracteres de comprimento e pode conter letras maiúsculas (A-Z), letras minúsculas (a-z), dígitos (0-9) e caracteres especiais, incluindo underscores (_), barras (/), sinais de igual (=), sinais de mais (+), pontos (.), arrobas (@) e hifens (-).

  • Effect: Obrigatório. Especifica se as permissões na declaração devem ser permitidas ou negadas. Valores válidos: Allow e Deny.

  • Principal: Obrigatório. O principal autorizado a acessar o segredo. Você pode definir este parâmetro como a conta Alibaba Cloud atual (a conta à qual o segredo pertence), um usuário RAM ou função RAM da conta Alibaba Cloud atual, ou um usuário RAM ou função RAM de outra conta Alibaba Cloud.

  • Action: Obrigatório. As operações de API que são permitidas ou negadas. O valor deve começar com `kms:`. Para uma lista de operações suportadas, consulte Visão geral da política de segredo. Se você especificar uma operação que não está na lista, a operação não terá efeito.

  • Resource: Obrigatório. O valor pode ser apenas `*`, que indica o segredo KMS atual.

  • Condition: Opcional. As condições para que a autorização entre em vigor. Você pode usar condições para avaliar o contexto de uma solicitação de API para determinar se uma declaração de política é aplicável. O formato é "Condition": {"operador de condição": {"chave de condição": "valor de condição"}}. Para mais informações, consulte Visão geral da política de segredo.

Nota

Após conceder permissões a um usuário RAM ou função RAM de outra conta Alibaba Cloud, você deve acessar o console RAM e usar a conta Alibaba Cloud à qual o usuário RAM ou função RAM pertence para conceder ao usuário RAM ou função RAM as permissões para usar o segredo. Para mais informações, consulte Políticas personalizadas para KMS, Conceder permissões a um usuário RAM e Conceder permissões a uma função RAM.

{"Version":"1","Statement": [{"Sid":"kms default secret policy","Effect":"Allow","Principal":{"RAM": ["acs:ram::119285303511****:*"]},"Action":["kms:*"],"Resource": ["*"] }] }

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

RequestId

string

O ID da solicitação, que é um identificador exclusivo gerado pelo Alibaba Cloud. Você pode usar este ID para solucionar problemas.

381D5D33-BB8F-395F-8EE4-AE3BB4B523C8

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "381D5D33-BB8F-395F-8EE4-AE3BB4B523C8"
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 MissingParameter The parameter needed but no provided. The required parameters are not specified.
400 InvalidParameter The specified parameter is not valid. An invalid value is specified for the parameter.
400 Forbidden.NoPermission This operation is forbidden by permission system. You are not authorized to perform this operation.
400 Forbidden.KeyPolicyUnSupported The specified key does not support key policy. The specified key does not support key policies.
400 Rejected.ShareQuotaExceedLimit Instance Share Quota Exceed Limit. The instance share quota exceeds the limit.
403 Forbidden.DKMSInstanceStateInvalid The DKMS instance state is invalid. Your dedicated KMS instance is invalid.
404 Forbidden.ResourceNotFound Resource not found. The resource is not found.
404 Forbidden.KeyNotFound The specified Key is not found. The error message returned because the specified CMK does not exist.
503 SerivceUnvailableTemporary Service Unvailable Temporary The service is temporarily unavailable.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.