tokens

Creates, updates, deletes, gets or lists a tokens resource.

Overview

Name	tokens
Type	Resource
Id	ovh.cloud_ai.tokens

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Application token Id
created_at	string (date-time)	Application token creation date (wire: createdAt)
spec	object	Application token spec
status	object	Application token status
updated_at	string (date-time)	Application token update date (wire: updatedAt)

list

AI Solutions Application Token

Name	Datatype	Description
id	string (uuid)	Application token Id
created_at	string (date-time)	Application token creation date (wire: createdAt)
spec	object	Application token spec
status	object	Application token status
updated_at	string (date-time)	Application token update date (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get application token information
list	select	service_name		List application tokens
create	insert	service_name, name, region, role		Create a new application token
delete	delete	id, service_name		Delete this application token
renew	exec	id, service_name		Renew an application token

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"}})
id	string (uuid)	Id
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples

get

Get application token information

SELECT
id,
created_at,
spec,
status,
updated_at
FROM ovh.cloud_ai.tokens
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List application tokens

SELECT
id,
created_at,
spec,
status,
updated_at
FROM ovh.cloud_ai.tokens
WHERE service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Create a new application token

INSERT INTO ovh.cloud_ai.tokens (
label_selector,
name,
region,
role,
service_name
)
SELECT 
'{{ label_selector }}',
'{{ name }}' /* required */,
'{{ region }}' /* required */,
'{{ role }}' /* required */,
'{{ service_name }}'
RETURNING
id,
created_at,
spec,
status,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: tokens
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the tokens resource.
  - name: label_selector
    value: "{{ label_selector }}"
    description: |
      Application token label selector
  - name: name
    value: "{{ name }}"
    description: |
      Application token name
  - name: region
    value: "{{ region }}"
    description: |
      Public Cloud Storage Region
  - name: role
    value: "{{ role }}"
    description: |
      Role granted by this application token
    valid_values: ['ai_training_operator', 'ai_training_read', 'quantum_operator', 'quantum_reader']

DELETE examples

delete

Delete this application token

DELETE FROM ovh.cloud_ai.tokens
WHERE id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;

Lifecycle Methods

EXEC variables use wire (API) names.

renew

Renew an application token

EXEC ovh.cloud_ai.tokens.renew 
@id='{{ id }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;