object_volume_add
Adds a new volume to EXAStorage pointing to a cloud storage.
Mandatory parameters
| Parameter name | Data type | Description |
|---|---|---|
| vol_type | string | The data volume type. For example, enter S3 for AWS. |
| name | string | The name of the new data volume. |
Optional parameters
| Parameter name | Data type | Description |
|---|---|---|
| bucket | string | The name of an existing bucket you want to add to the data volume. |
| region | string | The encoded geographical region that stores the cloud resources. For example, Europe (Frankfurt) is eu-central-1. |
| prefix | string | The prefix of the storage area within the bucket where you want to add the data volume. |
| owner | tuple, list | Tuple of the database owner in type integer or (user name, user group name). |
| end_point | string | The gateway endpoint tag. |
| credentials | string | The type of credentials needed to access the data volume. Valid values are: root, IAM, and MFA. |
| permissions | string | The permissions for individual files within the data volume. |
| shared | boolean | Sets whether the data volume is shared. Valid values are True and False. |
| priority | string | The priority of the volume in terms of process scheduling priority. A higher number specifies a higher priority. For most cases, you can set the priority to a value of 10. |
| options | string | The volume options. |
| labels | list | A description of the new data volume. |
Substitute parameters
There are no substitute parameters.
Allowed users
The following users are allowed to run this job:
- root
Allowed groups
The following groups are allowed to run this job:
- root
- exaadm
- exastoradm
Examples
The following examples show how to run this job in a Python program using XML-RPC or on the command line using confd_client.
Python using XML-RPC