GetRole - Resource Access Management: Central de Documentação do Alibaba Cloud

Obtém as informações sobre uma funçã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

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

ram:GetRole

get

*Role

acs:ram:*:{#accountId}:role/{#RoleName}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RoleName	string	Não	O nome da função. O nome deve ter de 1 a 64 caracteres e pode conter letras, dígitos, pontos (.) e hifens (-).	ECSAdmin

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Role	object	As informações da função.
AssumeRolePolicyDocument	string	A política de acesso que especifica a permissão para assumir a função.	{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }
UpdateDate	string	A hora em que a função foi atualizada pela última vez. A hora está no fuso UTC no formato `YYYY-MM-DDThh:mm:ssZ`.	2015-01-23T12:33:18Z
Description	string	A descrição da função.	Função de gerenciamento do ECS
MaxSessionDuration	integer	A duração máxima da sessão da função.	3600
RoleName	string	O nome da função.	ECSAdmin
CreateDate	string	A hora em que a função foi criada. A hora está no fuso UTC no formato `YYYY-MM-DDThh:mm:ssZ`.	2015-01-23T12:33:18Z
RoleId	string	O ID da função.	901234567890****
Arn	string	O descritor de recurso da função.	acs:ram::123456789012****:role/ECSAdmin
AllowConsoleLogin	boolean	Indica se o login no console é permitido para a função RAM.	true
IsServiceLinkedRole	boolean	Indica se a função é uma função vinculada a serviço.	true
RolePrincipalName	string	O nome da função com o sufixo de nome de domínio.	ECSAdmin@role.123456.onaliyunservice.com
LatestDeletionTask	object	As informações sobre a tarefa de exclusão mais recente.
CreateDate	string	A hora em que a tarefa de exclusão foi criada. A hora está no fuso UTC no formato `YYYY-MM-DDThh:mm:ssZ`.	2018-10-23T12:33:18Z
DeletionTaskId	string	O ID da tarefa de exclusão.	task/acs-service-role/sas.aliyuncs.com/AliyunServiceRoleForSas/20843430-bb43-44fe-a7ff-02ab09183436
RequestId	string	O ID da solicitação.	04F0F334-1335-436C-A1D7-6C044FE73368

Exemplos

Resposta de sucesso

JSON formato

{
  "Role": {
    "AssumeRolePolicyDocument": "{ \"Statement\": [ { \"Action\": \"sts:AssumeRole\", \"Effect\": \"Allow\", \"Principal\": { \"RAM\": \"acs:ram::123456789012****:root\" } } ], \"Version\": \"1\" }",
    "UpdateDate": "2015-01-23T12:33:18Z",
    "Description": "Função de gerenciamento do ECS.",
    "MaxSessionDuration": 3600,
    "RoleName": "ECSAdmin.",
    "CreateDate": "2015-01-23T12:33:18Z",
    "RoleId": "901234567890****",
    "Arn": "acs:ram::123456789012****:role/ECSAdmin.",
    "AllowConsoleLogin": true,
    "IsServiceLinkedRole": true,
    "RolePrincipalName": "ECSAdmin@role.123456.onaliyunservice.com.",
    "LatestDeletionTask": {
      "CreateDate": "2018-10-23T12:33:18Z",
      "DeletionTaskId": "task/acs-service-role/sas.aliyuncs.com/AliyunServiceRoleForSas/20843430-bb43-44fe-a7ff-02ab09183436"
    }
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

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.