Object Storage Service:ossutil 2.0 CLI

Instalar o ossutil

Formato do arquivo de configuração

O arquivo de configuração usa o formato INI, que agrupa as configurações em seções de pares chave-valor. Você pode usar a opção --profile para selecionar uma seção específica. Por padrão, o ossutil usa as configurações na seção [default]. Para usar um conjunto diferente de parâmetros, você pode criar e referenciar outras seções.

Seções e pares chave-valor

Cada seção no arquivo de configuração é identificada por um nome entre colchetes [ ], e as configurações dentro da seção estão no formato chave=valor. Por exemplo:

[default]
accessKeyID = "your-access-key-id"
accessKeySecret = "your-access-key-secret"

• As configurações na seção usam o formato chave=valor.

• Os nomes das seções e as chaves não diferenciam maiúsculas de minúsculas.

• As chaves dos parâmetros de configuração aceitam vários formatos, como tudo em minúsculas, camelCase, kebab-case (separado por hífen) e snake_case (separado por sublinhado). Por exemplo, accesskeyid, accessKeyId, access-key-id e access_key_id são tratados como o mesmo nome de parâmetro.

• Linhas que começam com um sinal de cerquilha (#) são comentários.

Tipos de seção suportados

[buckets name]
bucket-name = 
  key=value

[buckets dev-bucket]
bucket-hz-01 = 
  region=cn-hangzhou
bucket-hz-02 = 
  region=cn-hangzhou
  endpoint=test.com
  addressing-style=cname
bucket-bj-01 = 
  region=cn-beijing

Estrutura dos comandos

A sintaxe básica dos comandos do ossutil é a seguinte:

ossutil command [argument] [flags]  

ossutil command subcommond [argument] [flags]  

ossutil topic

• argument: Um argumento do tipo string.

• flags: Opções com formato de nome curto (-o[=value]/ -o [ value]) e formato de nome longo (--options[=value]/--options[ value]). Se você especificar uma flag exclusiva mais de uma vez, apenas o último valor será utilizado.

A seguir estão exemplos de comandos:

• Comando: ossutil cat oss://bucket/object

• Comando com um subcomando: ossutil api get-bucket-cors --bucket bucketexample

• Tópico de ajuda: ossutil filter

Lista de comandos

• Comandos de alto nível

  Estes comandos são destinados ao gerenciamento de buckets e objetos. Você pode usá-los para criar e excluir buckets, copiar dados e modificar propriedades de objetos.

  Nome do comando	Descrição
  mb	Cria um bucket
  rb	Exclui um bucket
  du	Obtém o tamanho de armazenamento de um bucket ou de um prefixo especificado
  stat	Exibe a descrição de um bucket ou objeto
  mkdir	Cria um objeto cujo nome termina com o caractere de sufixo /
  append	Anexa conteúdo a um objeto anexável
  cat	Concatena o conteúdo do objeto na saída padrão
  ls	Lista buckets ou objetos
  cp	Faz upload, download ou cópia de objetos
  rm	Exclui objetos em um bucket
  set-props	Define as propriedades de um objeto
  presign	Gera uma URL assinada para um objeto
  restore	Restaura um objeto do estado congelado para um estado legível
  revert (restaurar versão)	Reverte um objeto para uma versão especificada
  sync	Sincroniza um diretório local ou objetos de uma origem para um destino
  hash	Calcula o valor de hash de um arquivo ou objeto

• Comandos de nível de API: Estes comandos fornecem acesso direto às operações da API e seus argumentos de configuração.

  Nota

  Apenas alguns comandos estão listados. Execute ossutil api -h para visualizar todos os comandos.

  Nome do comando	Descrição
  put-bucket-acl	Define ou modifica as permissões de acesso de um bucket.
  get-bucket-acl	Obtém as permissões de acesso de um bucket.
  ....
  put-bucket-cors	Define as regras de compartilhamento de recursos de origem cruzada (CORS) para um bucket.
  get-bucket-cors	Obtém as regras de CORS para um bucket.
  delete-bucket-cors	Exclui as regras de CORS para um bucket.

• Comandos auxiliares: Use estes comandos para gerenciar arquivos de configuração e acessar tópicos de ajuda adicionais.

  Nome do comando	Descrição
  help	Obtém informações de ajuda.
  config	Cria um arquivo de configuração para armazenar itens de configuração e credenciais de acesso.
  update	Atualiza a versão.
  version	Exibe informações sobre a versão.
  probe	Executa uma sondagem.

Tipos de opções de comando

Carregar dados de outras fontes

Embora os argumentos sejam normalmente fornecidos na linha de comando, valores complexos podem ser carregados de um arquivo. Você também pode canalizar dados da entrada padrão (standard input), o que é útil para encadear comandos.

• Iniciar com file:// indica que o conteúdo é carregado de um caminho de arquivo.

• Um valor de parâmetro igual a - indica que os dados são carregados da entrada padrão.

Por exemplo, para definir as configurações de compartilhamento de recursos de origem cruzada (CORS) de um bucket, você pode carregar a configuração de um arquivo JSON. O arquivo cors-configuration.json é o seguinte:

{
  "CORSRule": {
    "AllowedOrigin": ["www.aliyun.com"],
    "AllowedMethod": ["PUT","GET"],
    "MaxAgeSeconds": 10000
  }
}

ossutil api put-bucket-cors --bucket examplebucket --cors-configuration file://cors-configuration.json

Alternativamente, você pode fornecer a configuração CORS diretamente como o valor da opção. A string JSON compacta é a seguinte:

{"CORSRule":{"AllowedOrigin":["www.aliyun.com"],"AllowedMethod":["PUT","GET"],"MaxAgeSeconds":10000}}

ossutil api put-bucket-cors --bucket examplebucket --cors-configuration  "{\"CORSRule\":{\"AllowedOrigin\":[\"www.aliyun.com\"],\"AllowedMethod\":[\"PUT\",\"GET\"],\"MaxAgeSeconds\":10000}}"

O exemplo a seguir mostra como carregar argumentos da entrada padrão:

cat cors-configuration.json | ossutil api put-bucket-cors --bucket examplebucket --cors-configuration -

Controlar a saída do comando

Formato de saída

Para os subcomandos do comando api e para os comandos du e stat, você pode ajustar o formato de saída usando o parâmetro --output-format. Os formatos suportados são os seguintes:

Por exemplo, o conteúdo original para get-bucket-cors é o seguinte:

ossutil api get-bucket-cors --bucket bucketexample
<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration>
  <CORSRule>
    <AllowedOrigin>www.aliyun.com</AllowedOrigin>
    <AllowedMethod>PUT</AllowedMethod>
    <AllowedMethod>GET</AllowedMethod>
    <MaxAgeSeconds>10000</MaxAgeSeconds>
  </CORSRule>
  <ResponseVary>false</ResponseVary>
</CORSConfiguration>

A saída em JSON é a seguinte:

ossutil api get-bucket-cors --bucket bucketexample --output-format json
{
  "CORSRule": {
    "AllowedMethod": [
      "PUT",
      "GET"
    ],
    "AllowedOrigin": "www.aliyun.com",
    "MaxAgeSeconds": "10000"
  },
  "ResponseVary": "false"
}

Filtrar saída

O ossutil oferece um recurso integrado de filtragem no lado do cliente baseado em JSON por meio da flag --output-query value.

Este recurso baseia-se na sintaxe JMESPath. Ao utilizá-lo, a saída é convertida para JSON, filtrada usando JMESPath e então exibida no formato de saída especificado. Para mais informações sobre a sintaxe JMESPath, consulte Especificação JMESPath.

Por exemplo, para exibir apenas o conteúdo de AllowedMethod para o comando get-bucket-cors, execute o seguinte comando:

ossutil api get-bucket-cors --bucket bucketexample --output-query CORSRule.AllowedMethod --output-format json
[
  "PUT",
  "GET"
]

Formato legível por humanos

Para comandos de alto nível (du, stat), a opção --human-readable está disponível para exibir dados de bytes e quantidades em um formato legível por humanos. Os dados em bytes são convertidos para um formato com sufixos Ki, Mi, Gi, Ti ou Pi (base 1024), e os dados de quantidade são convertidos para um formato com sufixos k, m, g, t ou p (base 1000).

Exemplo: Modo bruto

ossutil stat oss://bucketexample
ACL                         : private
AccessMonitor               : Disabled
ArchiveObjectCount          : 2
ArchiveRealStorage          : 10
ArchiveStorage              : 131072
...
StandardObjectCount         : 119212
StandardStorage             : 66756852803
Storage                     : 66756852813
StorageClass                : Standard
TransferAcceleration        : Disabled

Modo legível por humanos

ossutil stat oss://bucketexample --human-readable
ACL                         : private
AccessMonitor               : Disabled
ArchiveObjectCount          : 2
ArchiveRealStorage          : 10
ArchiveStorage              : 131.072k
...
StandardObjectCount         : 119.212k
StandardStorage             : 66.757G
Storage                     : 66.757G
StorageClass                : Standard
TransferAcceleration        : Disabled

Códigos de retorno dos comandos

Ao executar o ossutil em um script, você pode verificar seu código de retorno final para confirmar o resultado. Esse código indica se a operação foi bem-sucedida e permite tratar erros programaticamente.

Opções globais de linha de comando