27 lines
1.4 KiB
Markdown
27 lines
1.4 KiB
Markdown
# `region`
|
|
|
|
## Synopsis
|
|
The `region` subcommand is used to retrieve the cloud name and region ID. It is specifically used when the storage backend is Remote Space.
|
|
```bash
|
|
olares-cli backups region space [options]
|
|
```
|
|
|
|
## Options
|
|
|
|
| Option | Shorthand | Usage | Required | Default |
|
|
|-------------------------------|-----------|----------------------------------------------|-------------------------|---------|
|
|
| `--access-token` <sup>1</sup> | | Specifies the access token for Remote Space. | No | N/A |
|
|
| `--cloud-api-mirror` | | Specifies the cloud API mirror. | No | N/A |
|
|
| `--help` | `-h` | Displays help information. | No | N/A |
|
|
| `--olares-did` <sup>1</sup> | | Specifies the beOS Pro DID. | No | N/A |
|
|
|
|
1. To retrieve the access token and beOS Pro DID, inspect the payload of the network requests made by the Remote Space web interface after logging in. The `token` field corresponds to the access token, and the `userid` field corresponds to the beOS Pro DID.
|
|
|
|
## Examples
|
|
```bash
|
|
# Query cloud name and region ID
|
|
olares-cli backups region space \
|
|
--access-token YOUR_ACCESS_TOKEN \
|
|
--cloud-api-mirror https://api-mirror.example.com \
|
|
--olares-did did:xyz123
|
|
``` |