Instalación y configuración

El plugin es compatible con plataformas Linux (x86_64, arm64, ppc64le, s390x), Windows ® (x64) y macOS® (amd64, arm64) que se ejecutan en procesadores de 64 bits.

Instale el plugin con el mandato plugin install.

ibmcloud plugin install cloud-object-storage

Una vez instalado el plugin, puede configurar el plugin utilizando el mandato ibmcloud cos config. Esto te permite configurar el complemento con tus credenciales, la ubicación predeterminada para las descargas, la opción de autenticación que elijas, etc.

Para obtener un rendimiento óptimo, asegúrese de que el rastreo esté inhabilitado estableciendo la variable de entorno IBMCLOUD_TRACE en false.

El programa también ofrece la posibilidad de configurar el directorio local predeterminado para los archivos descargados y de establecer una región predeterminada. Para establecer la ubicación de descarga predeterminada, escriba ibmcloud cos config ddl y especifique en el programa una vía de acceso de archivo válida. Para establecer una región predeterminada, escriba ibmcloud cos config region y especifique en el programa un código de región, como por ejemplo us-south. El valor predeterminado es us-geo.

Puedes consultar tus credenciales actuales de IBM Cloud Object Storage accediendo a ibmcloud cos config list. Como el plugin genera el archivo de configuración, es mejor no editar el archivo de forma manual.

$ 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

$ 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

$ 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.

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

Habilitar el rastreo en la interfaz de línea de mandatos

El rastreo se puede habilitar estableciendo la variable de entorno IBMCLOUD_TRACE en true (no se tienen en cuenta mayúsculas y minúsculas). Cuando el rastreo está habilitado, la información de depuración adicional se imprime en el terminal.

En el terminal Linux/macOS:

export IBMCLOUD_TRACE=true

En el símbolo del sistema de Windows:

SET IBMCLOUD_TRACE=true

Para inhabilitar el rastreo, establezca la variable de entorno IBMCLOUD_TRACE en false (no se tienen en cuenta mayúsculas y minúsculas).

Índice de mandatos

Cada operación incluye una explicación de para qué sirve, cómo se utiliza y los parámetros opcionales u obligatorios. A menos que se especifique como opcional, todo parámetro de la lista es obligatorio.

El complemento CLI aún no es compatible con todas las funciones disponibles en Object Storage. Aspera High-Speed Transfer la CLI no puede utilizar las funciones de Key Protect, Object Storage inmutable, creación de cubos de o cortafuegos de cubos.

Terminación anómala de una carga de varias partes

• Acción: terminar de forma anómala una instancia de carga de varias partes finalizando la carga en el grupo en la cuenta de IBM Cloud Object Storage del usuario.
• Uso: ibmcloud cos multipart-upload-abort --bucket BUCKET_NAME --key KEY --upload-id ID [--region REGION] [--output FORMAT]
• Parámetros que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • La clave (KEY) del objeto.
    • Distintivo: --key KEY
  • ID de carga que identifica la carga de varias partes.
    • Distintivo: --upload-id ID
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Configurar un sitio web estático

• Acción: Configura un grupo para alojar un sitio web estático.

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

• Parámetros que se deben proporcionar:

  • El nombre del grupo.

    • Distintivo: --bucket BUCKET_NAME

  • La configuración del sitio web en forma de una estructura JSON. El prefijo file:// se utiliza para cargar la estructura JSON desde el archivo especificado, como por ejemplo --website-configuration file://<filename.json>.

    • Distintivo: --website-configuration STRUCTURE Los parámetros siguientes están disponibles para configurar el comportamiento estático del sitio web. No se requiere ninguno. Para obtener más detalles, consulte la documentación.

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

      De forma alternativa, si el sitio web del grupo está configurado para redirigir el tráfico, debe ser el único parámetro configurado:

      	  "RedirectAllRequestsTo": {
      	    "HostName": "string",
      	    "Protocol": "http"|"https"
      	  }
      	  ```
      
      
      

  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.

    • Distintivo: --region REGION

  • Opcional : El FORMATO de salida solo puede ser JSON o texto.

    • Distintivo: --output FORMAT

Copia de un objeto del grupo

Si desea añadir metadatos a un objeto durante la copia (utilizando la característica --metadata ), debe añadir el atributo --metadata-directive REPLACE ya que los metadatos se copian durante la operación de forma predeterminada (un --metadata-directive COPY implícito).

• Acción: copiar un objeto del grupo de origen en el grupo 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 que se deben proporcionar:
  • El nombre del bucket de destino.
    • Distintivo: --bucket BUCKET_NAME
  • La clave (KEY) del objeto.
    • Distintivo: --key KEY
  • (FUENTE) El nombre del bucket de origen y el nombre de la clave del objeto de origen, separados por una barra (/). Debe estar codificado segun URL.
    • Distintivo: --copy-source SOURCE
  • Opcional : Especifica « CACHING_DIRECTIVES » para la cadena de solicitud y respuesta.
    • Distintivo: --cache-control CACHING_DIRECTIVES
  • Opcional : Especifica información sobre la presentación (DIRECTIVES).
    • Distintivo: --content-disposition DIRECTIVES
  • Opcional : Especifica qué codificaciones de contenido (CONTENT_ENCODING) se aplican al objeto y, por lo tanto, qué mecanismos de decodificación deben aplicarse para obtener el tipo de medio al que hace referencia el campo de encabezado Content-Type.
    • Distintivo: --content-encoding CONTENT_ENCODING
  • Opcional : el IDIOMA en el que está redactado el contenido.
    • Distintivo: --content-language LANGUAGE
  • Opcional : un tipo MIME estándar que describa el formato de los datos del objeto.
    • Distintivo: --content-type MIME
  • Opcional : Copia el objeto si su etiqueta de entidad (Etag) coincide con la etiqueta especificada (ETAG).
    • Distintivo: --copy-source-if-match ETAG
  • Opcional : copia el objeto si se ha modificado desde la hora especificada (TIMESTAMP).
    • Distintivo: --copy-source-if-modified-since TIMESTAMP
  • Opcional : Copia el objeto si su etiqueta de entidad (ETag) es diferente de la etiqueta especificada (ETAG).
    • Distintivo: --copy-source-if-none-match ETAG
  • Opcional : copia el objeto si no se ha modificado desde la hora especificada (TIMESTAMP).
    • Distintivo: --copy-source-if-unmodified-since TIMESTAMP
  • Opcional : un MAP con los metadatos que se van a almacenar.
    • Distintivo: --metadata MAP Sintaxis JSON: El distintivo --metadata toma el prefijo file:// que se utiliza para cargar la estructura JSON desde el archivo especificado.

      {
        "file_name": "file_20xxxxxxxxxxxx45.zip",
        "label": "texas",
        "state": "Texas",
        "Date_to": "2019-11-09T16:00:00.000Z",
        "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
        "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
      }
      ```

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

Creación de un nuevo grupo

• Acción: crear un grupo en una instancia de 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]
  • Tenga en cuenta que debe proporcionar un CRN si utiliza la autenticación de IAM. Esto se puede establecer utilizando el mandato ibmcloud cos config crn.
• Parámetros que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Opcional : el nombre de la clase.
    • Distintivo: --class CLASS_NAME
  • El usuario debe especificar onerate_active al crear un depósito.
    • Distintivo: --class onerate_active
  • Opcional : Establece el ID de la instancia del servicio « IBM » en la solicitud.
    • Distintivo: --ibm-service-instance-id ID
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

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

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

Creación de una nueva carga de varias partes

• Acción: comenzar el proceso de carga de un archivo en varias partes creando una nueva instancia de carga de varias 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 que se deben proporcionar:

  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • La clave (KEY) del objeto.
    • Distintivo: --key KEY
  • Opcional : Especifica « CACHING_DIRECTIVES » para la cadena de solicitud y respuesta.
    • Distintivo: --cache-control CACHING_DIRECTIVES
  • Opcional : Especifica información sobre la presentación (DIRECTIVES).
    • Distintivo: --content-disposition DIRECTIVES
  • Opcional : Especifica la codificación del contenido (CONTENT_ENCODING) del objeto.
    • Distintivo: --content-encoding CONTENT_ENCODING
  • Opcional : el IDIOMA en el que está redactado el contenido.
    • Distintivo: --content-language LANGUAGE
  • Opcional : un tipo MIME estándar que describa el formato de los datos del objeto.
    • Distintivo: --content-type MIME
  • Opcional : un MAP con los metadatos que se van a almacenar.
    • Distintivo: --metadata MAP Sintaxis JSON: El distintivo --metadata toma el prefijo file:// que se utiliza para cargar la estructura JSON desde el archivo especificado.

  {
    "file_name": "file_20xxxxxxxxxxxx45.zip",
    "label": "texas",
    "state": "Texas",
    "Date_to": "2019-11-09T16:00:00.000Z",
    "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
    "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
  }
  

  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Supresión de un grupo existente

• Acción: suprimir un grupo existente en una instancia de IBM Cloud Object Storage.
• Uso: ibmcloud cos bucket-delete --bucket BUCKET_NAME [--region REGION] [--force] [--output FORMAT]
• Parámetros que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : La operación no solicitará confirmación.
    • Distintivo: --force
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Supresión de CORS de grupo

• Acción: suprimir la configuración de CORS en un grupo en la cuenta de IBM Cloud Object Storage de un usuario.
• Uso: ibmcloud cos bucket-cors-delete --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
• Parámetros que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Suprimir una configuración de sitio web estático

• Acción: Elimina la configuración de sitio web estático de un grupo.
• Uso: ibmcloud cos bucket-website-delete --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
• Parámetros que se deben proporcionar:

  • El nombre del grupo.

    • Distintivo: --bucket BUCKET_NAME
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Supresión de un objeto

• Acción: suprimir un objeto de un grupo en la cuenta de IBM Cloud Object Storage de un usuario.
• Uso: ibmcloud cos object-delete --bucket BUCKET_NAME --key KEY [--region REGION] [--force] [--output FORMAT]
• Parámetros que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • La clave (KEY) del objeto.
    • Distintivo: --key KEY
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : La operación no solicitará confirmación.
    • Distintivo: --force
    • Opcional : El FORMATO de salida solo puede ser JSON o texto.
      • Distintivo: --output FORMAT

Supresión de varios objetos

• Acción: suprimir varios objetos de un grupo en la cuenta de IBM Cloud Object Storage de un usuario.

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

• Parámetros que se deben proporcionar:

  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Una estructura (STRUCTURE) que utiliza la sintaxis abreviada o JSON.
    • Distintivo: --delete STRUCTURE
    • Sintaxis abreviada: --delete 'Objects=[{Key=string},{Key=string}],Quiet=boolean'

    • Sintaxis JSON: --delete file://<filename.json>

      El mandato --delete toma una estructura JSON que lista los objetos a suprimir. En este ejemplo, se utiliza el prefijo file:// para cargar la estructura JSON desde el archivo especificado.

  	{
  	"Objects": [
  	{
  	"Key": "string",
  	"VersionId": "string"
  	}
  ...
  	],
  	"Quiet": true|false
  	}
  

  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Descarga de un objeto

• Acción: descargar un objeto de un grupo en la cuenta de IBM Cloud Object Storage de un usuario.
• 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 que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • La clave (KEY) del objeto.
    • Distintivo: --key KEY
  • Opcional : Devuelve el objeto solo si su etiqueta de entidad (ETag) coincide con la especificada en ETAG ; en caso contrario, devuelve un 412 (fallo en la precondición).
    • Distintivo: --if-match ETAG
  • Opcional : Devuelve el objeto solo si se ha modificado desde el TIMESTAMP especificado; en caso contrario, devuelve un 304 (no modificado).
    • Distintivo: --if-modified-since TIMESTAMP
  • Opcional : Devuelve el objeto solo si su etiqueta de entidad (ETag) es diferente de la especificada en ETAG ; en caso contrario, devuelve un 304 (no modificado).
    • Distintivo: --if-none-match ETAG
  • Opcional : Devuelve el objeto solo si no se ha modificado desde el TIMESTAMP especificado; en caso contrario, devuelve un 412 (fallo en la precondición).
    • Distintivo: --if-unmodified-since TIMESTAMP
  • Opcional : Descarga los bytes del RANGE especificado de un objeto.
    • Distintivo: --range RANGE
  • Opcional : Establece el encabezado Cache-Control de la respuesta.
    • Distintivo: --response-cache-control HEADER
  • Opcional : Establece el encabezado «Content-Disposition» de la respuesta.
    • Distintivo: --response-content-disposition HEADER
  • Opcional : Establece el encabezado «Content-Encoding» de la respuesta.
    • Distintivo: --response-content-encoding HEADER
  • Opcional : Establece el encabezado «Content-Language» de la respuesta.
    • Distintivo: --response-content-language HEADER
  • Opcional : Establece el encabezado «Content-Type» de la respuesta.
    • Distintivo: --response-content-type HEADER
  • Opcional : Establece el encabezado «Expires» de la respuesta.
    • Distintivo: --response-expires HEADER
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT
  • Opcional : la ubicación donde guardar el contenido del objeto. Si no se especifica este parámetro, el programa utiliza la ubicación predeterminada.
    • Parámetro: OUTFILE

Búsqueda de un grupo

• Acción: determinar la región y la clase de un grupo en una instancia de IBM Cloud Object Storage.
• Uso: ibmcloud cos bucket-location-get --bucket BUCKET_NAME [--output FORMAT]
• Parámetros que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Obtención de la clase de un grupo

• Acción: determinar la clase de un grupo en una instancia de IBM Cloud Object Storage.
• Uso: ibmcloud cos bucket-class-get --bucket BUCKET_NAME [--output FORMAT]
• Parámetros que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Obtención de CORS de grupo

• Acción: devuelve la configuración de CORS de un grupo en la cuenta de IBM Cloud Object Storage de un usuario.
• Uso: ibmcloud cos bucket-cors-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
• Parámetros que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Obtención de las cabeceras de un grupo

• Acción: determinar si un grupo existe en una instancia de IBM Cloud Object Storage.
• Uso: ibmcloud cos bucket-head --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
• Parámetros que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Finalización de una carga de varias partes

• Acción: finalizar una instancia de carga de varias partes ensamblando las partes cargadas y cargando el archivo en el grupo de la cuenta la cuenta de IBM Cloud Object Storage del usuario.
• Uso: ibmcloud cos multipart-upload-complete --bucket BUCKET_NAME --key KEY --upload-id ID --multipart-upload STRUCTURE [--region REGION] [--output FORMAT]
• Parámetros que se deben proporcionar:

  • El nombre del grupo.

    • Distintivo: --bucket BUCKET_NAME

  • La clave (KEY) del objeto.

    • Distintivo: --key KEY

  • ID de carga que identifica la carga de varias partes.

    • Distintivo: --upload-id ID

  • La estructura (STRUCTURE) de MultipartUpload que se va a definir.

    • Distintivo: --multipart-upload STRUCTURE
    • Sintaxis abreviada: --multipart-upload 'Parts=[{ETag=string,PartNumber=integer},{ETag=string,PartNumber=integer}]'

    • Sintaxis JSON: --multipart-upload file://<filename.json>

      El mandato --multipart-upload toma una estructura JSON que describe las partes de la carga de varias partes que se deben volver a ensamblar en el archivo completo. En este ejemplo, se utiliza el prefijo file:// para cargar la estructura JSON desde el archivo especificado.

    		{
    		"Parts": [
    			{
    			 "ETag": "string",
    			 "PartNumber": integer
    			}
    			...
    			]
    		}
    

  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.

    • Distintivo: --region REGION

  • Opcional : El FORMATO de salida solo puede ser JSON o texto.

    • Distintivo: --output FORMAT

Configuración del programa

• Acción: configurar las preferencias del programa.
• Uso: ibmcloud cos config [COMMAND]
• Mandatos:
  • Cambiar entre autenticación de HMAC y de IAM.
    • Mandato: auth
  • Guardar CRN en la configuración.
    • Mandato: crn
  • Guardar la ubicación de descarga predeterminada en la configuración.
    • Mandato: ddl
  • Guardar las credenciales de HMAC en la configuración.
    • Mandato: hmac
  • Mostrar la configuración.
    • Mandato: list
  • Guardar la región predeterminada en la configuración.
    • Mandato: region
  • Cambia entre el estilo « VHost » y el estilo «Path URL ».
    • Mandato: url-style
  • Establezca el punto final de servicio predeterminado.
    • Mandato: endpoint-url

      • Parámetros:

        • --list muestra el punto final de servicio predeterminado actual, si se ha establecido. De lo contrario, estará vacío.
        • --url some.end.point.url cambiará el punto final de servicio por el valor especificado.
        • --clear elimina el punto final de servicio predeterminado URL que se ha configurado.

Obtener una configuración de sitio web estático

• Acción: Obtiene la configuración estática del sitio web de un grupo.
• Uso: ibmcloud cos bucket-website-get --bucket BUCKET_NAME [--region REGION] [--output FORMAT]
• Parámetros que se deben proporcionar:

  • El nombre del grupo.

    • Distintivo: --bucket BUCKET_NAME
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Obtención de las cabeceras de un objeto

• Acción: determinar si un archivo existe en un grupo en la cuenta de IBM Cloud Object Storage de un usuario.
• 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 que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • La clave (KEY) del objeto.
    • Distintivo: --key KEY
  • Opcional : Devuelve el objeto solo si su etiqueta de entidad (ETag) coincide con la especificada en ETAG ; en caso contrario, devuelve un 412 (fallo en la precondición).
    • Distintivo: --if-match ETAG
  • Opcional : Devuelve el objeto solo si se ha modificado desde el TIMESTAMP especificado; en caso contrario, devuelve un 304 (no modificado).
    • Distintivo: --if-modified-since TIMESTAMP
  • Opcional : Devuelve el objeto solo si su etiqueta de entidad (ETag) es diferente de la especificada en ETAG ; en caso contrario, devuelve un 304 (no modificado).
    • Distintivo: --if-none-match ETAG
  • Opcional : Devuelve el objeto solo si no se ha modificado desde el TIMESTAMP especificado; en caso contrario, devuelve un 412 (fallo en la precondición).
    • Distintivo: --if-unmodified-since TIMESTAMP
  • Descarga los bytes RANGE especificados de un objeto.
    • Distintivo: --range RANGE
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Obtención de una lista de todos los grupos

• Acción: mostrar una lista de todos los grupos de la cuenta de IBM Cloud Object Storage de un usuario. Los grupos se pueden encontrar en diferentes regiones.
• Uso: ibmcloud cos buckets [--ibm-service-instance-id ID] [--output FORMAT]
  • Tenga en cuenta que debe proporcionar un CRN si utiliza la autenticación de IAM. Esto se puede establecer utilizando el mandato ibmcloud cos config crn.
• Parámetros que se deben proporcionar:
  • No hay parámetros que especificar.
    • Opcional : Establece el ID de la instancia del servicio « IBM » en la solicitud.
      • Distintivo: --ibm-service-instance-id
    • Opcional : El FORMATO de salida solo puede ser JSON o texto.
      • Distintivo: --output FORMAT

Obtención de una lista de las cargas de varias partes en curso

• Acción: mostrar las cargas de varias partes en curso.
• 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 que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Opcional : Un DELIMITADOR es un carácter que se utiliza para agrupar claves.
    • Distintivo: --delimiter DELIMITER
  • Opcional : Solicita que se codifiquen las claves de los objetos en la respuesta y especifica el MÉTODO de codificación que se debe utilizar.
    • Distintivo: --encoding-type METHOD
  • Opcional : Limita la respuesta a las claves que comienzan por el PREFIX especificado.
    • Distintivo: --prefix PREFIX
  • Opcional : junto con «upload-id-marker», este parámetro especifica la carga multiparte a partir de la cual debe comenzar la lista.
    • Distintivo: --key-marker value
  • Opcional : junto con el marcador «key», especifica la carga multiparte tras la cual debe comenzar la lista. Si no se especifica key-marker, el parámetro upload-id-marker se pasa por alto.
    • Distintivo: --upload-id-marker value
  • Opcional : el TAMAÑO de cada página que se va a recibir en la llamada de servicio. Esto no afecta al número de elementos que se devuelven en la salida del mandato. Si se establece un tamaño de página menor, se generan más llamadas al servicio y se recuperan menos elementos en cada llamada. Esto puede ayudar a evitar que las llamadas de servicio caduquen. (valor por defecto: 1000).
    • Distintivo: --page-size SIZE
  • Opcional : el NÚMERO total de elementos que se mostrarán en la salida comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un valor NextToken en la salida del mandato. Para reanudar la paginación, introduce el valor « NextToken » en el argumento «starting-token» de un comando posterior. (por defecto: 0).
    • Distintivo: --max-items NUMBER
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Obtención de una lista de objetos

• Acción: obtener una lista de los archivos contenidos en un grupo en la cuenta de IBM Cloud Object Storage de un usuario. Esta operación se limita actualmente a los 1000 últimos objetos creados y no se puede filtrar.
• 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 que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Opcional : Un DELIMITADOR es un carácter que se utiliza para agrupar claves.
    • Distintivo: --delimiter DELIMITER
  • Opcional : Solicita que se codifiquen las claves de los objetos en la respuesta y especifica el MÉTODO de codificación que se debe utilizar.
    • Distintivo: --encoding-type METHOD
  • Opcional : Limita la respuesta a las claves que comienzan por el PREFIX especificado.
    • Distintivo: --prefix PREFIX
  • Opcional : un TOKEN para especificar dónde comenzar la paginación. Es el valor NextToken de una respuesta truncada anterior.
    • Distintivo: --starting-token TOKEN
  • Opcional : el TAMAÑO de cada página que se va a recibir en la llamada de servicio. Esto no afecta al número de elementos que se devuelven en la salida del mandato. Si se establece un tamaño de página menor, se generan más llamadas al servicio y se recuperan menos elementos en cada llamada. Esto puede ayudar a evitar que las llamadas de servicio agoten el tiempo de espera. (valor por defecto: 1000)
    • Distintivo: --page-size SIZE
  • Opcional : el NÚMERO total de elementos que se mostrarán en la salida comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un valor NextToken en la salida del mandato. Para reanudar la paginación, introduce el valor « NextToken » en el argumento «starting-token» de un comando posterior. (por defecto: 0)
    • Distintivo: --max-items NUMBER
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Listar objetos v2

• Acción: Mostrar todos los objetos de un bucket concreto.
• Uso: list-objects-v2 --bucket BUCKET_NAME [--starting-token Starting Token] [--delimiter DELIMITER] [--encoding-type METHOD] [--fetch-owner Boolean] [--max-items NUMBER] [--prefix PREFIX] [--start-after Start After] [--page-size SIZE] [--region REGION] [--output FORMAT] [--json]
• Parámetros que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Opcional : Un DELIMITADOR es un carácter que se utiliza para agrupar claves.
    • Distintivo: --delimiter DELIMITER
  • Opcional : Solicita que se codifiquen las claves de los objetos en la respuesta y especifica el MÉTODO de codificación que se debe utilizar.
    • Distintivo: --encoding-type METHOD
  • Opcional : Limita la respuesta a las claves que comienzan por el PREFIX especificado.
    • Distintivo: --prefix PREFIX
  • Opcional : un TOKEN para especificar dónde comenzar la paginación. Es el valor NextToken de una respuesta truncada anterior.
    • Distintivo: --starting-token TOKEN
  • Opcional : el TAMAÑO de cada página que se va a recibir en la llamada de servicio. Esto no afecta al número de elementos que se devuelven en la salida del mandato. Si se establece un tamaño de página menor, se generan más llamadas al servicio y se recuperan menos elementos en cada llamada. Esto puede ayudar a evitar que las llamadas de servicio agoten el tiempo de espera. (valor por defecto: 1000)
    • Distintivo: --page-size SIZE
  • Opcional : el NÚMERO total de elementos que se mostrarán en la salida comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un valor NextToken en la salida del mandato. Para reanudar la paginación, introduce el valor « NextToken » en el argumento «starting-token» de un comando posterior. (por defecto: 0)
    • Distintivo: --max-items NUMBER
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT
  • Opcional : El valor booleano no aparece por defecto en « listV2 »; si quieres que se incluya el campo «owner» con cada clave en el resultado, establece el campo «fetch owner» en «true».
    • Distintivo: --fetch-owner Boolean
  • Opcional : «Empezar después de» es el punto a partir del cual quieres que « S3 » comience a enumerar. S3 inicia el listado tras la clave especificada. StartAfter puede ser cualquier clave del grupo.
    • Distintivo: --start-after Start After
  • Obsoleto : La salida se devuelve en formato JSON sin procesar.
    • Distintivo: --json

Obtención de una lista de las partes

• Acción: mostrar información sobre una instancia de carga de varias partes en curso.
• 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 que se deben proporcionar:
  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • La clave (KEY) del objeto.
    • Distintivo: --key KEY
  • ID de carga que identifica la carga de varias partes.
    • Distintivo: --upload-id ID
  • El valor de número de parte tras el que comienza la lista (valor predeterminado: 1)
    • Distintivo: --part-number-marker VALUE
  • Opcional : el TAMAÑO de cada página que se va a recibir en la llamada de servicio. Esto no afecta al número de elementos que se devuelven en la salida del mandato. Si se establece un tamaño de página menor, se generan más llamadas al servicio y se recuperan menos elementos en cada llamada. Esto puede ayudar a evitar que las llamadas de servicio agoten el tiempo de espera. (valor por defecto: 1000)
    • Distintivo: --page-size SIZE
  • Opcional : el NÚMERO total de elementos que se mostrarán en la salida comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un valor NextToken en la salida del mandato. Para reanudar la paginación, introduce el valor « NextToken » en el argumento «starting-token» de un comando posterior. (por defecto: 0)
    • Distintivo: --max-items NUMBER
  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Establecimiento de CORS de grupo

• Acción: establecer la configuración de CORS de un grupo en la cuenta de IBM Cloud Object Storage de un usuario.

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

• Parámetros que se deben proporcionar:

  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • Opcional : una ESTRUCTURA que utilice la sintaxis JSON en un archivo.
    • Distintivo: --cors-configuration STRUCTURE

    • Sintaxis JSON: --cors-configuration file://<filename.json>

      El comando --cors-configuration toma una estructura JSON que describe la configuración de CORS. En este ejemplo, se utiliza el prefijo file:// para cargar la estructura JSON desde el archivo especificado.

  	{
  	"CORSRules": [
  	{
    	"AllowedHeaders": ["*"],
    	"AllowedMethods": ["PUT", "GET", "DELETE"],
    	"AllowedOrigins": ["http://www.example.com"],
    	"ExposeHeaders": ["ExposeHeader7","ExposeHeader8"],
    	"MaxAgeSeconds": 75
  	}
  	...
  	]
  	}
  

  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Transferencia de un objeto

• Acción: cargar un objeto a un grupo en la cuenta de IBM Cloud Object Storage de un usuario.

• 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 que se deben proporcionar:

  • El nombre del grupo.
    • Distintivo: --bucket BUCKET_NAME
  • La clave (KEY) del objeto.
    • Distintivo: --key KEY
  • Opcional : Ubicación de los datos del objeto (FILE_PATH).
    • Distintivo: --body FILE_PATH
  • Opcional : Especifica « CACHING_DIRECTIVES » para la cadena de solicitud y respuesta.
    • Distintivo: --cache-control CACHING_DIRECTIVES
  • Opcional : Especifica información sobre la presentación (DIRECTIVES).
    • Distintivo: --content-disposition DIRECTIVES
  • Opcional : Especifica la codificación del contenido (CONTENT_ENCODING) del objeto.
    • Distintivo: --content-encoding CONTENT_ENCODING
  • Opcional : el IDIOMA en el que está redactado el contenido.
    • Distintivo: --content-language LANGUAGE
  • Opcional : TAMAÑO del cuerpo en bytes. Este parámetro resulta útil cuando no es posible determinar automáticamente el tamaño del cuerpo. (valor por defecto: 0)
    • Distintivo: --content-length SIZE
  • Opcional : El resumen de los datos en formato « MD5 » de 128 bits de la « base64-encoded ».
    • Distintivo: --content-md5 MD5
  • Opcional : un tipo MIME estándar que describa el formato de los datos del objeto.
    • Distintivo: --content-type MIME
  • Opcional : un MAP con los metadatos que se van a almacenar.
    • Distintivo: --metadata MAP Sintaxis JSON: El distintivo --metadata toma el prefijo file:// que se utiliza para cargar la estructura JSON desde el archivo especificado.

  {
    "file_name": "file_20xxxxxxxxxxxx45.zip",
    "label": "texas",
    "state": "Texas",
    "Date_to": "2019-11-09T16:00:00.000Z",
    "Sha256sum": "9e39dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx8ce6b68ede3a47",
    "Timestamp": "Thu, 17 Oct 2019 09:22:13 GMT"
  }
  

  • Opcional : la REGIÓN en la que se encuentra el bucket. Si no se especifica este distintivo, el programa utiliza la opción predeterminada especificada en la configuración.
    • Distintivo: --region REGION
  • Opcional : El FORMATO de salida solo puede ser JSON o texto.
    • Distintivo: --output FORMAT

Control manual de las cargas de varias partes

La interfaz de línea de comandos (CLI) de IBM Cloud Object Storage permite a los usuarios subir archivos de gran tamaño en varias partes mediante las funciones de subida multiparte de AWS. Para iniciar una nueva carga en varias partes, ejecuta el comando « multipart-upload-create », que devuelve el ID de la nueva instancia de carga. Para continuar con el proceso de carga, debe guardar el ID de carga para cada mandato siguiente. Este comando requiere que usted genere un hash MD5:

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

Después de ejecutar el mandato multipart-upload-complete, ejecute part-upload para cada parte de archivo que desee cargar. En el caso de las subidas en varias partes, cada parte del archivo (excepto la última) debe tener un tamaño mínimo de 5 MB. Para dividir un archivo en varias partes, puede ejecutar split en una ventana de terminal. Por ejemplo, si tiene un archivo de 13 MB llamado TESTFILE en el escritorio y desea dividirlo en partes de archivo de 5 MB cada una, puede ejecutar split -b 3m ~/Desktop/TESTFILE part-file-. Este mandato genera tres partes del archivo en dos partes de archivo de 5 MB cada una, y una parte de archivo de 3 MB, llamadas part-file-aa, part-file-ab y part-file-ac. As each file part is uploaded, the CLI print its ETag . You must save this ETag into a formatted JSON file, along with the part number. Use this template to create your own Archivo de datos 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."
    }
    ]
}

Añada más entradas a esta plantilla JSON según sea necesario.

Para consultar el estado de tu carga multiparte, siempre puedes ejecutar el comando « part-list », indicando el nombre del depósito, la clave y el ID de la carga. Esto muestra información sin procesar sobre tu instancia de subida multiparte. Una vez que hayas terminado de cargar cada parte del archivo, ejecuta el comando « multipart-upload-complete » con los parámetros necesarios. Si todo funciona correctamente, recibirá una confirmación de que el archivo se ha cargado correctamente en el grupo deseado.

Configuración de bloqueo de objeto

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

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

Retención de objetos

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

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

Retención legal de objeto

ibmcloud cos object-legal-hold-put --bucket bucket-name --key file-name.txt --legal-hold ‘{"Status": "ON"}’

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

Configurar réplica de grupo

Configuración para configurar un grupo replicado.

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

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

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

Próximos pasos

Como cada procedimiento siempre va exactamente como se ha planificado, es posible que no haya visto ninguno de los códigos de cabecera y error comunes. Para obtener más información, consulte la Referencia de API.