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

Após a instalação do plug-in, você pode configurá-lo usando o ibmcloud cos config comando. Isso pode ser usado para preencher o plug-in com suas credenciais, o local padrão de download, a escolha do método 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 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 IAM, será necessário configurar seu cliente com um ID de instância para utilizar 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, substituindo <INSTANCE_NAME> pelo alias exclusivo que você atribuiu à sua instância de serviço. Nos exemplos a seguir, 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 traz uma explicação sobre o que ela faz, como usá-la e quaisquer 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 é compatível com o conjunto completo de recursos disponíveis em Object Storage. Object Storage s imutáveis, a criação de buckets do Key Protect ou firewalls de bucket não podem ser utilizados 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á localizado. 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

Transferência em alta velocidade do Aspera

A variável de ambiente IBMCLOUD_API_KEY deve ser definida antes de usar os comandos de transferência de alta velocidade do Aspera. O “ Aspera SDK ” é baixado automaticamente na primeira vez em que o aplicativo é usado.

Baixe objetos usando Aspera

  • Ação: Baixar um objeto de um bucket usando uma transferênci Aspera e de alta velocidade.
  • Uso: ibmcloud cos aspera-download --bucket BUCKET_NAME --key KEY [--region REGION] [--output FORMAT] [OUTFILE]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A CHAVE do objeto a ser baixado.
      • Sinalização: --key KEY
    • Opcional : a REGIÃO em que o bucket está localizado. 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 : Caminho local onde o arquivo baixado é salvo. Se não for especificado, o arquivo é salvo no local padrão de download com o nome de arquivo da chave do objeto.
      • Argumento: OUTFILE

Exemplo:

export IBMCLOUD_API_KEY=<your-api-key>
ibmcloud cos aspera-download --bucket my-bucket --key videos/demo.mp4 /tmp/demo.mp4

Envie arquivos ou diretórios usando Aspera

  • Ação: Fazer upload de um arquivo ou diretório para um bucket usando a transferência de alta velocidade d Aspera.
  • Uso: ibmcloud cos aspera-upload --bucket BUCKET_NAME --key KEY [--region REGION] [--output FORMAT] [SRCFILE]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A CHAVE (nome do objeto de destino) no bucket.
      • Sinalização: --key KEY
    • Opcional : a REGIÃO em que o bucket está localizado. 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 : Caminho local do arquivo ou diretório a ser enviado.
      • Argumento: SRCFILE

Exemplo:

export IBMCLOUD_API_KEY=<your-api-key>
ibmcloud cos aspera-upload --bucket my-bucket --key videos/demo.mp4 /tmp/demo.mp4

Configuração do ciclo de vida do bucket

Configuração para definir uma política de ciclo de vida em um bucket.

As regras de ciclo de vida que utilizam NoncurrentVersionExpiration ou Expiration.ExpiredObjectDeleteMarker só entram em vigor quando o controle de versões estiver ativado no bucket. Ative primeiro o controle de versão com o comando bucket-versioning-put antes de aplicar essas regras.

Definir a configuração do ciclo de vida em um bucket

  • Ação: Definir a configuração do ciclo de vida de um bucket.
  • Uso: ibmcloud cos bucket-lifecycle-configuration-put --bucket BUCKET_NAME --lifecycle-configuration STRUCTURE [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.

      • Sinalização: --bucket BUCKET_NAME
    • Uma ESTRUTURA que utiliza a sintaxe JSON. O prefixo file:// pode ser usado para carregar a estrutura JSON a partir de um arquivo, como --lifecycle-configuration file://<filename.json>.

      • Sinalização: --lifecycle-configuration STRUCTURE

        	{
        	  "Rules": [
        	    {
        	      "ID": "string",
        	      "Status": "Enabled"|"Disabled",
        	      "Filter": {
        	        "Prefix": "string"
        	      },
        	      "Expiration": {
        	        "Days": integer,
        	        "Date": "YYYY-MM-DDTHH:mm:ssZ",
        	        "ExpiredObjectDeleteMarker": true|false
        	      },
        	      "Transitions": [
        	        {
        	          "Days": integer,
        	          "Date": "YYYY-MM-DDTHH:mm:ssZ",
        	          "StorageClass": "string"
        	        }
        	      ],
        	      "NoncurrentVersionExpiration": {
        	        "NoncurrentDays": integer
        	      },
        	      "AbortIncompleteMultipartUpload": {
        	        "DaysAfterInitiation": integer
        	      }
        	    }
        	  ]
        	}
        
    • Opcional : a REGIÃO em que o bucket está localizado. 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 — usando um arquivo:

ibmcloud cos bucket-lifecycle-configuration-put --bucket my-bucket --lifecycle-configuration file://lifecycle.json

Exemplo — no texto:

ibmcloud cos bucket-lifecycle-configuration-put \
  --bucket my-bucket \
  --lifecycle-configuration '{
    "Rules": [
      {
        "ID": "expire-noncurrent-versions",
        "Status": "Enabled",
        "Filter": { "Prefix": "" },
        "NoncurrentVersionExpiration": {
          "NoncurrentDays": 30
        }
      },
      {
        "ID": "clean-delete-markers",
        "Status": "Enabled",
        "Filter": { "Prefix": "" },
        "Expiration": {
          "ExpiredObjectDeleteMarker": true
        }
      }
    ]
  }' \
  --region us-south

Obter a configuração do ciclo de vida de um bucket

  • Ação: Obter a configuração do ciclo de vida de um bucket.
  • Uso: ibmcloud cos bucket-lifecycle-configuration-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á localizado. 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-lifecycle-configuration-get --bucket my-bucket

Excluir a configuração do ciclo de vida de um bucket

  • Ação: Excluir a configuração do ciclo de vida de um bucket.
  • Uso: ibmcloud cos bucket-lifecycle-configuration-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á localizado. 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-lifecycle-configuration-delete --bucket my-bucket

Replicação de depósito

A replicação de buckets copia continuamente objetos de um bucket de origem para um bucket de destino na mesma região ou em uma região diferente. A replicação exige que o controle de versões esteja habilitado no bucket de origem antes que a configuração da replicação possa ser definida.

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

  • Ação: Definir a configuração de replicação em um bucket.
  • Uso: ibmcloud cos 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á localizado. 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 que utiliza a sintaxe JSON.
      • Sinalização: --replication-configuration STRUCTURE

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

Exemplo — usando um arquivo:

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

Exemplo — no texto:

ibmcloud cos bucket-replication-put --bucket SOURCE-BUCKET-NAME \
  --replication-configuration '{
    "Rules": [
      {
        "Status": "Enabled",
        "Priority": 1,
        "Filter": {},
        "DeleteMarkerReplication": { "Status": "Disabled" },
        "Destination": { "Bucket": "DEST-BUCKET-CRN" }
      }
    ]
  }' \
  --region us-south

Obter replicação de depósito

  • Ação: Obter a configuração de replicação de um bucket.
  • Uso: ibmcloud cos 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á localizado. 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-get --bucket SOURCE-BUCKET-NAME

Excluir replicação de depósito

  • Ação: Excluir a configuração de replicação de um bucket.
  • Uso: ibmcloud cos 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á localizado. 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

Listar falhas de replicação de um bucket

  • Ação: Listar as falhas de replicação de um bucket.
  • Uso: ibmcloud cos bucket-replication-failures --bucket BUCKET_NAME [--starting-token TOKEN] [--encoding-type METHOD] [--first-sync-attempted-before TIMESTAMP] [--max-keys NUMBER] [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : um TOKEN usado para especificar onde iniciar a próxima página de resultados.
      • Sinalização: --starting-token TOKEN
    • Opcional : Solicita a codificação das chaves do objeto na resposta e especifica o MÉTODO de codificação a ser utilizado.
      • Sinalização: --encoding-type METHOD
    • Opcional : Filtra os resultados para incluir apenas as falhas em que a primeira sincronização foi tentada antes do TIMESTAMP especificado (formato ISO 8601).
      • Sinalização: --first-sync-attempted-before TIMESTAMP
    • Opcional : o NÚMERO máximo de chaves a serem retornadas.
      • Sinalização: --max-keys NUMBER
    • Opcional : a REGIÃO em que o bucket está localizado. 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-failures --bucket my-bucket

Tentar novamente a replicação dos objetos com falha em um bucket

  • Ação: Tentar novamente a replicação dos objetos com falha em um bucket.
  • Uso: ibmcloud cos bucket-replication-reattempt --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á localizado. 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-reattempt --bucket my-bucket

Controle de versão de buckets

Configuração para ativar ou suspender o controle de versões em um bucket.

Definir a configuração de versionamento em um depósito

  • Ação: Definir a configuração de controle de versões em um bucket.
  • Uso: ibmcloud cos bucket-versioning-put --bucket BUCKET_NAME --versioning-configuration STRUCTURE [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.

      • Sinalização: --bucket BUCKET_NAME
    • Uma ESTRUTURA que utiliza a sintaxe JSON para especificar o estado de controle de versão. Os valores válidos para Status são Enabled e Suspended``.

      • Sinalização: --versioning-configuration STRUCTURE

        	{
        	  "Status": "Enabled"|"Suspended"
        	}
        
    • Opcional : a REGIÃO em que o bucket está localizado. 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-versioning-put --bucket my-bucket --versioning-configuration '{"Status": "Enabled"}'

Obter a configuração de versionamento para um depósito

  • Ação: Obter a configuração de controle de versões de um bucket.
  • Uso: ibmcloud cos bucket-versioning-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á localizado. 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-versioning-get --bucket my-bucket

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
    • Uma ESTRUTURA que utiliza a sintaxe JSON. O prefixo file:// pode ser usado para carregar a estrutura JSON a partir de um arquivo, como --multipart-upload file://<filename.json>.

      • Sinalização: --multipart-upload STRUCTURE

        	{
        		"Parts": [
        			{
        				"ETag": "string",
        				"PartNumber": integer
        			}
        		]
        	}
        
    • Opcional : a REGIÃO em que o bucket está localizado. 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

        	{
        		"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á localizado. 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
        • --list exibe o Terminal em serviço padrão atual, se ele tiver sido configurado Caso contrário, ficará 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.

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
    • (FONTE) O nome do bucket de origem e o nome da chave do objeto de origem, separados por uma barra (/). Deve estar codificado em formato “ URL ”.
      • Sinalização: --copy-source SOURCE
    • Opcional : Especifica “ CACHING_DIRECTIVES ” para a cadeia de solicitações e respostas.
      • 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) 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á redigido.
      • 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 caso ele tenha sido modificado desde o momento especificado (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 caso ele não tenha sido modificado desde o horário especificado (TIMESTAMP).
      • Sinalização: --copy-source-if-unmodified-since TIMESTAMP
    • Opcional : um MAP com os metadados a serem armazenados. O prefixo file:// pode ser usado para carregar a estrutura JSON a partir de um arquivo.
      • Sinalização: --metadata MAP
    • Opcional : Especifica se os metadados são copiados do objeto de origem ou substituídos pelos metadados fornecidos na solicitação. Valores de DIRECTIVE: COPY,REPLACE.
      • Sinalização: --metadata-directive DIRECTIVE
    • Opcional : a REGIÃO em que o bucket está localizado. 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 de estrutura JSON de metadados para --metadata MAP:

{
	"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"
}

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 o ID da instância do serviço IBM na solicitação.
      • Sinalização: --ibm-service-instance-id ID
    • Opcional : a REGIÃO em que o bucket está localizado. 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 o endereço Key Protect em uma instância do IBM Cloud Object Storage.
  • Uso: ibmcloud cos 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 por meio do recurso de proteção de chave.
      • Sinalização: --kms-encryption-algorithm ALGORITHM
    • Opcional : O nome da classe.
      • Sinalização: --class CLASS_NAME
    • Opcional : Define o ID da instância do serviço IBM na solicitação.
      • Sinalização: --ibm-service-instance-id ID
    • Opcional : a REGIÃO em que o bucket está localizado. 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
    • (Obsoleto): 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: ibmcloud cos 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 por meio do recurso de proteção de chave.
      • Sinalização: --kms-encryption-algorithm ALGORITHM
    • Opcional : O nome da classe.
      • Sinalização: --class CLASS_NAME
    • Opcional : Define o ID da instância do serviço IBM na solicitação.
      • Sinalização: --ibm-service-instance-id ID
    • Opcional : a REGIÃO em que o bucket está localizado. 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
    • (Obsoleto): 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ções e respostas.

      • Sinalização: --cache-control CACHING_DIRECTIVES
    • Opcional : Especifica informações de apresentação (DIRECTIVES).

      • Sinalização: --content-disposition DIRECTIVES
    • Opcional : Especifica a codificação do conteúdo (CONTENT_ENCODING) do objeto.

      • Sinalização: --content-encoding CONTENT_ENCODING
    • Opcional : O IDIOMA em que o conteúdo está redigido.

      • 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 com os metadados a serem armazenados. O prefixo file:// pode ser usado para carregar a estrutura JSON a partir de um arquivo.

      • Sinalização: --metadata MAP

        	{
        		"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á localizado. 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á localizado. 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á localizado. 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 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á localizado. 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á localizado. 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 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 ESTRUTURA que utiliza a sintaxe JSON. O prefixo file:// pode ser usado para carregar a estrutura JSON a partir de um arquivo, como --delete file://<filename.json>.

      • Sinalização: --delete STRUCTURE

        	{
        		"Objects": [
        			{
        				"Key": "string",
        				"VersionId": "string"
        			}
        		],
        		"Quiet": true|false
        	}
        
    • Opcional : a REGIÃO em que o bucket está localizado. 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 : retorne o objeto somente se sua tag de entidade (ETag) for igual à especificada em ETAG ; caso contrário, retorne um 412 (falha na pré-condição).
      • Sinalização: --if-match ETAG
    • Opcional : Retorne o objeto somente se ele tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorne um 304 (não modificado).
      • Sinalização: --if-modified-since TIMESTAMP
    • Opcional : Retorne o objeto somente se sua tag de entidade (ETag) for diferente do ETAG especificado; caso contrário, retorne um 304 (não modificado).
      • Sinalização: --if-none-match ETAG
    • Opcional : Retorne o objeto somente se ele não tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorne um 412 (falha na pré-condição).
      • Sinalização: --if-unmodified-since TIMESTAMP
    • Opcional : Baixa os bytes especificados no INTERVALO de um objeto.
      • Sinalização: --range RANGE
    • Opcional : Define o cabeçalho Cache-Control da resposta.
      • Sinalização: --response-cache-control HEADER
    • Opcional : Define o cabeçalho Content-Disposition da resposta.
      • Sinalização: --response-content-disposition HEADER
    • Opcional : Define o cabeçalho Content-Encoding da resposta.
      • Sinalização: --response-content-encoding HEADER
    • Opcional : Define o cabeçalho Content-Language da resposta.
      • Sinalização: --response-content-language HEADER
    • Opcional : Define o cabeçalho Content-Type da resposta.
      • Sinalização: --response-content-type HEADER
    • Opcional : Define o cabeçalho “Expires” da resposta.
      • Sinalização: --response-expires HEADER
    • Opcional : a REGIÃO em que o bucket está localizado. 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

Baixe 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 iniciadas em paralelo por cada chamada de download ao enviar partes. O valor padrão é 5.
      • Sinalização: --concurrency value
    • Opcional : O tamanho do buffer (em bytes) a ser usado ao armazenar dados em blocos e enviá-los como partes para S3. O tamanho de parte mínimo permitido é de 5 MB.
      • Sinalização: --part-size SIZE
    • Opcional : retorne o objeto somente se sua tag de entidade (ETag) for igual à especificada em ETAG ; caso contrário, retorne um 412 (falha na pré-condição).
      • Sinalização: --if-match ETAG
    • Opcional : Retorne o objeto somente se ele tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorne um 304 (não modificado).
      • Sinalização: --if-modified-since TIMESTAMP
    • Opcional : Retorne o objeto somente se sua tag de entidade (ETag) for diferente do ETAG especificado; caso contrário, retorne um 304 (não modificado).
      • Sinalização: --if-none-match ETAG
    • Opcional : Retorne o objeto somente se ele não tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorne um 412 (falha na pré-condição).
      • Sinalização: --if-unmodified-since TIMESTAMP
    • Opcional : Baixa os bytes especificados no INTERVALO de um objeto. Para obter mais informações sobre o cabeçalho de intervalo “ HTTP ”, consulte a especificação do cabeçalho de intervalo “ HTTP ”.
      • Sinalização: --range RANGE
    • Opcional : Define o cabeçalho Cache-Control da resposta.
      • Sinalização: --response-cache-control HEADER
    • Opcional : Define o cabeçalho Content-Disposition da resposta.
      • Sinalização: --response-content-disposition HEADER
    • Opcional : Define o cabeçalho Content-Encoding da resposta.
      • Sinalização: --response-content-encoding HEADER
    • Opcional : Define o cabeçalho Content-Language da resposta.
      • Sinalização: --response-content-language HEADER
    • Opcional : Define o cabeçalho Content-Type da resposta.
      • Sinalização: --response-content-type HEADER
    • Opcional : Define o cabeçalho “Expires” da resposta.
      • Sinalização: --response-expires HEADER
    • Opcional : a REGIÃO em que o bucket está localizado. 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

Terminais

  • Ação: Listar as URLs dos endpoints do serviço “ S3 ” para uma região.
  • Uso: ibmcloud cos endpoints [--region REGION] [--list-regions] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • Opcional : Exibir o endpoint URL para a REGION especificada.
      • Sinalização: --region REGION
    • Opcional : Exibir a lista de todas as regiões disponíveis em vez das URLs dos endpoints.
      • Sinalização: --list-regions
    • Opcional : O FORMATO de saída pode ser apenas JSON ou texto.
      • Sinalização: --output FORMAT

Exemplo — exibir pontos finais de uma região:

ibmcloud cos endpoints --region us-south

Exemplo — listar todas as regiões disponíveis:

ibmcloud cos endpoints --list-regions

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 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á localizado. 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 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á localizado. 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 : retorne o objeto somente se sua tag de entidade (ETag) for igual à especificada em ETAG ; caso contrário, retorne um 412 (falha na pré-condição).
      • Sinalização: --if-match ETAG
    • Opcional : Retorne o objeto somente se ele tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorne um 304 (não modificado).
      • Sinalização: --if-modified-since TIMESTAMP
    • Opcional : Retorne o objeto somente se sua tag de entidade (ETag) for diferente do ETAG especificado; caso contrário, retorne um 304 (não modificado).
      • Sinalização: --if-none-match ETAG
    • Opcional : Retorne o objeto somente se ele não tiver sido modificado desde o TIMESTAMP especificado; caso contrário, retorne um 412 (falha na pré-condição).
      • Sinalização: --if-unmodified-since TIMESTAMP
    • Opcional : Baixa os bytes especificados no INTERVALO de um objeto.
      • Sinalização: --range RANGE
    • Opcional : a REGIÃO em que o bucket está localizado. 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 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á localizado. 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 o ID da instância do 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 o ID da instância do serviço IBM na solicitação.
      • Sinalização: --ibm-service-instance-id
    • Opcional : Especifica a CHAVE a partir da qual se deve começar ao listar objetos em um bucket.
      • Sinalização: --marker KEY
    • Opcional : Limita a resposta às chaves que começam com o PREFIX especificado.
      • Sinalização: --prefix PREFIX
    • Opcional : o TAMANHO de cada página a ser recebida 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 exibidos 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 usado 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 utilizado.
      • Sinalização: --encoding-type METHOD
    • Opcional : Limita a resposta às chaves que começam com o PREFIX especificado.
      • Sinalização: --prefix PREFIX
    • Opcional : Juntamente com o parâmetro upload-id-marker, este parâmetro especifica a parte do upload multipart a partir da qual a listagem deve começar.
      • Sinalização: --key-marker value
    • Opcional : Juntamente com o marcador “key”, especifica a parte do upload multiparte a partir da 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 recebida 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 exibidos 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á localizado. 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 versões de objetos

  • Ação: Listar todas as versões de objetos em um bucket específico.
  • Uso: ibmcloud cos object-versions --bucket BUCKET_NAME [--delimiter DELIMITER] [--encoding-type METHOD] [--key-marker KEY] [--max-items NUMBER] [--prefix PREFIX] [--version-id-marker VERSION_ID] [--page-size SIZE] [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : Um DELIMITADOR é um caractere usado 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 utilizado.
      • Sinalização: --encoding-type METHOD
    • Opcional : Especifica a CHAVE a partir da qual as versões devem ser listadas. As versões dos objetos são listadas em ordem alfabética, começando logo após a chave especificada.
      • Sinalização: --key-marker KEY
    • Opcional : o NÚMERO total de itens a serem exibidos na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, será exibida uma mensagem de erro ( NextKeyMarker ) na saída. Para retomar a paginação, forneça o valor “ NextKeyMarker ” no argumento “ --key-marker ” de um comando subsequente. (padrão: 0)
      • Sinalização: --max-items NUMBER
    • Opcional : Limita a resposta às chaves que começam com o PREFIX especificado.
      • Sinalização: --prefix PREFIX
    • Opcional : Especifica o ID da versão a partir da qual se deve iniciar a listagem das versões do objeto. Usado em conjunto com --key-marker para paginação.
      • Sinalização: --version-id-marker VERSION_ID
    • Opcional : o TAMANHO de cada página a ser recebida na chamada de serviço. Isso não afeta o número de itens retornados na saída do comando. Definir um tamanho de página menor resulta em mais chamadas ao serviço. (padrão: 1000)
      • Sinalização: --page-size SIZE
    • Opcional : a REGIÃO em que o bucket está localizado. 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-versions --bucket my-bucket --prefix logs/

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 usado 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 utilizado.
      • Sinalização: --encoding-type METHOD
    • Opcional : Limita a resposta às chaves que começam com o PREFIX especificado.
      • Sinalização: --prefix PREFIX
    • Opcional : um TOKEN para especificar onde iniciar 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 recebida 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 exibidos 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á localizado. 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 bucket específico.
  • Uso: ibmcloud cos 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 usado 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 utilizado.
      • Sinalização: --encoding-type METHOD
    • Opcional : Limita a resposta às chaves que começam com o PREFIX especificado.
      • Sinalização: --prefix PREFIX
    • Opcional : um TOKEN para especificar onde iniciar 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 recebida 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 exibidos 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á localizado. 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 parâmetro booleano não está presente em listV2 por padrão; se você quiser que o campo “owner” seja retornado com cada chave no resultado, defina o parâmetro “fetch owner field” como “true”.
      • Sinalização: --fetch-owner Boolean
    • Opcional : “Iniciar a partir de” é o ponto a partir do qual você deseja que o “ S3 ” comece a listar. 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
    • Obsoleto : A saída foi 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 recebida 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 exibidos 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á localizado. 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

Controlando manualmente os uploads de múltiplas partes

A CLI do IBM Cloud Object Storage permite que os usuários enviem arquivos grandes em várias partes, utilizando as funções de envio multiparte do AWS. Para iniciar um novo upload em várias partes, execute o comando multipart-upload-create , que retorna o ID do upload da nova instância. 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 em várias partes, cada parte do arquivo (exceto a última) 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.

À medida que cada parte do arquivo é enviada, a CLI exibe o código de status “ ETag ”. Você deve salvar este ETag em um arquivo JSON formatado, juntamente com o número da peça. Use este modelo para criar seu próprio 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 verificar o status da sua instância de upload em várias partes, você pode a qualquer momento executar o comando part-list , informando o nome do bucket, a chave e o ID do upload. Isso exibe informações brutas sobre sua instância de upload multiparte. 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 enviado e o endereço ETag (que a CLI exibirá para você) para 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. Este é 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á localizado. 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 enviado e o endereço ETag (que a CLI exibirá para você) para 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
    • (FONTE) O nome do bucket de origem e o nome da chave do objeto de origem, separados por uma barra (/). Deve estar codificado em formato “ URL ”.
      • 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 caso ele tenha sido modificado desde o momento especificado (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 caso ele não tenha sido modificado desde o horário 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á localizado. 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 objetos em um bucket.
  • Uso: ibmcloud cos 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 que utiliza 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á localizado. 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 do bloqueio de objetos em um bucket.
  • Uso: ibmcloud cos 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
    • Opcional : a REGIÃO em que o bucket está localizado. 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-get --bucket bucket-name --region us-south

Resposta de exemplo:

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

Retenção de objeto.

Retenção de objeto put

  • Ação: Definir a retenção de um objeto.
  • Uso: ibmcloud cos 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 que utiliza a sintaxe JSON. Consulte IBM Cloud.
      • Sinalização: --retention STRUCTURE

        	{
        	  "Mode": "COMPLIANCE",
        	  "RetainUntilDate": timestamp
        	}
        
    • Opcional : a REGIÃO em que o bucket está localizado. 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 a retenção de um objeto.
  • Uso: ibmcloud cos 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á localizado. 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-get --bucket bucket-name --key file-name.txt --region us-south

Resposta de exemplo:

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

Marcação de objetos

Configuração para gerenciar tags em objetos.

Configurar tags em um objeto

  • Ação: Atribuir tags a um objeto.
  • Uso: ibmcloud cos object-tagging-put --bucket BUCKET_NAME --key KEY --tagging STRUCTURE [--version-id VERSION_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
    • Uma ESTRUTURA que utiliza a sintaxe JSON e contém o conjunto de tags. O prefixo file:// pode ser usado para carregar a estrutura JSON a partir de um arquivo, como --tagging file://<filename.json>.

      • Sinalização: --tagging STRUCTURE

        	{
        	  "TagSet": [
        	    {
        	      "Key": "string",
        	      "Value": "string"
        	    }
        	  ]
        	}
        
    • Opcional : O VERSION_ID do objeto a ser marcado. Se não for especificado, a versão atual é marcada.

      • Sinalização: --version-id VERSION_ID
    • Opcional : a REGIÃO em que o bucket está localizado. 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-tagging-put --bucket my-bucket --key my-object.txt --tagging '{"TagSet": [{"Key": "env", "Value": "production"}]}'

Obter tags para um objeto

  • Ação: Obter tags de um objeto.
  • Uso: ibmcloud cos object-tagging-get --bucket BUCKET_NAME --key KEY [--version-id VERSION_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
    • Opcional : O VERSION_ID da versão específica do objeto para a qual se deseja recuperar as tags.
      • Sinalização: --version-id VERSION_ID
    • Opcional : a REGIÃO em que o bucket está localizado. 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-tagging-get --bucket my-bucket --key my-object.txt

Remover tags de um objeto

  • Ação: Remover tags de um objeto.
  • Uso: ibmcloud cos object-tagging-delete --bucket BUCKET_NAME --key KEY [--version-id VERSION_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
    • Opcional : O VERSION_ID da versão específica do objeto da qual se deseja remover as tags.
      • Sinalização: --version-id VERSION_ID
    • Opcional : a REGIÃO em que o bucket está localizado. 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-tagging-delete --bucket my-bucket --key my-object.txt

Configuração do bloco de acesso público

Configuração para gerenciar o bloqueio de acesso público em um bucket.

Definir configuração de bloco de acesso público em um depósito

  • Ação: Definir a configuração de bloqueio de acesso público em um bucket.
  • Uso: ibmcloud cos public-access-block-put --bucket BUCKET_NAME --public-access-block-configuration STRUCTURE [--region REGION] [--output FORMAT]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.

      • Sinalização: --bucket BUCKET_NAME
    • Uma ESTRUTURA que utiliza a sintaxe JSON. O prefixo file:// pode ser usado para carregar a estrutura JSON a partir de um arquivo, como --public-access-block-configuration file://<filename.json>.

      • Sinalização: --public-access-block-configuration STRUCTURE

        	{
        	  "BlockPublicAcls": true|false,
        	  "IgnorePublicAcls": true|false,
        	  "BlockPublicPolicy": true|false,
        	  "RestrictPublicBuckets": true|false
        	}
        
    • Opcional : a REGIÃO em que o bucket está localizado. 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 public-access-block-put --bucket my-bucket --public-access-block-configuration '{"BlockPublicAcls": true, "IgnorePublicAcls": true, "BlockPublicPolicy": true, "RestrictPublicBuckets": true}'

Obter a configuração do bloco de acesso público em um depósito

  • Ação: Obter a configuração do bloco de acesso público em um bucket.
  • Uso: ibmcloud cos public-access-block-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á localizado. 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 public-access-block-get --bucket my-bucket

Remover configuração de bloco de acesso público de um depósito

  • Ação: Remover a configuração de bloqueio de acesso público de um bucket.
  • Uso: ibmcloud cos public-access-block-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á localizado. 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 public-access-block-delete --bucket my-bucket

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ções e respostas.

      • Sinalização: --cache-control CACHING_DIRECTIVES
    • Opcional : Especifica informações de apresentação (DIRECTIVES).

      • Sinalização: --content-disposition DIRECTIVES
    • Opcional : Especifica a codificação do conteúdo (CONTENT_ENCODING) do objeto.

      • Sinalização: --content-encoding CONTENT_ENCODING
    • Opcional : O IDIOMA em que o conteúdo está redigido.

      • 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 resumo dos dados gerado pelo algoritmo “ base64-encoded ” de 128 bits MD5.

      • 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 com os metadados a serem armazenados. O prefixo file:// pode ser usado para carregar a estrutura JSON a partir de um arquivo.

      • Sinalização: --metadata MAP

        	{
        		"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á localizado. 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

Carregue 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 iniciadas em paralelo por cada chamada à função Upload ao enviar partes. O valor padrão é 5.

      • Sinalização: --concurrency value
    • Opcional : Número máximo de PEÇAS que serão enviadas para S3, que calcula o tamanho das peças do objeto a ser enviado. 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 blocos e enviá-los como partes para 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 caso de falha, mantendo todas as partes enviadas com sucesso em S3 para recuperação manual.

      • Sinalização: --leave-parts-on-errors
    • Opcional : Especifica as CACHING_DIRECTIVES para a cadeia de solicitações/respostas.

      • Sinalização: --cache-control CACHING_DIRECTIVES
    • Opcional : Especifica informações de apresentação (DIRETIVAS).

      • 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á redigido.

      • 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 resumo dos dados gerado pelo algoritmo “ base64-encoded ” de 128 bits MD5.

      • 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 com os metadados a serem armazenados. O prefixo file:// pode ser usado para carregar a estrutura JSON a partir de um arquivo.

      • Sinalização: --metadata MAP

        	{
        		"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á localizado. 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 STRUCTURE utilizando a sintaxe JSON. O prefixo file:// pode ser usado para carregar a estrutura JSON a partir de um arquivo, como --cors-configuration file://<filename.json>.

      • Sinalização: --cors-configuration STRUCTURE

        	{
        		"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á localizado. 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

Versão

  • Ação: Imprimir a versão do plug-in da CLI do IBM Cloud Object Storage.
  • Uso: ibmcloud cos version
  • Parâmetros a serem fornecidos: Nenhum.

Exemplo:

ibmcloud cos version

Espera

  • Ação: Consultar uma API até que uma determinada condição seja satisfeita. Cada subcomando realiza uma verificação a cada 5 segundos e encerra a execução com o código de retorno 255 após 20 verificações malsucedidas.
  • Uso: ibmcloud cos wait SUBCOMMAND

Estão disponíveis os seguintes subcomandos:

bucket-exists

  • Ação: Aguarde até receber uma resposta 200 ao fazer a consulta em head-bucket.
  • Uso: ibmcloud cos wait bucket-exists --bucket BUCKET_NAME [--region REGION]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : a REGIÃO em que o bucket está localizado.
      • Sinalização: --region REGION

Exemplo:

ibmcloud cos wait bucket-exists --bucket my-bucket

bucket-não-existe

  • Ação: Aguardar até que seja recebida uma resposta 404 ao fazer a consulta em head-bucket.
  • Uso: ibmcloud cos wait bucket-not-exists --bucket BUCKET_NAME [--region REGION]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • Opcional : a REGIÃO em que o bucket está localizado.
      • Sinalização: --region REGION

Exemplo:

ibmcloud cos wait bucket-not-exists --bucket my-bucket

objeto-existe

  • Ação: Aguarde até receber uma resposta 200 ao fazer a consulta em head-object.
  • Uso: ibmcloud cos wait object-exists --bucket BUCKET_NAME --key KEY [--if-match ETAG] [--if-modified-since TIMESTAMP] [--if-none-match ETAG] [--if-unmodified-since TIMESTAMP] [--range RANGE] [--part-number NUMBER] [--region REGION]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • Opcional : Retorne o objeto somente se sua tag de entidade (ETag) corresponder ao ETAG fornecido.
      • Sinalização: --if-match ETAG
    • Opcional : Retorne o objeto somente se ele tiver sido modificado desde o TIMESTAMP especificado.
      • Sinalização: --if-modified-since TIMESTAMP
    • Opcional : Retorne o objeto somente se seu ETag não corresponder ao ETAG fornecido.
      • Sinalização: --if-none-match ETAG
    • Opcional : Retorne o objeto somente se ele não tiver sido modificado desde o TIMESTAMP especificado.
      • Sinalização: --if-unmodified-since TIMESTAMP
    • Opcional : Baixa o INTERVALO de bytes especificado de um objeto.
      • Sinalização: --range RANGE
    • Opcional : NÚMERO da peça do objeto que está sendo lido.
      • Sinalização: --part-number NUMBER
    • Opcional : a REGIÃO em que o bucket está localizado.
      • Sinalização: --region REGION

Exemplo:

ibmcloud cos wait object-exists --bucket my-bucket --key my-object.txt

objeto-não-existe

  • Ação: Aguardar até que seja recebida uma resposta 404 ao fazer a consulta em head-object.
  • Uso: ibmcloud cos wait object-not-exists --bucket BUCKET_NAME --key KEY [--if-match ETAG] [--if-modified-since TIMESTAMP] [--if-none-match ETAG] [--if-unmodified-since TIMESTAMP] [--range RANGE] [--part-number NUMBER] [--region REGION]
  • Parâmetros a serem fornecidos:
    • O nome do depósito.
      • Sinalização: --bucket BUCKET_NAME
    • A KEY do objeto.
      • Sinalização: --key KEY
    • Opcional : Retorne o objeto somente se sua tag de entidade (ETag) corresponder ao ETAG fornecido.
      • Sinalização: --if-match ETAG
    • Opcional : Retorne o objeto somente se ele tiver sido modificado desde o TIMESTAMP especificado.
      • Sinalização: --if-modified-since TIMESTAMP
    • Opcional : Retorne o objeto somente se seu ETag não corresponder ao ETAG fornecido.
      • Sinalização: --if-none-match ETAG
    • Opcional : Retorne o objeto somente se ele não tiver sido modificado desde o TIMESTAMP especificado.
      • Sinalização: --if-unmodified-since TIMESTAMP
    • Opcional : Baixa o INTERVALO de bytes especificado de um objeto.
      • Sinalização: --range RANGE
    • Opcional : NÚMERO da peça do objeto que está sendo lido.
      • Sinalização: --part-number NUMBER
    • Opcional : a REGIÃO em que o bucket está localizado.
      • Sinalização: --region REGION

Exemplo:

ibmcloud cos wait object-not-exists --bucket my-bucket --key my-object.txt

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