Skip to content

Marketplace Site Agent Services

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/marketplace-site-agent-services/ List Marketplace Site Agent Services
GET /api/marketplace-site-agent-services/{uuid}/ Retrieve
Other Actions
POST /api/marketplace-site-agent-services/{uuid}/register_processor/ Register a new processor for the agent service
POST /api/marketplace-site-agent-services/{uuid}/set_statistics/ Update statistics for the agent service

Core CRUD

List Marketplace Site Agent Services

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-services/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_services import marketplace_site_agent_services_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_services_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: marketplace_site_agent_services_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { marketplaceSiteAgentServicesList } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentServicesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
identity_uuid string (uuid)
mode string
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
state array

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
url string (uri)
identity string (uuid)
identity_name string
name string
mode string
state any
statistics any
created string (date-time)
modified string (date-time)
processors array of objects
processors.uuid string (uuid)
processors.url string (uri)
processors.name string
processors.last_run string (date-time)
processors.backend_type string Type of the backend, for example SLURM.
processors.backend_version string
processors.created string (date-time)
processors.modified string (date-time)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/marketplace-site-agent-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.marketplace_site_agent_services import marketplace_site_agent_services_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = marketplace_site_agent_services_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: marketplace_site_agent_services_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { marketplaceSiteAgentServicesRetrieve } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentServicesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
url string (uri)
identity string (uuid)
identity_name string
name string
mode string
state any
statistics any
created string (date-time)
modified string (date-time)
processors array of objects
processors.uuid string (uuid)
processors.url string (uri)
processors.name string
processors.last_run string (date-time)
processors.backend_type string Type of the backend, for example SLURM.
processors.backend_version string
processors.created string (date-time)
processors.modified string (date-time)

Other Actions

Register a new processor for the agent service

Register a new processor for the agent service

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/register_processor/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-marketplace-site-agent-service" \
  backend_type="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.agent_processor_create_request import AgentProcessorCreateRequest # (1)
from waldur_api_client.api.marketplace_site_agent_services import marketplace_site_agent_services_register_processor # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AgentProcessorCreateRequest(
    name="my-awesome-marketplace-site-agent-service",
    backend_type="string-value"
)
response = marketplace_site_agent_services_register_processor.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AgentProcessorCreateRequest
  2. API Source: marketplace_site_agent_services_register_processor
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { marketplaceSiteAgentServicesRegisterProcessor } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentServicesRegisterProcessor({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-marketplace-site-agent-service",
    "backend_type": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
backend_type string ✓ Type of the backend, for example SLURM.
backend_version string

200 -

Field Type Description
uuid string (uuid)
url string (uri)
service string (uuid)
service_name string
name string
last_run string (date-time)
backend_type string Type of the backend, for example SLURM.
backend_version string
created string (date-time)
modified string (date-time)

201 -

Field Type Description
uuid string (uuid)
url string (uri)
service string (uuid)
service_name string
name string
last_run string (date-time)
backend_type string Type of the backend, for example SLURM.
backend_version string
created string (date-time)
modified string (date-time)

Update statistics for the agent service

Update statistics for the agent service

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/marketplace-site-agent-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/set_statistics/ \
  Authorization:"Token YOUR_API_TOKEN" \
  statistics=null

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.agent_service_statistics_request import AgentServiceStatisticsRequest # (1)
from waldur_api_client.api.marketplace_site_agent_services import marketplace_site_agent_services_set_statistics # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = AgentServiceStatisticsRequest(
    statistics=null
)
response = marketplace_site_agent_services_set_statistics.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: AgentServiceStatisticsRequest
  2. API Source: marketplace_site_agent_services_set_statistics
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { marketplaceSiteAgentServicesSetStatistics } from 'waldur-js-client';

try {
  const response = await marketplaceSiteAgentServicesSetStatistics({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "statistics": null
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
statistics any ✓ Statistics data to be stored for the service

200 -

Field Type Description
uuid string (uuid)
url string (uri)
identity string (uuid)
identity_name string
name string
mode string
state any
statistics any
created string (date-time)
modified string (date-time)
processors array of objects
processors.uuid string (uuid)
processors.url string (uri)
processors.name string
processors.last_run string (date-time)
processors.backend_type string Type of the backend, for example SLURM.
processors.backend_version string
processors.created string (date-time)
processors.modified string (date-time)