OpenAPI integration example - Create an IMM project - Intelligent Media Management: Central de Documentação do Alibaba Cloud

Crie um projeto do Intelligent Media Management (IMM) chamando a API CreateProject com o Python SDK.

Consultar a documentação da API

No API overview, localize a operação CreateProject e revise seus parâmetros obrigatórios e permissões.

Identidade e permissões

Identidade

É possível chamar esta operação de API com uma conta Alibaba Cloud, um usuário RAM ou uma função RAM. As diferenças entre identidades estão descritas em Identity, credential, and authorization. Este exemplo utiliza um usuário RAM. No RAM console, crie um usuário RAM com acesso somente via API e registre o par de AccessKey. Create a RAM user.

Autorização

Acesse Users e, na coluna Actions do usuário RAM desejado, clique em Add Permissions.
No painel Add Permissions, selecione AliyunIMMFullAccess e AliyunSTSAssumeRoleAccess.
Nota
- AliyunIMMFullAccess: Concede permissões completas de gerenciamento no IMM. Configure a service role for a project.
- Para políticas personalizadas, consulte Configure permissions for RAM users.
Clique em Grant permissions.

Credencial de acesso

Credencial de acesso temporária: use credenciais temporárias em cenários que exigem maior segurança, como acesso temporário de aplicações. Elas expiram automaticamente, reduzindo o risco de vazamento, e oferecem suporte a controle de permissões granular. Configure access credentials (Go SDK V1).
Credencial de acesso de longo prazo: evite credenciais de longo prazo sempre que possível; prefira credenciais temporárias. Caso precise de credenciais de longo prazo por conveniência, faça a rotação a cada três meses. Exclua ou desative imediatamente credenciais vazadas ou não utilizadas. Configure access credentials (Go SDK V1).

Long-term AccessKey

Um AccessKey pode ser gerado ao criar um usuário RAM.
Clique no nome do usuário RAM para abrir a página de detalhes. Na aba Authentication, clique em Create AccessKey. Create AccessKey.

STS temporary credential

Importante

Esta operação só pode ser chamada como usuário RAM ou assumindo uma função RAM — não é possível utilizá-la com uma conta Alibaba Cloud.

Crie um usuário RAM.

Create a RAM user.
Conceda ao usuário RAM a permissão AliyunSTSAssumeRoleAccess.

Grant permissions to a RAM user.
Como usuário RAM, chame a operação AssumeRole do Security Token Service (STS) para obter uma credencial de acesso temporária.

AssumeRole.

Nota

Usar um token STS para chamadas de API é mais seguro do que usar um AccessKey, pois protege seu AccessKey de longo prazo contra exposição. Ao fazer múltiplas chamadas temporárias ao IMM, atualize o token STS manualmente.

Chamar a API

Este exemplo utiliza o Python SDK. Os SDKs de outras linguagens seguem um padrão semelhante. .

Preparar o ambiente Python

Baixe e instale o Python 3.

Nota

Para verificar sua versão do Python, abra um terminal e insira python --version.

Configurar variáveis de ambiente do AccessKey

Este exemplo utiliza as variáveis de ambiente ALIBABA_CLOUD_ACCESS_KEY_ID e ALIBABA_CLOUD_ACCESS_KEY_SECRET. É possível usar nomes de variáveis diferentes, como OSS_ACCESS_KEY_ID e OSS_ACCESS_KEY_SECRET.

Importante

O par de AccessKey de uma conta Alibaba Cloud possui permissões em todas as operações de API. Recomendamos usar o par de AccessKey de um usuário RAM para chamar operações de API ou executar tarefas rotineiras de O&M.

Definir um AccessKey da Alibaba Cloud em variáveis de ambiente no Linux e macOS

Esta seção usa as variáveis de ambiente ALIBABA_CLOUD_ACCESS_KEY_ID e ALIBABA_CLOUD_ACCESS_KEY_SECRET como exemplos. Substitua os nomes das variáveis conforme necessário, por exemplo, OSS_ACCESS_KEY_ID e OSS_ACCESS_KEY_SECRET.

Configure as variáveis de ambiente usando o comando export:

Importante

Uma variável de ambiente temporária definida com o comando export é válida apenas para a sessão atual. A variável é removida quando a sessão é encerrada. Para retenção de longo prazo, adicione o comando export ao arquivo de configuração de inicialização do seu sistema operacional.

Configure o AccessKey ID e pressione Enter.

# Replace yourAccessKeyID with your AccessKey ID.
export ALIBABA_CLOUD_ACCESS_KEY_ID=yourAccessKeyID

Configure o AccessKey secret e pressione Enter.

# Replace yourAccessKeySecret with your AccessKey secret.
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=yourAccessKeySecret

Verifique a configuração.

Execute o comando echo $ALIBABA_CLOUD_ACCESS_KEY_ID. Se o comando retornar o AccessKey ID correto, a configuração foi bem-sucedida.

Definir um AccessKey da Alibaba Cloud em variáveis de ambiente no Windows

Use the graphical user interface (GUI)

Procedimento

As etapas a seguir descrevem como definir variáveis de ambiente usando a interface gráfica no Windows 10.

Na área de trabalho, clique com o botão direito em This PC e escolha Properties > Advanced system settings > Environment Variables > New em System variables ou User variables. Em seguida, conclua a configuração.

Variável	Valor de exemplo
AccessKey ID	Variable name: ALIBABA_CLOUD_ACCESS_KEY_ID Variable value: yourAccessKeyID
AccessKey secret	Variable name: ALIBABA_CLOUD_ACCESS_KEY_SECRET Variable value: yourAccessKeySecret

Testar a configuração

Clique em Start (ou use o atalho de teclado Win+R), clique em Run, insira cmd e clique em OK (ou pressione Enter) para abrir o prompt de comando. Execute os comandos echo %ALIBABA_CLOUD_ACCESS_KEY_ID% e echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%. Se os comandos retornarem o AccessKey correto, a configuração foi bem-sucedida.

Use the command prompt (CMD)

Procedimento

Abra o prompt de comando como administrador e execute os comandos a seguir para adicionar novas variáveis de ambiente ao sistema.
```
setx ALIBABA_CLOUD_ACCESS_KEY_ID yourAccessKeyID /M
setx ALIBABA_CLOUD_ACCESS_KEY_SECRET yourAccessKeySecret /M
```
O parâmetro /M indica uma variável de ambiente do sistema. Omita este parâmetro ao definir uma variável de ambiente de usuário.
Testar a configuração

Clique em Start (ou use o atalho de teclado Win+R), clique em Run, insira cmd e clique em OK (ou pressione Enter) para abrir o prompt de comando. Execute os comandos echo %ALIBABA_CLOUD_ACCESS_KEY_ID% e echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%. Se os comandos retornarem o AccessKey correto, a configuração foi bem-sucedida.

Use Windows PowerShell

No PowerShell, é possível definir novas variáveis de ambiente válidas para todas as novas sessões:

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::User)

Para definir variáveis de ambiente para todos os usuários, são necessárias permissões administrativas:

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::Machine)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::Machine)

Também é possível definir variáveis de ambiente temporárias, válidas apenas para a sessão atual:

$env:ALIBABA_CLOUD_ACCESS_KEY_ID = "yourAccessKeyID"
$env:ALIBABA_CLOUD_ACCESS_KEY_SECRET = "yourAccessKeySecret"

No PowerShell, execute os comandos Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_ID e Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET. Se os comandos retornarem o AccessKey correto, a configuração foi bem-sucedida.

Importante

Após configurar as variáveis de ambiente, pode ser necessário reiniciar suas ferramentas de desenvolvimento, como ambientes de desenvolvimento integrado (IDEs), ou os serviços para que as novas configurações entrem em vigor.

Configurar variáveis de ambiente do token STS

Mac OS X/Linux/Unix

export IMM_ACCESS_KEY_ID=<ALIBABA_CLOUD_ACCESS_KEY_ID>
export IMM_ACCESS_KEY_SECRET=<ALIBABA_CLOUD_ACCESS_KEY_SECRET>
export IMM_SESSION_TOKEN=<ALIBABA_CLOUD_SECURITY_TOKEN>

Windows

set IMM_ACCESS_KEY_ID <ALIBABA_CLOUD_ACCESS_KEY_ID>
set IMM_ACCESS_KEY_SECRET <ALIBABA_CLOUD_ACCESS_KEY_SECRET>
set IMM_SESSION_TOKEN <ALIBABA_CLOUD_SECURITY_TOKEN>

Baixar o código de exemplo e instalar dependências

pip install alibabacloud_credentials

On the Parameter Configuration tab, set the required parameters, such as projectName.

pip install alibabacloud_tea_console

Decompress the sample code package locally and go to the alibabacloud_sample directory.

Executar o código de exemplo

Execute o comando a seguir.

python sample.py

A saída retornada é a seguinte.

{
    "headers":{
        "date":"Thu, 10 Aug 2023 06:34:51 GMT",
        "content-type":"application/json;charset=utf-8",
        "content-length":"602",
        "connection":"keep-alive",
        "keep-alive":"timeout=25",
        "access-control-allow-origin":"*",
        "access-control-expose-headers":"*",
        "x-acs-request-id":"2C489857-69E6-5974-B963-A7DF99EFFF43",
        "x-acs-trace-id":"eccc35df82a086e7bb4f4fe778f****",
        "etag":"6HYADxT6iVDNgQUq+wGO****"
    },
    "statusCode":200,
    "body":{
        "Project":{
            "CreateTime":"2023-08-10T14:34:51.586696893+08:00",
            "DatasetCount":0,
            "DatasetMaxBindCount":10,
            "DatasetMaxEntityCount":10000000000,
            "DatasetMaxFileCount":100000000,
            "DatasetMaxRelationCount":100000000000,
            "DatasetMaxTotalFileSize":90000000000000000,
            "Description":"",
            "EngineConcurrency":200,
            "FileCount":0,
            "ProjectMaxDatasetCount":1000000000,
            "ProjectName":"testproject",
            "ProjectQueriesPerSecond":200,
            "ServiceRole":"AliyunIMMDefaultRole",
            "TemplateId":"Official:DefaultEmptyId",
            "TotalFileSize":0,
            "UpdateTime":"2023-08-10T14:34:51.586696977+08:00"
        },
        "RequestId":"2C489857-69E6-5974-B963-A7DF99EFFF43"
    }
}