From 83c802f6baaaade422636c0f48e3a8e474b72ffa Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 10 Jan 2025 04:22:30 +0000 Subject: [PATCH] Documentation autoupdate --- html/rest_api_doc.html | 296 +++--- html/site/sitemap.xml | 50 +- html/site/sitemap.xml.gz | Bin 345 -> 345 bytes yaml/rest_api_doc_spec.yaml | 1698 +++++++++++++++++------------------ 4 files changed, 1022 insertions(+), 1022 deletions(-) diff --git a/html/rest_api_doc.html b/html/rest_api_doc.html index d8eabc60d9..c94f4c2244 100644 --- a/html/rest_api_doc.html +++ b/html/rest_api_doc.html @@ -426,7 +426,7 @@ -
Rucio logo
API docs by Redocly
Rucio logo
API docs by Redocly
Error handling " class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Not acceptable

Request samples 

curl --request GET \
   --url http://undefinedundefined/accounts/{account}/usage/global/{rse_expression} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Delete

Delete an account.

-
Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

-

Responses

Request samples 

curl --request DELETE \
-  --url http://undefinedundefined/accounts/{account} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Create

Create an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

@@ -810,21 +798,19 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Invalid Auth Token

Request samples

Content type
application/json
{
  • "type": "USER",
  • "email": "string"
}

Response samples

Content type
application/json
"Created"

List account parameters

Lists all parameters for an account.

+

Request samples

Content type
application/json
{
  • "type": "USER",
  • "email": "string"
}

Response samples

Content type
application/json
"Created"

Delete

Delete an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

-

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request DELETE \
   --url http://undefinedundefined/accounts/{account} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "account": "string",
  • "account_type": "string",
  • "status": "string",
  • "email": "string",
  • "suspended_at": "string",
  • "deleted_at": "string"
}

Update

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Update

Update a parameter for an account.

Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

@@ -838,7 +824,21 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Invalid Auth Token

Request samples

Content type
application/json
{ }

List

Request samples

Content type
application/json
{ }

List account parameters

Lists all parameters for an account.

+
Authorizations:
AuthToken
path Parameters
account
required
string

The account identifier.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/accounts/{account} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "account": "string",
  • "account_type": "string",
  • "status": "string",
  • "email": "string",
  • "suspended_at": "string",
  • "deleted_at": "string"
}

List

List all accounts.

Authorizations:
AuthToken

Responses

Request samples 

curl --request GET \
   --url http://undefinedundefined/lifetime_exceptions/ \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Get Exception

Get a single Lifetime Exception.

-
Authorizations:
AuthToken
path Parameters
exception_id
required
string

The id of the lifetime exception.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/lifetime_exceptions/{exception_id} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Approve/Reject exception

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Approve/Reject exception

Approve/Reject a Lifetime Exception.

Authorizations:
AuthToken
path Parameters
exception_id
required
string

The id of the Lifetime Exception.

@@ -1902,7 +1888,21 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Invalid Auth Token

Request samples

Content type
application/json
{
  • "state": "A"
}

Response samples

Content type
application/json
"Created"

Lock

Get locks by rse

Request samples

Content type
application/json
{
  • "state": "A"
}

Response samples

Content type
application/json
"Created"

Get Exception

Get a single Lifetime Exception.

+
Authorizations:
AuthToken
path Parameters
exception_id
required
string

The id of the lifetime exception.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/lifetime_exceptions/{exception_id} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Lock

Get locks by rse

Get all dataset locks for an associated rse.

Authorizations:
AuthToken
path Parameters
rse
required
string

The rse name.

@@ -2437,23 +2437,7 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Not found

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
"string"

Get Subscription

Retrieve a subscription.

-
Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

-
name
required
string

The subscription name.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/subscriptions/{account}/{name} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Update subscription

Request samples

Content type
application/json
{
  • "options": {
    }
}

Response samples

Content type
application/json
"string"

Update subscription

Update an existing subscription.

Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

@@ -2469,7 +2453,23 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Invalid Auth Token

Request samples

Content type
application/json
{
  • "options": {
    }
}

Get Subscription by Name

Request samples

Content type
application/json
{
  • "options": {
    }
}

Get Subscription

Retrieve a subscription.

+
Authorizations:
AuthToken
path Parameters
account
required
string

The account name.

+
name
required
string

The subscription name.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/subscriptions/{account}/{name} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Get Subscription by Name

Retrieve a subscription by name.

Authorizations:
AuthToken
path Parameters
name
required
string

The subscription name.

@@ -2611,23 +2611,7 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

RSE not found

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Delete Rse Distance

Delete distance information between source RSE and destination RSE.

-
Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

-
destination
required
string

The name of the destination Rucio Storage Element.

-

Responses

Request samples 

curl --request DELETE \
-  --url http://undefinedundefined/rses/{source}/distances/{destination} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Deleted"

Create Rse Distance

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"Created"

Create Rse Distance

Post a rse distance.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

@@ -2645,8 +2629,8 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Rse not found

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Get Rse Distances

Returns the distances between a source and destination rse.

+

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Delete Rse Distance

Delete distance information between source RSE and destination RSE.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

destination
required
string
Error handling " class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Rse not found

Request samples 

curl --request GET \
+

Request samples 

curl --request DELETE \
   --url http://undefinedundefined/rses/{source}/distances/{destination} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Update Rse Distance

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Deleted"

Update Rse Distance

Update rse distance information.

Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

@@ -2679,7 +2663,23 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Rse not found

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Delete Protocol Attributes

Request samples

Content type
application/json
{
  • "distance": 0,
  • "ranking": 0
}

Response samples

Content type
application/json
"Created"

Get Rse Distances

Returns the distances between a source and destination rse.

+
Authorizations:
AuthToken
path Parameters
source
required
string

The name of the source Rucio Storage Element.

+
destination
required
string

The name of the destination Rucio Storage Element.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/rses/{source}/distances/{destination} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Delete Protocol Attributes

Delete all protocol attributes.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2767,25 +2767,7 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Not acceptable

Request samples 

curl --request GET \
   --url http://undefinedundefined/rses/{rse}/accounts/usage \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Get Rse Usage Information

Get rse usage information.

-
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
query Parameters
per_account
boolean

Boolean whether the usage should be also calculated per account or not.

-
source
string

The information source, e.g., srm.

-

Responses

Request samples 

curl --request GET \
-  --url 'http://undefinedundefined/rses/{rse}/usage?per_account=SOME_BOOLEAN_VALUE&source=SOME_STRING_VALUE' \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Update Rse Usage

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • {
    }
]

Update Rse Usage

Update the RSE Update information.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2807,7 +2789,25 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Rse not found

Request samples

Content type
application/json
{
  • "source": "string",
  • "used": 0,
  • "free": 0,
  • "files": 0
}

Get Rse Usage History

Request samples

Content type
application/json
{
  • "source": "string",
  • "used": 0,
  • "free": 0,
  • "files": 0
}

Get Rse Usage Information

Get rse usage information.

+
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

+
query Parameters
per_account
boolean

Boolean whether the usage should be also calculated per account or not.

+
source
string

The information source, e.g., srm.

+

Responses

Request samples 

curl --request GET \
+  --url 'http://undefinedundefined/rses/{rse}/usage?per_account=SOME_BOOLEAN_VALUE&source=SOME_STRING_VALUE' \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/x-json-stream
[
  • {
    }
]

Get Rse Usage History

Get the rse usage history

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2835,11 +2835,15 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Rse not found

Request samples

Content type
application/json
{
  • "name": "string"
}

Get Rse Limits

Get the rse limits.

+

Request samples

Content type
application/json
{
  • "name": "string"
}

Update Rse Limit

Update an rse limit.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/rses/{rse}/limits \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "limit name1": 0,
  • "limit name2": 0
}

Update Rse Limit

Update an rse limit.

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": 0
}

Get Rse Limits

Get the rse limits.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-
Request Body schema: application/json
name
string

The name of the limit.

-
value
integer

The value of the limit.

-

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "value": 0
}

Delete QoS Policy

Request samples 

curl --request GET \
+  --url http://undefinedundefined/rses/{rse}/limits \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "limit name1": 0,
  • "limit name2": 0
}

Delete QoS Policy

Delete QoS policy from RSE.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2897,19 +2897,7 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Not acceptable

Request samples 

curl --request POST \
   --url http://undefinedundefined/rses/{rse}/qos_policy/{policy} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Created"

Disable RSE

Disable a specific RSE.

-
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-

Responses

Request samples 

curl --request DELETE \
-  --url http://undefinedundefined/rses/{rse} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Create RSE

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"Created"

Create RSE

Creates a RSE with all the metadata.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -2957,21 +2945,19 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

RSE not found

Request samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "continent": "string",
  • "time_zone": "string",
  • "ISP": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true
}

Response samples

Content type
application/json
"Created"

Get RSE

Get details about a specific RSE.

+

Request samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "continent": "string",
  • "time_zone": "string",
  • "ISP": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true
}

Response samples

Content type
application/json
"Created"

Disable RSE

Disable a specific RSE.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

-

Responses

Request samples 

curl --request GET \
+

Request samples 

curl --request DELETE \
   --url http://undefinedundefined/rses/{rse} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "continent": "string",
  • "time_zone": "string",
  • "ISP": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": 0,
  • "availability_write": 0,
  • "availability_delete": null
}

Update RSE

--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Update RSE

Update RSE properties.

Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

@@ -3009,7 +2995,21 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

Invalid Auth Token

Request samples

Content type
application/json
{
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true,
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "time_zone": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0
}

Response samples

Content type
application/json
"Created"

List RSEs

Request samples

Content type
application/json
{
  • "availability_read": true,
  • "availability_write": true,
  • "availability_delete": true,
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "time_zone": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0
}

Response samples

Content type
application/json
"Created"

Get RSE

Get details about a specific RSE.

+
Authorizations:
AuthToken
path Parameters
rse
required
string

The name of the Rucio Storage Element name.

+

Responses

Request samples 

curl --request GET \
+  --url http://undefinedundefined/rses/{rse} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
{
  • "deterministic": true,
  • "volatile": true,
  • "city": "string",
  • "staging_area": "string",
  • "region_code": "string",
  • "country_name": "string",
  • "continent": "string",
  • "time_zone": "string",
  • "ISP": "string",
  • "rse_type": "DISK",
  • "latitude": 0,
  • "longitude": 0,
  • "ASN": "string",
  • "availability": 0,
  • "availability_read": 0,
  • "availability_write": 0,
  • "availability_delete": null
}

List RSEs

Lists all RSEs.

Authorizations:
AuthToken
query Parameters
expression
string

RSE expression to select RSEs.

@@ -3033,31 +3033,31 @@

Error handling

" class="sc-dODueM sc-eHKghg fhLETC hIcgHh sc-enuJcz ibumEn">

No rule found for the given id

Request samples 

curl --request DELETE \
   --url http://undefinedundefined/rules/{rule_id} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Return a Rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string
--header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Update the replication rules parameters

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

-

Responses

Request samples 

curl --request GET \
-  --url http://undefinedundefined/rules/{rule_id} \
-  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"string"

Update the replication rules parameters

Authorizations:
AuthToken
path Parameters
rule_id
required
string

Request samples

Content type
application/json
{
  • "options": {
    }
}

Return a Rule

Authorizations:
AuthToken
path Parameters
rule_id
required
string

The id of the replication rule.

-
Request Body schema: application/json

Parameters for the new rule.

-
required
object

The parameters to change.

-

Responses

Request samples

Content type
application/json
{
  • "options": {
    }
}

Create a new replication rule

Authorizations:
AuthToken
Request Body schema: application/json
406

Not Acceptable

+

Request samples 

curl --request GET \
+  --url http://undefinedundefined/rules/{rule_id} \
+  --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
"string"

Create a new replication rule

Authorizations:
AuthToken
Request Body schema: application/json

Parameters for the new rule.

required
Array of objects

The list of data identifiers.

@@ -3249,7 +3249,7 @@

Error handling

--url http://undefinedundefined/scopes/{account}/scopes \ --header 'X-Rucio-Auth-Token: REPLACE_KEY_VALUE'

Response samples

Content type
application/json
[
  • "string"
]