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

Descrição da operação

Para obter mais informações sobre funções RAM, consulte Visão geral das funções RAM.

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

create

*Role

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

ram:TrustedPrincipalTypes
ram:ServiceNames

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RoleName	string	Não	O nome da função RAM. O nome deve ter de 1 a 64 caracteres e pode conter letras, dígitos, pontos (.) e hifens (-).	ECSAdmin.
Description	string	Não	A descrição da função RAM. A descrição deve ter de 1 a 1024 caracteres.	Função de gerenciamento de ECS.
AssumeRolePolicyDocument	string	Não	A política de confiança. Especifica um ou mais principais que têm permissão para assumir a função RAM. O principal pode ser uma conta Alibaba Cloud, um serviço Alibaba Cloud ou um provedor de identidade. Nota Os usuários do Resource Access Management (RAM) não podem assumir funções RAM cuja entidade confiável seja um serviço Alibaba Cloud.	{"Statement":[{"Action":"sts:AssumeRole","Effect":"Allow","Principal":{"RAM":"acs:ram::123456789012****:root"}}],"Version":"1"}
MaxSessionDuration	integer	Não	A duração máxima da sessão da função RAM. Valores válidos: 3600 a 43200. Unidade: segundos. Valor padrão: 3600. Se você deixar esse parâmetro vazio, o valor padrão será usado.	3600
Tag	array<object>	Não	As tags.
	object	Não	As tags.
Key	string	Não	A chave da tag.	k1
Value	string	Não	O valor da tag.	v1
AllowConsoleLogin	boolean	Não	Especifica se o logon no console é permitido para a função RAM. Valores válidos: true: O logon no console é permitido. false: O logon no console não é permitido.	true.

Exemplos de AssumeRolePolicyDocument

A política a seguir indica que a entidade confiável com permissão para assumir a função RAM é qualquer usuário autorizado do Resource Access Management (RAM) na conta Alibaba Cloud (AccountID=123456789012****).

{
	"Statement": [{
		"Action": "sts:AssumeRole",
		"Effect": "Allow",
		"Principal": {
			"RAM": [
				"acs:ram::123456789012****:root"
			]
		}
	}],
	"Version": "1"
}

A política a seguir indica que a entidade confiável com permissão para assumir a função RAM é o usuário RAM testuser na conta Alibaba Cloud (AccountID=123456789012****).

Nota

Antes de criar essa função, certifique-se de que o usuário RAM testuser tenha sido criado (nome de logon: testuser@123456789012****.onaliyun.com).

{
	"Statement": [{
		"Action": "sts:AssumeRole",
		"Effect": "Allow",
		"Principal": {
			"RAM": [
				"acs:ram::123456789012****:user/testuser"
			]
		}
	}],
	"Version": "1"
}

A política a seguir indica que a entidade confiável com permissão para assumir a função RAM é o serviço ECS na conta Alibaba Cloud atual.

{
	"Statement": [{
		"Action": "sts:AssumeRole",
		"Effect": "Allow",
		"Principal": {
			"Service": [
				"ecs.aliyuncs.com"
			]
		}
	}],
	"Version": "1"
}

A política a seguir indica que a entidade confiável com permissão para assumir a função RAM é o provedor de identidade SAML testprovider na conta Alibaba Cloud atual (AccountID=123456789012****).

Nota

Antes de criar essa função, certifique-se de que o provedor de identidade SAML testprovider tenha sido criado.

{
	"Statement": [{
		"Action": "sts:AssumeRole",
		"Effect": "Allow",
		"Principal": {
			"Federated": [
				"acs:ram::123456789012****:saml-provider/testprovider"
			]
		},
		"Condition": {
			"StringEquals": {
				"saml:recipient": "https://signin.aliyun.com/saml-role/sso"
			}
		}
	}],
	"Version": "1"
}

A política a seguir indica que a entidade confiável com permissão para assumir a função RAM é o provedor de identidade OIDC TestOIDCProvider na conta Alibaba Cloud atual (AccountID=123456789012****).

Nota

Antes de criar essa função, certifique-se de que o provedor de identidade OIDC TestOIDCProvider tenha sido criado.

{
	"Statement": [{
		"Action": "sts:AssumeRole",
		"Effect": "Allow",
		"Principal": {
			"Federated": [
				"acs:ram::123456789012****:oidc-provider/TestOIDCProvider"
			]
		},
		"Condition": {
			"StringEquals": {
				"oidc:aud": [
					"496271242565057****"
				],
				"oidc:iss": "https://dev-xxxxxx.okta.com",
				"oidc:sub": "KryrkIdjylZb7agUgCEf****"
			}
		}
	}],
	"Version": "1"
}

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
Role	object	As informações sobre a função RAM.
AssumeRolePolicyDocument	string	A política de confiança da função RAM.	{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }
Description	string	A descrição da função RAM.	Função de gerenciamento de ECS.
MaxSessionDuration	integer	A duração máxima da sessão da função RAM.	3600
RoleName	string	O nome da função RAM.	ECSAdmin.
CreateDate	string	A hora em que a função RAM foi criada.	2015-01-23T12:33:18Z
RoleId	string	O ID da função RAM.	901234567890****
Arn	string	O descritor de recurso da função RAM.	acs:ram::123456789012****:role/ECSAdmin.
AllowConsoleLogin	boolean	Indica se o logon no console é permitido para a função RAM.	true.
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\" }",
    "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
  },
  "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.