IBM Cloud Docs
IBM Cloud Object Storage CLI

IBM Cloud Object Storage CLI

O plug-in do IBM Cloud® Object Storage amplia a interface da linha de comandos (CLI) do IBM Cloud com um wrapper de API para trabalhar com os recursos do Object Storage.

Instalação e configuração

O plug-in é compatível com Linux (x86_64, arm64, ppc64le, s390x), Windows ® (x64) e plataformas macOS® (amd64, arm64) que são executadas em processadores de 64 bits.

Instale o plug-in usando o comando plugin install.

ibmcloud plugin install cloud-object-storage

Quando o plug-in for instalado, será possível configurar o plug-in usando o comando ibmcloud cos config. Isso pode ser usado para preencher o plug-in com suas credenciais, local de download padrão, escolha de autenticação e assim por diante.

Para obter um desempenho ideal, assegure-se de que o rastreio esteja desativado configurando a variável de ambiente IBMCLOUD_TRACE como false.

O programa também oferece a capacidade de configurar o diretório local padrão para arquivos transferidos por download e de configurar uma região padrão. Para configurar o local de download padrão, digite ibmcloud cos config ddl e insira no programa um caminho de arquivo válido. Para configurar uma região padrão, digite ibmcloud cos config region e forneça uma entrada para o programa de um código de região, como us-south. Por padrão, esse valor é configurado como us-geo.

Você pode visualizar suas credenciais atuais do site IBM Cloud Object Storage acessando ibmcloud cos config list. Como o arquivo de configuração é gerado pelo plug-in, é melhor não editar o arquivo manualmente.

$ ibmcloud cos config list
Key                     Value
Last Updated            Tuesday, April 28 2020 at 19:35:57
Default Region          us-south
Download Location       /home/ibmuser/Downloads
CRN                     8f275e7b-c076-49e2-b9c5-f985704cf678
AccessKeyID             9eib1eejar6HaezaohveV5hikei4aNg2ooV0qu
SecretAccessKey         ********************************************
Authentication Method   IAM
URL Style               VHost

Autenticação do IAM

Se você estiver usando a autenticação do IAM, deverá configurar seu cliente com um ID da instância para usar alguns dos comandos. Para obter mais informações sobre como criar uma instância de serviço, consulte Criação de uma instância de serviço. Para recuperar o ID da instância, digite ibmcloud resource service-instance <INSTANCE_NAME> --id, substitua <INSTANCE_NAME> pelo alias exclusivo que você atribuiu à sua instância de serviço. Nos exemplos abaixo, o valor 8f275e7b-c076-49e2-b9c5-f985704cf678 é um exemplo de ID de instância.

Primeiro, recupere o CRN e o ID com o nome de sua instância Certifique-se de usar aspas (') no nome da sua instância e que você tenha efetuado login no IBM Cloud. Apenas a última parte do CRN é necessária, a parte após ::..

$ ibmcloud resource service-instance 'My Awesome Cloud Object Storage'  --id
Retrieving service instance My Awesome Cloud Object Storage in all resource groups under account IBM as ibmuser@us.ibm.com...
crn:v1:bluemix:public:cloud-object-storage:global:a/94400e98c553415c9599db39b9be9219:3b7d66c8-9fdf-4f81-b7e6-08d187f07288:: 8f275e7b-c076-49e2-b9c5-f985704cf678

Configure o CRN com o comando ibmcloud cos config crn. Pode avisá-lo sobre sobrescrever. Se você não desejar fornecer o CRN interativamente, poderá fornecê-lo no mesmo comando com a sinalização --crn.

$ ibmcloud cos config crn
Resource Instance ID CRN:  ()> 8f275e7b-c076-49e2-b9c5-f985704cf678
Saving new Service Instance ID...
OK
Successfully stored your service instance ID.

Verifique a configuração:

$ ibmcloud cos config crn --list
Key   Value
CRN   8f275e7b-c076-49e2-b9c5-f985704cf678

Como alternativa, é possível abrir o console baseado na web, selecionar Credenciais de serviço na barra lateral e criar um novo conjunto de credenciais (ou visualizar um arquivo de credencial existente que você já criou).

Credenciais HMAC

Se preferir, as credenciais HMAC do ID de serviço poderão ser usadas em vez de sua chave de API. Execute ibmcloud cos config hmac para inserir as credenciais HMAC e, em seguida, alterne o método de autorização usando ibmcloud cos config auth.

Se escolher usar a autenticação do token com sua própria chave de API, não será necessário fornecer nenhuma credencial, pois o programa autenticará você automaticamente.

A qualquer momento, para alternar entre a autenticação HMAC e IAM, é possível digitar ibmcloud cos config auth. Para obter mais informações sobre autenticação e autorização no IBM Cloud, consulte a documentação doIdentity and Access Management

Ativar rastreio na interface da linha de comandos

O rastreio pode ser ativado configurando a variável de ambiente IBMCLOUD_TRACE como true (maiúsculas e minúsculas ignoradas). Quando o rastreio está ativado, informações adicionais de depuração são impressas para o terminal.

No terminal Linux/macOS:

export IBMCLOUD_TRACE=true

No prompt do Windows:

SET IBMCLOUD_TRACE=true

Para desativar o rastreio, configure a variável de ambiente IBMCLOUD_TRACE como false (maiúsculas e minúsculas ignoradas).

Índice de comando

Cada operação tem uma explicação sobre o que ela faz, como usá-la e os parâmetros opcionais ou obrigatórios. A menos que especificados como opcionais, quaisquer parâmetros listados são necessários.

O plug-in da CLI ainda não suporta o conjunto completo de recursos disponíveis no Object Storage. Aspera High-Speed Transfer, Immutable Object Storage, criando buckets Key Protect ou Bucket Firewalls não pode ser usado pela CLI

Interromper um upload de múltiplas partes

  • Ação: interrompa uma instância de upload de múltiplas partes, terminando o upload para o depósito na conta do IBM Cloud Object Storage do usuário.
  • Uso: ibmcloud cos multipart-upload-abort --bucket BUCKET_NAME --key KEY --upload-id ID [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • O ID de upload que identifica o upload de múltiplas partes.
      • Sinalização: --upload-id ID
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Configurar um website estático

  • Ação: Configura um depósito para hospedar um website estático

  • Uso: ibmcloud cos bucket-website-put --bucket BUCKET_NAME [--region REGION] [--output FORMAT]

  • Parâmetros a serem fornecidos:

    • O nome do depósito.

      • Sinalização: --bucket BUCKET_NAME
    • A configuração do website na forma de uma estrutura JSON.. O prefixo file:// é usado para carregar a estrutura JSON do arquivo especificado, como --website-configuration file://<filename.json>.

      • Sinalização: --website-configuration STRUCTURE Os seguintes parâmetros estão disponíveis para configurar o comportamento estático do website. Nenhum é necessário.. Para obter mais detalhes, consulte a documentação

        {
          "ErrorDocument": {
            "Key": "string"
          },
          "IndexDocument": {
            "Suffix": "string"
          },
          "RoutingRules": [
            {
              "Condition": {
                "HttpErrorCodeReturnedEquals": "string",
                "KeyPrefixEquals": "string"
              },
              "Redirect": {
                "HostName": "string",
                "HttpRedirectCode": "string",
                "Protocol": "http"|"https",
                "ReplaceKeyPrefixWith": "string",
                "ReplaceKeyWith": "string"
              }
            }
            ...
          ]
        }
        

        Como alternativa, se o website do depósito for configurado para redirecionar o tráfego, ele deverá ser o único parâmetro configurado:.

        	  "RedirectAllRequestsTo": {
        	    "HostName": "string",
        	    "Protocol": "http"|"https"
        	  }
        	  ```
        
        
        
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.

      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.

      • Sinalização: --output FORMAT

Copiar objeto do depósito

Se você desejar incluir metadados em um objeto durante a cópia (usando o recurso --metadata ), deverá incluir o atributo --metadata-directive REPLACE, pois os metadados são copiados durante a operação por padrão (um --metadata-directive COPY implícito).

  • Ação: copie um objeto do depósito de origem para o depósito de destino.
  • Uso: ibmcloud cos object-copy --bucket BUCKET_NAME --key KEY --copy-source SOURCE [--cache-control CACHING_DIRECTIVES] [--content-disposition DIRECTIVES] [--content-encoding CONTENT_ENCODING] [--content-language LANGUAGE] [--content-type MIME] [--copy-source-if-match ETAG] [--copy-source-if-modified-since TIMESTAMP] [--copy-source-if-none-match ETAG] [--copy-source-if-unmodified-since TIMESTAMP] [--metadata MAP] [--metadata-directive DIRECTIVE] [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do bucket de destino.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • (SOURCE) O nome do bucket de origem e o nome da chave do objeto de origem, que são separados por uma barra (/). Deve ser URL-encoded.
      • Sinalização: --copy-source SOURCE
    • Opcional : Especifica CACHING_DIRECTIVES para a cadeia de solicitação e resposta.
      • Sinalização: --cache-control CACHING_DIRECTIVES
    • Opcional : Especifica as informações de apresentação (DIRECTIVES).
      • Sinalização: --content-disposition DIRECTIVES
    • Opcional : Especifica quais codificações de conteúdo (CONTENT_ENCODING) são aplicadas ao objeto e, portanto, quais mecanismos de decodificação devem ser aplicados para obter o tipo de mídia referenciado pelo campo de cabeçalho Content-Type.
      • Sinalização: --content-encoding CONTENT_ENCODING
    • Opcional : O IDIOMA em que o conteúdo está.
      • Sinalização: --content-language LANGUAGE
    • Opcional : Um tipo MIME padrão que descreve o formato dos dados do objeto.
      • Sinalização: --content-type MIME
    • Opcional : Copia o objeto se sua tag de entidade (Etag) corresponder à tag especificada (ETAG).
      • Sinalização: --copy-source-if-match ETAG
    • Opcional : Copia o objeto se ele tiver sido modificado desde a hora especificada (TIMESTAMP).
      • Sinalização: --copy-source-if-modified-since TIMESTAMP
    • Opcional : Copia o objeto se sua tag de entidade (ETag) for diferente da tag especificada (ETAG).
      • Sinalização: --copy-source-if-none-match ETAG
    • Opcional : Copia o objeto se ele não tiver sido modificado desde o tempo especificado (TIMESTAMP).
      • Sinalização: --copy-source-if-unmodified-since TIMESTAMP
    • Opcional : Um MAP de metadados a serem armazenados.
      • Sinalização: --metadata MAP Sintaxe de JSON: O sinalizador --metadata usa o prefixo file:// que é usado para carregar a estrutura JSON do arquivo especificado.
      {
        "file_name": "file_20xxxxxxxxxxxx45.zip",
        "label": "texas",
        "state": "Texas",
        "Date_to": "2019-11-09T16:00:00.000Z",
        "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
        "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
      }
      ```

   * _Optional_: Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. DIRECTIVE values: COPY,REPLACE.
        * Flag: ` --metadata-directive DIRECTIVE`
    * _Optional_: The REGION where the bucket is present. If this flag is not provided, the program uses the default option that is specified in config.
        * Flag: `--region REGION`
    * _Optional_: Output FORMAT can be only json or text.
        * Flag: `--output FORMAT`

Criar um novo depósito

  • Ação: crie um depósito em uma instância do IBM Cloud Object Storage.
  • Uso: ibmcloud cos bucket-create --bucket BUCKET_NAME [--class CLASS_NAME][--class onerate_active] [--ibm-service-instance-id ID] [--region REGION] [--output FORMAT]
    • Observe que se deve fornecer um CRN se você está usando a autenticação IAM. Isso pode ser configurado usando o comando ibmcloud cos config crn..
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : O nome da classe.
      • Sinalização: --class CLASS_NAME
    • O usuário deve especificar onerate_active ao criar um bucket.
      • Sinalização: --class onerate_active
    • Opcional : Define a ID da instância de serviço IBM na solicitação.
      • Sinalização: --ibm-service-instance-id ID
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Crie um novo intervalo com Key Protect

  • Ação: Criar um bucket com Key Protect em uma instância IBM Cloud Object Storage.
  • Uso: bucket-create --bucket BUCKET_NAME [--ibm-service-instance-id ID] [--class CLASS_NAME] [--region REGION] --kms-root-key-crn CUSTOMERROOTKEYCRN --kms-encryption-algorithm ALGORITHM [--output FORMAT] [--json]
    • Observe que se deve fornecer um CRN se você está usando a autenticação IAM. Isso pode ser configurado usando o comando ibmcloud cos config crn..
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • O CUSTOMERROOTKEYCRN da chave raiz do KMS a ser associada ao bucket para criptografia de dados.
      • Sinalização: --kms-root-key-crn CUSTOMERROOTKEYCRN
    • Opcional : O ALGORITMO e o TAMANHO a serem usados com a chave de criptografia armazenada usando a proteção de chave.
      • Sinalização: --kms-encryption-algorithm ALGORITHM
    • Opcional : O nome da classe.
      • Sinalização: --class CLASS_NAME
    • Opcional : Define a ID da instância de serviço IBM na solicitação.
      • Sinalização: --ibm-service-instance-id ID
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT
    • (Preterido): Saída retornada no formato JSON bruto...
      • Sinalização: --json

Exemplo:

ibmcloud cos bucket-create --bucket bucket-name --kms-root-key-crn crn:v1:staging:public:kms:us-south:a/9978e0xxxxxxxxxxxxxxxxxxxxxx8654:dfdxxxxx-xxxx-xxxx-xxxx-xxxxxxba6eb0:key:7cea005e-75d4-4a08-ad2f-5e56141f6a96 --kms-encryption-algorithm AES256

Crie um novo depósito com Hyper Protect Crypto Services

  • Ação: crie um novo depósito com Hyper Protect Crypto Services.
  • Uso: bucket-create --bucket BUCKET_NAME [--ibm-service-instance-id ID] [--class CLASS_NAME] [--region REGION] --kms-root-key-crn CUSTOMERROOTKEYCRN --kms-encryption-algorithm ALGORITHM [--output FORMAT] [--json]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • O CUSTOMERROOTKEYCRN da chave raiz do KMS a ser associada ao bucket para criptografia de dados.
      • Sinalização: --kms-root-key-crn CUSTOMERROOTKEYCRN
    • Opcional : O ALGORITMO e o TAMANHO a serem usados com a chave de criptografia armazenada usando a proteção de chave.
      • Sinalização: --kms-encryption-algorithm ALGORITHM
    • Opcional : O nome da classe.
      • Sinalização: --class CLASS_NAME
    • Opcional : Define a ID da instância de serviço IBM na solicitação.
      • Sinalização: --ibm-service-instance-id ID
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT
    • (Preterido): Saída retornada no formato JSON bruto...
      • Sinalização: --json

Exemplo:

ibmcloud cos bucket-create --bucket bucket-name --kms-root-key-crn crn:v1:bluemix:public:hs-crypto:us-south:a/ee747e4xxxxxxxxxxxxxxxxxxxxxx7559:ac6xxxxx-xxxx-xxxx-xxxx-xxxxxx1bea99:key:e7451f36-d7ea-4f55-bc1c-ce4bcceb7018

Criar um novo upload de múltiplas partes

  • Ação: inicie o processo de upload de arquivo de várias partes criando uma nova instância de upload de múltiplas partes.

  • Uso: ibmcloud cos multipart-upload-create --bucket BUCKET_NAME --key KEY [--cache-control CACHING_DIRECTIVES] [--content-disposition DIRECTIVES] [--content-encoding CONTENT_ENCODING] [--content-language LANGUAGE] [--content-type MIME] [--metadata MAP] [--region REGION] [--output FORMAT]

  • Parâmetros a serem fornecidos:

    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • Opcional : Especifica CACHING_DIRECTIVES para a cadeia de solicitação e resposta.
      • Sinalização: --cache-control CACHING_DIRECTIVES
    • Opcional : Especifica as informações de apresentação (DIRECTIVES).
      • Sinalização: --content-disposition DIRECTIVES
    • Opcional : Especifica a codificação de conteúdo (CONTENT_ENCODING) do objeto.
      • Sinalização: --content-encoding CONTENT_ENCODING
    • Opcional : O IDIOMA em que o conteúdo está.
      • Sinalização: --content-language LANGUAGE
    • Opcional : Um tipo MIME padrão que descreve o formato dos dados do objeto.
      • Sinalização: --content-type MIME
    • Opcional : Um MAP de metadados a serem armazenados.
      • Sinalização: --metadata MAP Sintaxe de JSON: O sinalizador --metadata usa o prefixo file:// que é usado para carregar a estrutura JSON do arquivo especificado.
    {
      "file_name": "file_20xxxxxxxxxxxx45.zip",
      "label": "texas",
      "state": "Texas",
      "Date_to": "2019-11-09T16:00:00.000Z",
      "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
      "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
    }
    
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Excluir um depósito existente

  • Ação: exclua um depósito existente em uma instância do IBM Cloud Object Storage.
  • Uso: ibmcloud cos bucket-delete --bucket BUCKET_NAME [--region REGION] [--force] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : A operação não solicitará confirmação.
      • Sinalização: --force
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Excluir o CORS de depósito

  • Ação: exclua a configuração de CORS em um depósito na conta do IBM Cloud Object Storage de um usuário.
  • Uso: ibmcloud cos bucket-cors-delete --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Excluir uma configuração de website estático

  • Ação: remove a configuração do website estático de um depósito
  • Uso: ibmcloud cos bucket-website-delete --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.

      • Sinalização: --bucket BUCKET_NAME
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Excluir um objeto

  • Ação: exclua um objeto de um depósito na conta do IBM Cloud Object Storage de um usuário.
  • Uso: ibmcloud cos object-delete --bucket BUCKET_NAME --key KEY [--region REGION] [--force] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : A operação não solicitará confirmação.
      • Sinalização: --force
      • Opcional : O FORMATO de saída pode ser apenas json ou texto.
        • Sinalização: --output FORMAT

Excluir múltiplos objetos

  • Ação: exclua múltiplos objetos de um depósito na conta do IBM Cloud Object Storage de um usuário.

  • Uso: ibmcloud cos objects-delete --bucket BUCKET_NAME --delete STRUCTURE [--region REGION] [--output FORMAT]

  • Parâmetros a serem fornecidos:

    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Uma STRUCTURE usando a sintaxe de abreviação ou JSON.
      • Sinalização: --delete STRUCTURE
      • Sintaxe de abreviação: --delete 'Objects=[{Key=string},{Key=string}],Quiet=boolean'
      • Sintaxe de JSON: --delete file://<filename.json>

        O comando --delete usa uma estrutura JSON que lista os objetos a serem excluídos Neste exemplo, o prefixo file:// é usado para carregar a estrutura JSON do arquivo especificado.
    	{
    	"Objects": [
    	{
    	"Key": "string",
    	"VersionId": "string"
    	}
    ...
    	],
    	"Quiet": true|false
    	}
    
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Fazer download de um objeto

  • Ação: faça download de um objeto de um depósito na conta do IBM Cloud Object Storage de um usuário.
  • Uso: ibmcloud cos object-get --bucket BUCKET_NAME --key KEY [--if-match ETAG] [--if-modified-since TIMESTAMP] [--if-none-match ETAG] [--if-unmodified-since TIMESTAMP] [--range RANGE] [--response-cache-control HEADER] [--response-content-disposition HEADER] [--response-content-encoding HEADER] [--response-content-language HEADER] [--response-content-type HEADER] [--response-expires HEADER] [--region REGION] [--output FORMAT] [OUTFILE]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • Opcional : Retorna o objeto somente se sua tag de entidade (ETag) for a mesma que a ETAG especificada; caso contrário, retorna um 412 (falha na pré-condição).
      • Sinalização: --if-match ETAG
    • Opcional : Retorna o objeto somente se ele tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorna um 304 (não modificado).
      • Sinalização: --if-modified-since TIMESTAMP
    • Opcional : Retorna o objeto somente se sua tag de entidade (ETag) for diferente da ETAG especificada; caso contrário, retorna um 304 (não modificado).
      • Sinalização: --if-none-match ETAG
    • Opcional : Retorna o objeto somente se ele não tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorna um 412 (falha na pré-condição).
      • Sinalização: --if-unmodified-since TIMESTAMP
    • Opcional : Faz o download dos bytes RANGE especificados de um objeto.
      • Sinalização: --range RANGE
    • Opcional : Define o HEADER de controle de cache da resposta.
      • Sinalização: --response-cache-control HEADER
    • Opcional : Define o HEADER Content-Disposition da resposta.
      • Sinalização: --response-content-disposition HEADER
    • Opcional : Define o HEADER Content-Encoding da resposta.
      • Sinalização: --response-content-encoding HEADER
    • Opcional : Define o HEADER Content-Language da resposta.
      • Sinalização: --response-content-language HEADER
    • Opcional : Define o HEADER Content-Type da resposta.
      • Sinalização: --response-content-type HEADER
    • Opcional : Define o HEADER Expires da resposta.
      • Sinalização: --response-expires HEADER
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT
    • Opcional : O local onde salvar o conteúdo do objeto. Se esse parâmetro não for fornecido, o programa usará o local padrão.
      • Parâmetro: OUTFILE

Faça o download de objetos usando S3Manager

  • Ação: faça download de objetos do S3 simultaneamente.
  • Uso: ibmcloud cos download --bucket BUCKET_NAME --key KEY [--concurrency value] [--part-size SIZE] [--if-match ETAG] [--if-modified-since TIMESTAMP] [--if-none-match ETAG] [--if-unmodified-since TIMESTAMP] [--range RANGE] [--response-cache-control HEADER] [--response-content-disposition HEADER] [--response-content-encoding HEADER] [--response-content-language HEADER] [--response-content-type HEADER] [--response-expires HEADER] [--region REGION] [--output FORMAT] [OUTFILE]
  • Parâmetros a serem fornecidos:
    • O nome (BUCKET_NAME) do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • Opcional : O número de rotinas go a serem executadas em paralelo por chamada para download ao enviar peças. O valor padrão é 5.
      • Sinalização: --concurrency value
    • Opcional : O TAMANHO do buffer (em bytes) a ser usado ao armazenar dados em pedaços e finalizá-los como partes em S3. O tamanho de parte mínimo permitido é de 5 MB.
      • Sinalização: --part-size SIZE
    • Opcional : Retorna o objeto somente se sua tag de entidade (ETag) for a mesma que a ETAG especificada; caso contrário, retorna um 412 (falha na pré-condição).
      • Sinalização: --if-match ETAG
    • Opcional : Retorna o objeto somente se ele tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorna um 304 (não modificado).
      • Sinalização: --if-modified-since TIMESTAMP
    • Opcional : Retorna o objeto somente se sua tag de entidade (ETag) for diferente da ETAG especificada; caso contrário, retorna um 304 (não modificado).
      • Sinalização: --if-none-match ETAG
    • Opcional : Retorna o objeto somente se ele não tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorna um 412 (falha na pré-condição).
      • Sinalização: --if-unmodified-since TIMESTAMP
    • Opcional : Faz o download dos bytes RANGE especificados de um objeto. Para obter mais informações sobre o cabeçalho do Intervalo de HTTP, clique aqui.
      • Sinalização: --range RANGE
    • Opcional : Define o HEADER de controle de cache da resposta.
      • Sinalização: --response-cache-control HEADER
    • Opcional : Define o HEADER Content-Disposition da resposta.
      • Sinalização: --response-content-disposition HEADER
    • Opcional : Define o HEADER Content-Encoding da resposta.
      • Sinalização: --response-content-encoding HEADER
    • Opcional : Define o HEADER Content-Language da resposta.
      • Sinalização: --response-content-language HEADER
    • Opcional : Define o HEADER Content-Type da resposta.
      • Sinalização: --response-content-type HEADER
    • Opcional : Define o HEADER Expires da resposta.
      • Sinalização: --response-expires HEADER
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT
    • Opcional : O local onde salvar o conteúdo do objeto. Se esse parâmetro não for fornecido, o programa usará o local padrão.
      • Parâmetro: OUTFILE

Localizar um depósito

  • Ação: determine a região e a classe de um depósito em uma instância do IBM Cloud Object Storage.
  • Uso: ibmcloud cos bucket-location-get --bucket BUCKET_NAME [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Obter a classe de um depósito

  • Ação: Determine a classe de um depósito em uma instância do IBM Cloud Object Storage.
  • Uso: ibmcloud cos bucket-class-get --bucket BUCKET_NAME [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Obter o CORS de depósito

  • Ação: retorna a configuração de CORS para o depósito na conta do IBM Cloud Object Storage de um usuário.
  • Uso: ibmcloud cos bucket-cors-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Obter os cabeçalhos de um depósito

  • Ação: determine se um depósito existe em uma instância do IBM Cloud Object Storage.
  • Uso: ibmcloud cos bucket-head --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Concluir um upload de múltiplas partes

  • Ação: conclua uma instância de upload de múltiplas partes, montando as partes atualmente transferidas por upload e fazendo upload do arquivo para o depósito na conta do IBM Cloud Object Storage do usuário.
  • Uso: ibmcloud cos multipart-upload-complete --bucket BUCKET_NAME --key KEY --upload-id ID --multipart-upload STRUCTURE [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.

      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.

      • Sinalização: --key KEY
    • O ID de upload que identifica o upload de múltiplas partes.

      • Sinalização: --upload-id ID
    • A STRUCTURE de MultipartUpload a ser configurada.

      • Sinalização: --multipart-upload STRUCTURE
      • Sintaxe de abreviação: --multipart-upload 'Parts=[{ETag=string,PartNumber=integer},{ETag=string,PartNumber=integer}]'
      • Sintaxe de JSON: --multipart-upload file://<filename.json>

        O comando --multipart-upload usa uma estrutura JSON que descreve as partes do upload de múltiplas partes que devem ser remontadas no arquivo completo. Neste exemplo, o prefixo file:// é usado para carregar a estrutura JSON do arquivo especificado.
      		{
      		"Parts": [
      			{
      			 "ETag": "string",
      			 "PartNumber": integer
      			}
      			...
      			]
      		}
      
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.

      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.

      • Sinalização: --output FORMAT

Configurar o programa

  • Ação: configure as preferências do programa.
  • Uso: ibmcloud cos config [COMMAND]
  • Comandos:
    • Alterne entre a autenticação HMAC e IAM.
      • Comando: auth
    • Armazene o CRN na configuração.
      • Comando: crn
    • Armazene o local de download padrão na configuração.
      • Comando: ddl
    • Armazene as credenciais HMAC na configuração.
      • Comando: hmac
    • Liste a configuração.
      • Comando: list
    • Armazene a região padrão na configuração.
      • Comando: region
    • Alterne entre os estilos VHost e Path URL.
      • Comando: url-style
    • Configure o Terminal em Serviço Padrão
      • Comando: endpoint-url
        • Parâmetros:

          • --list exibe o Terminal em serviço padrão atual, se ele tiver sido configurado Caso contrário, ele estará vazio.
          • --url some.end.point.url alterará o Terminal em Serviço para o valor fornecido.
          • --clear remove o Service Endpoint URL padrão que foi definido.

Obter uma configuração de website estático

  • Ação: obtém uma configuração de website estático de um depósito.
  • Uso: ibmcloud cos bucket-website-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.

      • Sinalização: --bucket BUCKET_NAME
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Obter cabeçalhos de um objeto

  • Ação: determine se um arquivo existe em um depósito na conta do IBM Cloud Object Storage de um usuário.
  • Uso: ibmcloud cos object-head --bucket BUCKET_NAME --key KEY [--if-match ETAG] [--if-modified-since TIMESTAMP] [--if-none-match ETAG] [--if-unmodified-since TIMESTAMP] [--range RANGE] [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • Opcional : Retorna o objeto somente se sua tag de entidade (ETag) for a mesma que a ETAG especificada; caso contrário, retorna um 412 (falha na pré-condição).
      • Sinalização: --if-match ETAG
    • Opcional : Retorna o objeto somente se ele tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorna um 304 (não modificado).
      • Sinalização: --if-modified-since TIMESTAMP
    • Opcional : Retorna o objeto somente se sua tag de entidade (ETag) for diferente da ETAG especificada; caso contrário, retorna um 304 (não modificado).
      • Sinalização: --if-none-match ETAG
    • Opcional : Retorna o objeto somente se ele não tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorna um 412 (falha na pré-condição).
      • Sinalização: --if-unmodified-since TIMESTAMP
    • Faz download dos bytes de RANGE especificados de um objeto.
      • Sinalização: --range RANGE
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Listar todos os depósitos

  • Ação: imprima uma lista de todos os depósitos na conta do IBM Cloud Object Storage de um usuário. Os depósitos podem estar localizados em regiões diferentes.
  • Uso: ibmcloud cos buckets [--ibm-service-instance-id ID] [--output FORMAT]
    • Observe que se deve fornecer um CRN se você está usando a autenticação IAM. Isso pode ser configurado usando o comando ibmcloud cos config crn..
  • Parâmetros a serem fornecidos:
    • Nenhum parâmetro a ser fornecido.
      • Opcional : Define a ID da instância de serviço IBM na solicitação.
        • Sinalização: --ibm-service-instance-id
      • Opcional : O FORMATO de saída pode ser apenas json ou texto.
        • Sinalização: --output FORMAT

Listagem ampliada de depósitos

  • Ação: imprima uma lista de todos os depósitos na conta do IBM Cloud Object Storage de um usuário. Os depósitos podem estar localizados em regiões diferentes.
  • Uso: ibmcloud cos buckets-extended [--ibm-service-instance-id ID] [--marker KEY] [--prefix PREFIX] [--page-size SIZE] [--max-items NUMBER] [--output FORMAT]
    • Observe que se deve fornecer um CRN se você está usando a autenticação IAM. Isso pode ser configurado usando o comando ibmcloud cos config crn..
  • Parâmetros a serem fornecidos:
    • Nenhum parâmetro a ser fornecido.
      • Opcional : Define a ID da instância de serviço IBM na solicitação.
        • Sinalização: --ibm-service-instance-id
      • Opcional : Especifica a CHAVE com a qual começar ao listar objetos em um bucket.
        • Sinalização: --marker KEY
      • Opcional : Limita a resposta às chaves que começam com o PREFIXO especificado.
        • Sinalização: --prefix PREFIX
      • Opcional : O TAMANHO de cada página a ser obtida na chamada de serviço. Isso não afeta o número de itens retornados na saída do comando. A configuração de um tamanho de página menor resulta em mais chamadas para o serviço, recuperando menos itens em cada chamada. Isso pode ajudar a evitar que as chamadas de serviço atinjam o tempo limite.
        • Sinalização: --page-size SIZE
      • Opcional : O NÚMERO total de itens a serem retornados na saída do comando.
        • Sinalização: --max-items NUMBER
      • Opcional : O FORMATO de saída pode ser apenas json ou texto.
        • Sinalização: --output FORMAT

Listar uploads de múltiplas partes em andamento

  • Ação: lista os uploads de múltiplas partes em andamento.
  • Uso: ibmcloud cos multipart-uploads --bucket BUCKET_NAME [--delimiter DELIMITER] [--encoding-type METHOD] [--prefix PREFIX] [--key-marker value] [--upload-id-marker value] [--page-size SIZE] [--max-items NUMBER] [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : Um DELIMITADOR é um caractere que você usa para agrupar chaves.
      • Sinalização: --delimiter DELIMITER
    • Opcional : Solicita a codificação das chaves do objeto na resposta e especifica o MÉTODO de codificação a ser usado.
      • Sinalização: --encoding-type METHOD
    • Opcional : Limita a resposta às chaves que começam com o PREFIXO especificado.
      • Sinalização: --prefix PREFIX
    • Opcional : Juntamente com upload-id-marker, esse parâmetro especifica o upload de várias partes após o qual a listagem deve começar.
      • Sinalização: --key-marker value
    • Opcional : Juntamente com o marcador de chave, especifica o upload de várias partes após o qual a listagem deve começar. Se key-marker não for especificado, o parâmetro upload-id-marker será ignorado.
      • Sinalização: --upload-id-marker value
    • Opcional : O TAMANHO de cada página a ser obtida na chamada de serviço. Isso não afeta o número de itens retornados na saída do comando. A configuração de um tamanho de página menor resulta em mais chamadas para o serviço, recuperando menos itens em cada chamada. Isso pode ajudar a evitar que as chamadas de serviço atinjam o tempo limite. (padrão: 1000).
      • Sinalização: --page-size SIZE
    • Opcional : O NÚMERO total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um NextToken será fornecido na saída do comando. Para retomar a paginação, forneça o valor NextToken no argumento starting-token de um comando subsequente. (padrão: 0).
      • Sinalização: --max-items NUMBER
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Listar objetos

  • Ação: liste arquivos presentes em um depósito na conta do IBM Cloud Object Storage de um usuário. Essa operação está atualmente limitada aos 1.000 objetos criados mais recentemente e não pode ser filtrada.
  • Uso: ibmcloud cos objects --bucket BUCKET_NAME [--delimiter DELIMITER] [--encoding-type METHOD] [--prefix PREFIX] [--starting-token TOKEN] [--page-size SIZE] [--max-items NUMBER] [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : Um DELIMITADOR é um caractere que você usa para agrupar chaves.
      • Sinalização: --delimiter DELIMITER
    • Opcional : Solicita a codificação das chaves do objeto na resposta e especifica o MÉTODO de codificação a ser usado.
      • Sinalização: --encoding-type METHOD
    • Opcional : Limita a resposta às chaves que começam com o PREFIXO especificado.
      • Sinalização: --prefix PREFIX
    • Opcional : Um TOKEN para especificar onde começar a paginação. Esse é o NextToken de uma resposta truncada anteriormente.
      • Sinalização: --starting-token TOKEN
    • Opcional : O TAMANHO de cada página a ser obtida na chamada de serviço. Isso não afeta o número de itens retornados na saída do comando. A configuração de um tamanho de página menor resulta em mais chamadas para o serviço, recuperando menos itens em cada chamada. Isso pode ajudar a evitar que as chamadas de serviço atinjam o tempo limite. (padrão: 1000)
      • Sinalização: --page-size SIZE
    • Opcional : O NÚMERO total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um NextToken será fornecido na saída do comando. Para retomar a paginação, forneça o valor NextToken no argumento starting-token de um comando subsequente. (padrão: 0)
      • Sinalização: --max-items NUMBER
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Listar objetos v2

  • Ação: Listar todos os objetos em um intervalo específico.
  • Uso: list-objects-v2 --bucket BUCKET_NAME [--starting-token Starting Token] [--delimiter DELIMITER] [--encoding-type METHOD] [--fetch-owner Boolean] [--max-items NUMBER] [--prefix PREFIX] [--start-after Start After] [--page-size SIZE] [--region REGION] [--output FORMAT] [--json]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : Um DELIMITADOR é um caractere que você usa para agrupar chaves.
      • Sinalização: --delimiter DELIMITER
    • Opcional : Solicita a codificação das chaves do objeto na resposta e especifica o MÉTODO de codificação a ser usado.
      • Sinalização: --encoding-type METHOD
    • Opcional : Limita a resposta às chaves que começam com o PREFIXO especificado.
      • Sinalização: --prefix PREFIX
    • Opcional : Um TOKEN para especificar onde começar a paginação. Esse é o NextToken de uma resposta truncada anteriormente.
      • Sinalização: --starting-token TOKEN
    • Opcional : O TAMANHO de cada página a ser obtida na chamada de serviço. Isso não afeta o número de itens retornados na saída do comando. A configuração de um tamanho de página menor resulta em mais chamadas para o serviço, recuperando menos itens em cada chamada. Isso pode ajudar a evitar que as chamadas de serviço atinjam o tempo limite. (padrão: 1000)
      • Sinalização: --page-size SIZE
    • Opcional : O NÚMERO total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um NextToken será fornecido na saída do comando. Para retomar a paginação, forneça o valor NextToken no argumento starting-token de um comando subsequente. (padrão: 0)
      • Sinalização: --max-items NUMBER
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT
    • Opcional : O booleano não está presente em listV2 por padrão; se você quiser retornar o campo do proprietário com cada chave no resultado, defina o campo fetch owner como true.
      • Sinalização: --fetch-owner Boolean
    • Opcional : Start After (Iniciar após) é o local a partir do qual você deseja que o S3 inicie a listagem. O S3 inicia a listagem após essa chave especificada. A opção de comando StartAfter pode ser qualquer chave no depósito.
      • Sinalização: --start-after Start After
    • Depreciado : Saída retornada no formato JSON bruto.
      • Sinalização: --json

Listar partes

  • Ação: imprima informações sobre uma instância de upload de múltiplas partes em andamento.
  • Uso: ibmcloud cos parts --bucket BUCKET_NAME --key KEY --upload-id ID --part-number-marker VALUE [--page-size SIZE] [--max-items NUMBER] [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • O ID de upload que identifica o upload de múltiplas partes.
      • Sinalização: --upload-id ID
    • O VALUE de número de parte após o qual a listagem é iniciada (padrão: 1)
      • Sinalização: --part-number-marker VALUE
    • Opcional : O TAMANHO de cada página a ser obtida na chamada de serviço. Isso não afeta o número de itens retornados na saída do comando. A configuração de um tamanho de página menor resulta em mais chamadas para o serviço, recuperando menos itens em cada chamada. Isso pode ajudar a evitar que as chamadas de serviço atinjam o tempo limite. (padrão: 1000)
      • Sinalização: --page-size SIZE
    • Opcional : O NÚMERO total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um NextToken será fornecido na saída do comando. Para retomar a paginação, forneça o valor NextToken no argumento starting-token de um comando subsequente. (padrão: 0)
      • Sinalização: --max-items NUMBER
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Configurar o CORS de depósito

  • Ação: define a configuração de CORS para um depósito na conta do IBM Cloud Object Storage do usuário.

  • Uso: ibmcloud cos bucket-cors-put --bucket BUCKET_NAME [--cors-configuration STRUCTURE] [--region REGION] [--output FORMAT]

  • Parâmetros a serem fornecidos:

    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : Uma ESTRUTURA usando a sintaxe JSON em um arquivo.
      • Sinalização: --cors-configuration STRUCTURE
      • Sintaxe de JSON: --cors-configuration file://<filename.json>

        O comando --cors-configuration usa uma estrutura JSON que descreve o CORS de configuração. Neste exemplo, o prefixo file:// é usado para carregar a estrutura JSON do arquivo especificado.
    	{
    	"CORSRules": [
    	{
      	"AllowedHeaders": ["*"],
      	"AllowedMethods": ["PUT", "GET", "DELETE"],
      	"AllowedOrigins": ["http://www.example.com"],
      	"ExposeHeaders": ["ExposeHeader7","ExposeHeader8"],
      	"MaxAgeSeconds": 75
    	}
    	...
    	]
    	}
    
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Colocar objeto

  • Ação: faça upload de um objeto para um depósito na conta do IBM Cloud Object Storage de um usuário.

  • Uso: ibmcloud cos object-put --bucket BUCKET_NAME --key KEY [--body FILE_PATH] [--cache-control CACHING_DIRECTIVES] [--content-disposition DIRECTIVES] [--content-encoding CONTENT_ENCODING] [--content-language LANGUAGE] [--content-length SIZE] [--content-md5 MD5] [--content-type MIME] [--metadata MAP] [--region REGION] [--output FORMAT]

  • Parâmetros a serem fornecidos:

    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • Opcional : Localização dos dados do objeto (FILE_PATH).
      • Sinalização: --body FILE_PATH
    • Opcional : Especifica CACHING_DIRECTIVES para a cadeia de solicitação e resposta.
      • Sinalização: --cache-control CACHING_DIRECTIVES
    • Opcional : Especifica as informações de apresentação (DIRECTIVES).
      • Sinalização: --content-disposition DIRECTIVES
    • Opcional : Especifica a codificação de conteúdo (CONTENT_ENCODING) do objeto.
      • Sinalização: --content-encoding CONTENT_ENCODING
    • Opcional : O IDIOMA em que o conteúdo está.
      • Sinalização: --content-language LANGUAGE
    • Opcional : TAMANHO do corpo em bytes. Esse parâmetro é útil quando o tamanho do corpo não pode ser determinado automaticamente. (padrão: 0)
      • Sinalização: --content-length SIZE
    • Opcional : O base64-encoded MD5 digest de 128 bits dos dados.
      • Sinalização: --content-md5 MD5
    • Opcional : Um tipo MIME padrão que descreve o formato dos dados do objeto.
      • Sinalização: --content-type MIME
    • Opcional : Um MAP de metadados a serem armazenados.
      • Sinalização: --metadata MAP Sintaxe de JSON: O sinalizador --metadata usa o prefixo file:// que é usado para carregar a estrutura JSON do arquivo especificado.
    {
      "file_name": "file_20xxxxxxxxxxxx45.zip",
      "label": "texas",
      "state": "Texas",
      "Date_to": "2019-11-09T16:00:00.000Z",
      "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
      "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
    }
    
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Faça upload de objetos usando S3Manager

  • Ação: faça upload de objetos para o COS simultaneamente.

  • Uso: ibmcloud cos upload --bucket BUCKET_NAME --key KEY --file PATH [--concurrency value] [--max-upload-parts PARTS] [--part-size SIZE] [--leave-parts-on-errors] [--cache-control CACHING_DIRECTIVES] [--content-disposition DIRECTIVES] [--content-encoding CONTENT_ENCODING] [--content-language LANGUAGE] [--content-length SIZE] [--content-md5 MD5] [--content-type MIME] [--metadata MAP] [--region REGION] [--output FORMAT]

  • Parâmetros a serem fornecidos:

    • O nome (BUCKET_NAME) do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • O PATH para o arquivo para fazer upload.
      • Sinalização: --file PATH
    • Opcional : O número de rotinas go a serem executadas em paralelo por chamada ao Upload ao enviar peças. O valor padrão é 5.
      • Sinalização: --concurrency value
    • Opcional : Número máximo de PARTES que serão carregadas para S3, que calcula o tamanho da peça do objeto a ser carregado. O limite é de 10.000 partes.
      • Sinalização: --max-upload-parts PARTS
    • Opcional : O TAMANHO do buffer (em bytes) a ser usado ao armazenar dados em pedaços e finalizá-los como partes em S3. O tamanho de parte mínimo permitido é de 5 MB.
      • Sinalização: --part-size SIZE
    • Opcional : Definir esse valor como true fará com que o SDK evite chamar AbortMultipartUpload em uma falha, deixando todas as partes carregadas com sucesso em S3 para recuperação manual.
      • Sinalização: --leave-parts-on-errors
    • Opcional : Especifica CACHING_DIRECTIVES para a cadeia de solicitação/resposta.
      • Sinalização: --cache-control CACHING_DIRECTIVES
    • Opcional : Especifica informações de apresentação (DIRECTIVES).
      • Sinalização: --content-disposition DIRECTIVES
    • Opcional : Especifica quais codificações de conteúdo (CONTENT_ENCODING) foram aplicadas ao objeto e, portanto, quais mecanismos de decodificação devem ser aplicados para obter o tipo de mídia referenciado pelo campo de cabeçalho Content-Type.
      • Sinalização: --content-encoding CONTENT_ENCODING
    • Opcional : O IDIOMA em que o conteúdo está.
      • Sinalização: --content-language LANGUAGE
    • Opcional : TAMANHO do corpo em bytes. Esse parâmetro é útil quando o tamanho do corpo não pode ser determinado automaticamente.
      • Sinalização: --content-length SIZE
    • Opcional : O base64-encoded MD5 digest de 128 bits dos dados.
      • Sinalização: --content-md5 MD5
    • Opcional : Um tipo MIME padrão que descreve o formato dos dados do objeto.
      • Sinalização: --content-type MIME
    • Opcional : Um MAP de metadados a serem armazenados.
      • Sinalização: --metadata MAP Sintaxe de JSON: O sinalizador --metadata usa o prefixo file:// que é usado para carregar a estrutura JSON do arquivo especificado.
    {
      "file_name": "file_20xxxxxxxxxxxx45.zip",
      "label": "texas",
      "state": "Texas",
      "Date_to": "2019-11-09T16:00:00.000Z",
      "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
      "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
    }
    
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Controlando manualmente os uploads de múltiplas partes

A CLI do IBM Cloud Object Storage permite que os usuários façam upload de arquivos grandes em várias partes usando as funções de upload de várias partes do AWS. Para iniciar um novo upload de várias partes, execute o comando multipart-upload-create, que retorna o ID de upload da nova instância de upload. Para continuar com o processo de upload, deve-se salvar o ID de upload de cada comando subsequente. Esse comando exige que você gere um hash MD5:

{object data} | openssl dgst -md5 -binary | openssl enc -base64

Após executar o comando multipart-upload-complete, execute part-upload para cada parte do arquivo que você deseja fazer upload. Para uploads de várias partes, cada parte do arquivo (exceto a última parte) deve ter pelo menos 5 MB. Para dividir um arquivo em partes separadas, é possível executar split em uma janela do terminal. Por exemplo, se você tiver um arquivo de 13 MB denominado TESTFILE em sua Área de trabalho e desejar dividi-lo em partes de arquivo de 5 MB cada, será possível executar split -b 3m ~/Desktop/TESTFILE part-file-. Esse comando gera três partes de arquivo em duas partes de arquivo de 5 MB cada e uma parte de arquivo de 3 MB, com os nomes part-file-aa, part-file-ab e part-file-ac. As each file part is uploaded, the CLI print its ETag . You must save this ETag into a formatted JSON file, along with the part number. Use this template to create your own Arquivo de dados JSON de ETag

{
    "Parts": [
    {
      "PartNumber": 1,
      "ETag": "The ETag of the first file part goes here."
    },
    {
      "PartNumber": 2,
      "ETag": "The ETag of the second file part goes here."
    }
    ]
}

Inclua mais entradas para esse modelo JSON conforme necessário.

Para ver o status da instância de upload de várias partes, você sempre pode executar o comando part-list, fornecendo o nome do bucket, a chave e o ID do upload. Isso imprime informações brutas sobre sua instância de upload de várias partes. Depois de concluir o upload de cada parte do arquivo, execute o comando multipart-upload-complete com os parâmetros necessários. Se tudo correr bem, você receberá uma confirmação de que o arquivo foi transferido por upload com êxito para o depósito desejado.

Fazer upload de uma parte

  • Ação: faça upload de uma parte de um arquivo em uma instância de upload de múltiplas partes existente.
  • Uso: ibmcloud cos part-upload --bucket BUCKET_NAME --key KEY --upload-id ID --part-number NUMBER [--body FILE_PATH] [--region REGION] [--output FORMAT]
    • Observe que você deve salvar o número de cada parte do arquivo carregado e o endereço ETag (que a CLI imprimirá para você) de cada parte em um arquivo JSON. Consulte o "Guia de upload de múltiplas partes" abaixo para obter mais informações.
  • Parâmetros a serem fornecidos:
    • O nome do depósito no qual o upload de múltiplas partes está ocorrendo.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • O ID de upload que identifica o upload de múltiplas partes.
      • Sinalização: --upload-id ID
    • O NUMBER de parte da parte que está sendo transferida por upload. Esse é um número inteiro positivo no intervalo de 1 a 10.000. (padrão: 1)
      • Sinalização: --part-number NUMBER
    • Opcional : Localização dos dados do objeto (FILE_PATH).
      • Sinalização: --body FILE_PATH
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Fazer upload de uma cópia de parte

  • Ação: faça upload de uma parte copiando dados de um objeto existente.
  • Uso: ibmcloud cos part-upload-copy --bucket BUCKET_NAME --key KEY --upload-id ID --part-number NUMBER --copy-source SOURCE [--copy-source-if-match ETAG] [--copy-source-if-modified-since TIMESTAMP] [--copy-source-if-none-match ETAG] [--copy-source-if-unmodified-since TIMESTAMP] [--copy-source-range value] [--region REGION] [--output FORMAT]
    • Observe que você deve salvar o número de cada parte do arquivo carregado e o endereço ETag (que a CLI imprimirá para você) de cada parte em um arquivo JSON. Consulte o "Guia de upload de múltiplas partes" para obter mais informações.
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • O ID de upload que identifica o upload de múltiplas partes.
      • Sinalização: --upload-id ID
    • O NUMBER de parte da parte que está sendo transferida por upload. Esse é um número inteiro positivo entre 1 e 10.000.
      • Sinalização: --part-number PART_NUMBER
    • (SOURCE) O nome do bucket de origem e o nome da chave do objeto de origem, que são separados por uma barra (/). Deve ser URL-encoded.
      • Sinalização: --copy-source SOURCE
    • Opcional : Copia o objeto se sua tag de entidade (Etag) corresponder à tag especificada (ETAG).
      • Sinalização: --copy-source-if-match ETAG
    • Opcional : Copia o objeto se ele tiver sido modificado desde a hora especificada (TIMESTAMP).
      • Sinalização: --copy-source-if-modified-since TIMESTAMP
    • Opcional : Copia o objeto se sua tag de entidade (ETag) for diferente da tag especificada (ETAG).
      • Sinalização: --copy-source-if-none-match ETAG
    • Opcional : Copia o objeto se ele não tiver sido modificado desde o tempo especificado (TIMESTAMP).
      • Sinalização: --copy-source-if-unmodified-since TIMESTAMP
    • Opcional : O intervalo de bytes a ser copiado do objeto de origem. O valor do intervalo deve usar o formato bytes=first-last, em que o primeiro e último são os deslocamentos de bytes baseados em zero a serem copiados. Por exemplo, bytes=0-9 indica que você deseja copiar os primeiros dez bytes da origem. Será possível copiar um intervalo somente se o objeto de origem for maior que 5 MB.
      • Sinalização: --copy-source-range value
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Configuração do bloqueio de objeto

Configuração de bloqueio de objeto de colocação

Em dias e anos de retenção padrão não podem ser fornecidos ao mesmo tempo.

  • Ação: Definir a configuração de bloqueio de objeto em um bucket.
  • Uso: object-lock-configuration-put --bucket BUCKET_NAME [--object-lock-configuration STRUCTURE] [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Uma estrutura usando a sintaxe JSON. Consulte IBM Cloud.
      • Sinalização: --object-lock-configuration STRUCTURE

        	{
        	"ObjectLockEnabled": "Enabled",
        	"Rule": {
        		"DefaultRetention": {
        		"Mode": "COMPLIANCE",
        		"Days": integer,
        		"Years": integer
        		}
        	}
        	}
        
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Exemplo:

ibmcloud cos object-lock-configuration-put --bucket bucket-name --object-lock-configuration '{ "ObjectLockEnabled": "Enabled", "Rule": { "DefaultRetention": { "Mode": "COMPLIANCE", "Days": 30 }}}'

Obter configuração de bloqueio de objeto

  • Ação: Obter a configuração de bloqueio de objeto em um bucket.
  • Uso: object-lock-configuration-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Uma estrutura usando a sintaxe JSON. Consulte IBM Cloud.
      • Sinalização: --object-lock-configuration STRUCTURE

        	{
        	"ObjectLockEnabled": "Enabled",
        	"Rule": {
        		"DefaultRetention": {
        		"Mode": "COMPLIANCE",
        		"Days": integer,
        		"Years": integer
        		}
        	}
        	}
        
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

        	{
        	"ObjectLockEnabled": "Enabled",
        	"Rule": {
        		"DefaultRetention": {
        		"Mode": "COMPLIANCE",
        		"Days": integer,
        		"Years": integer
        		}
        	}
        	}
        

Exemplo:

ibmcloud cos object-lock-configuration-get --bucket bucket-name --region us-south

Retenção de objeto.

Retenção de objeto put

  • Ação: Definir a retenção em um objeto.
  • Uso: object-retention-put --bucket BUCKET_NAME --key KEY [--retention STRUCTURE] [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • Uma estrutura usando a sintaxe JSON. Consulte IBM Cloud.
      • Sinalização: --retention STRUCTURE

        	{
        	  "Mode": "COMPLIANCE",
        	  "RetainUntilDate": timestamp
        	}
        
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Exemplo:

ibmcloud cos object-retention-put --bucket bucket-name --key file-name.txt --retention '{ "Mode": "COMPLIANCE", "RetainUntilDate": "2024-02-02T00:00:00"}’

Obter retenção de objeto

  • Ação: Obter retenção em um objeto.
  • Uso: object-retention-get --bucket BUCKET_NAME --key KEY [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

        	{
        		"Retention": {
        			"Mode": "COMPLIANCE",
        			"RetainUntilDate": "2024-02-02T00:00:00.000Z"
        		}
        	}
        

Exemplo:

ibmcloud cos object-retention-put --bucket bucket-name --key file-name.txt --region us-south

Configurar replicação de depósito

Configuração para configurar um depósito replicado.

Replicação de depósito de colocação.

  • Ação: Definir a configuração de replicação em um bucket.
  • Uso: bucket-replication-put --bucket BUCKET_NAME --replication-configuration STRUCTURE [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT
    • Uma estrutura usando a sintaxe JSON.
      • Sinalização: --replication-configuration STRUCTURE

        	{
        		"Rules": [
        			{
        				"Status": "Enabled",
        				"Priority": 1,
        				"Filter" : { "Prefix": ""},
        				"DeleteMarkerReplication": {
        					"Status": "Disabled"
        				},
        				"Destination": {
        					"Bucket": "DEST-BUCKET-NAME"
        				}
        			}
        		]
        	}
        

Exemplo:

ibmcloud cos bucket-replication-put --bucket SOURCE-BUCKET-NAME --replication-configuration file://replication.json

Obter replicação de depósito

  • Ação: Obter a configuração de replicação de um bucket.
  • Uso: bucket-replication-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

        	{
        		"ReplicationConfiguration": {
        			"Rules": [
        				{
        					"Status": "Enabled",
        					"Prefix": "",
        					"Destination": {
        						"Bucket": "DEST-BUCKET-NAME",
        						"StorageClass": "STANDARD"
        					},
        				}
        			],
        		}
        	}
        

Exemplo:

 ibmcloud cos bucket-replication-get --bucket SOURCE-BUCKET-NAME

Excluir replicação de depósito

  • Ação: Excluir a configuração de replicação de um bucket.
  • Uso: bucket-replication-delete --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : A REGIÃO em que o bucket está presente. Se essa sinalização não for fornecida, o programa usará a opção padrão que é especificada na configuração.
      • Sinalização: --region REGION
    • Opcional : O FORMATO de saída pode ser apenas json ou texto.
      • Sinalização: --output FORMAT

Exemplo:

 ibmcloud cos bucket-replication-delete --bucket SOURCE-BUCKET-NAME

Próximas etapas

Como cada procedimento sempre vai exatamente como planejado, você pode não ter visto qualquer um dos códigos de cabeçalho e de erro comuns Para obter mais referência, verifique a Referência da API