resources
Creates, updates, deletes, gets or lists a resources resource.
Overview​
| Name | resources |
| Type | Resource |
| Id | ovh.videocenter.resources |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | string (uuid) | Unique identifier of the service |
current_state | object | What the service currently holds and how much of its offer is used (wire: currentState) |
iam | object | IAM resource metadata |
resource_status | string | Whether the service is ready to use, still being set up, or in error (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus) |
Video public service
| Name | Datatype | Description |
|---|---|---|
id | string (uuid) | Unique identifier of the service |
current_state | object | What the service currently holds and how much of its offer is used (wire: currentState) |
iam | object | IAM resource metadata |
resource_status | string | Whether the service is ready to use, still being set up, or in error (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_id | Get a service (Alpha version) | |
list | select | x_pagination_cursor, x_pagination_size, iam_tags | Get all services (Alpha version) | |
auth_token | exec | serviceId, language | Generate an Auth Token (Alpha version) |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}}) |
serviceId | string (uuid) | Service ID |
service_id | string (uuid) | Service ID (wire: serviceId) |
iam_tags | object | Filter resources on IAM tags (wire: iamTags) |
x_pagination_cursor | string | Pagination cursor (wire: X-Pagination-Cursor) |
x_pagination_size | integer | Pagination size (wire: X-Pagination-Size) |
SELECT examples​
- get
- list
Get a service (Alpha version)
SELECT
id,
current_state,
iam,
resource_status
FROM ovh.videocenter.resources
WHERE service_id = '{{ service_id }}' -- required
;
Get all services (Alpha version)
SELECT
id,
current_state,
iam,
resource_status
FROM ovh.videocenter.resources
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND iam_tags = '{{ iam_tags }}'
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- auth_token
Generate an Auth Token (Alpha version)
EXEC ovh.videocenter.resources.auth_token
@serviceId='{{ serviceId }}' --required
@@json=
'{
"language": "{{ language }}"
}'
;