Base resource information formats
You can use the base resource information formats when calling the update resource and get resource APIs if you do not need to update or get type-specific information. (To create resources, you must use one of the type-specific formats.)
There are two base formats that contain information common to resources of every type: The QICC0000 format does not include the compression and encryption parameters introduced in Cloud Storage Solutions version 1.2. It is intended for backward compatibility with applications that were built to use the version 1.1 APIs. QICC0010 includes compression and encryption parameters.
If you are updating a resource, you must provide a name in the resource_name field to identify the resource to update. Then in fields that you want to update, provide new values. In fields that you do not want to update, provide the current value or the value *SAME. You cannot update a resource ID.
If you are getting a resource, provide no format values. The format returns all of the information for the resource specified in the get API.
The QICC0000 and QICC0010 formats contain the following resource information:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | INT | resource_id |
| 4 | 4 | INT | resource_type |
| 8 | 8 | CHAR(10) | resource_name |
| 18 | 12 | CHAR(100) | resource_desc |
| 108 | 6C | CHAR(1024) | directory_name (not currently supported) |
| 1132 | 46C | CHAR | compress_data (QICC0010 only) |
| 1133 | 46D | CHAR | encrypt_data (QICC0010 only) |
| 1134 | 46E | CHAR(20) | keystore (QICC0010 only) |
| 1154 | 482 | CHAR(32) | keylabel (QICC0010 only) |
Fields
- resource_id
- The unique ID that is assigned to the resource by Cloud Storage Solutions when the resource is created. You cannot update resource IDs.
- resource_type
- The cloud service provider. The following are possible values:
- 0: AWSS3, Google Cloud Storage, and IBM Cloud Object Storage
- 4: FTP
- resource_name
- The unique resource name. Names are a maximum of ten characters, and are IBM i basic names that must adhere to the *NAME type restrictions. Every basic name can begin with the characters A-Z, $, #, or @ and can be followed by up to nine characters. The remaining characters can include the same characters as the first but can also include numbers 0-9, underscores (_), and periods (.). Lowercase letters are changed to uppercase letters by the system. Basic names used in IBM-supplied commands can be no longer than 10 characters. However, in your own commands you can define parameters of type *NAME (specified on the TYPE parameter of the PARM or ELEM statements) with up to 256 characters. For more information, and information on names in quoted form, see the topic Names (*NAME) in the IBM Documentation.
- resource_desc
- The resource description. Passed in values must have a CCSID of 1200 (UTF16); returned values have a CCSID of 1200 (UTF16). Values can include uppercase and lowercase letters.
- directory_name
- The name of the IFS directory to keep synchronized with the resource. Passed in values must have a CCSID of 1200 (UTF16); returned values have a CCSID of 1200 (UTF16). Values can include uppercase and lowercase letters. [This field is not currently supported.]
- compress_data
- Switch enabling or disabling file compression. A value of 0 means compression is disabled; a value of 1 means compression is enabled. This field is only available in QICC0200 and QICC0300 formats.
- encrypt_data
- Switch enabling or disabling file encryption. A value of 0 means encryption is disabled; a value of 1 means encryption is enabled. When enabled, Cloud Storage Solutions uses the Advanced Encryption Standard (AES) encryption algorithm to encrypt files before they are copied to the cloud. The files remain encrypted "at rest" in the cloud, and are decrypted when copied back to the host IBM i computer. This field is only available in QICC0200 and QICC0300 formats.
- keystore
- The name of the keystore file that contains the certificates that Cloud Storage Solutions should use to "at rest" encrypt files the cloud using the resource. This field is only available in QICC0200 and QICC0300 formats.
- keylabel
- The label of the certificate that Cloud Storage Solutions should use to "at rest" encrypt files using the resource. This certificate must be in the keystore file specified in the keystore field. This field is only available in QICC0200 and QICC0300 formats. Values can include uppercase and lowercase letters.