Cloud Region
Cloud Region provides tools for listing, retrieving, and updating resources in F5 Distributed Cloud.
| Tool | Description |
|---|---|
f5xc-api-cloudinfrastructure-cloud-region-get | Get Cloud Region. |
f5xc-api-cloudinfrastructure-cloud-region-list | List Cloud Region. |
f5xc-api-cloudinfrastructure-cloud-region-update | Update Cloud Region. |
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”| Parameter | Description | Example |
|---|---|---|
name | Name The name of the configuration object to be fetched. | example-resource |
namespace | Namespace The namespace in which the configuration object is present. | system |
Query Parameters
Section titled “Query Parameters”| Parameter | Description | Example |
|---|---|---|
response_format | The format in which the configuration object is to be fetched. This could be for example - in GetSpec form for the contents of object… | GET_RSP_FORMAT_DEFAULT |
label_filter | A LabelSelectorType expression that every item in list response will satisfy. | - |
report_fields | The report_fields parameter… | - |
report_status_fields | The report_status_fields parameter… | - |
Configuration Choices
Section titled “Configuration Choices”This resource includes mutually exclusive configuration options:
policy_group_choice
Section titled “policy_group_choice”| Option | Description | Recommended |
|---|---|---|
spec.default_policy_group | Default policy group | |
spec.policy_group | Policy group |
Example Usage
Section titled “Example Usage”Ask Claude to help you work with Cloud Region resources:
List Cloud Regions
Section titled “List Cloud Regions”“List all cloud-regions in the ‘production’ namespace”
Get Cloud Region Details
Section titled “Get Cloud Region Details”“Get details of the cloud-region named ‘example’ in namespace ‘production‘“
CURL Examples
Section titled “CURL Examples”# List resourcescurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/cloud_regions" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"
# Get specific resourcecurl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/$${PARAM}/cloud_regions/$${PARAM}" \ -H "Authorization: APIToken ${F5XC_API_TOKEN}"