Skip to content

Service Usage API (1)

This API provides services to manage service usage.

Overview
Martin Ofner

martin.ofner@cdq.com

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/service-usage-api/api-v1/

Production SOAP

https://service-usage-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/soap/v1/

Production

https://service-usage-api.reverse-proxy.prod.k8s.production.cdq-cloud-engine.com/

Quotas

Categorizes endpoints related to the creation, retrieval, and management of quota allocations and usages.

Operations

Quotas Usage

Categorizes endpoints related to the management of quota usages.

Operations

Sets Quota Usage

Request

Sets quota usage for CUSTOM reset services. Used by e.g., STORAGE service.

Bodyapplication/jsonrequired
valuesArray of objects(QuotaUsageUpdateRequest)[ 1 .. 100 ] itemsrequired

List of quota usage update requests.

values[].​serviceobject(QuotaUsageServiceRequest)required

Request object for querying quota usage.

values[].​service.​technicalKeystring(DataSourceTechnicalKey)required

Technical key of the data source.

Example: "BR_RF"
values[].​service.​authoritystring(ServiceAuthority)

Authority like in istio (host).

Example: "api.cdq.com"
values[].​service.​methodstring(ServiceMethod)

Method like in istio.

Example: "GET"
values[].​service.​pathstring(ServicePath)

Path like in istio.

Example: "/api/v1/data"
values[].​organizationobject(QuotaUsageOrganizationRequest)required

Request object for querying quota usage.

values[].​organization.​idstring(OrganizationId)required

Uniquely identifying ID of the organization.

Example: "cdq_monitor"
values[].​workspaceobject(QuotaUsageWorkspaceRequest)

Request object for querying quota usage.

values[].​usageinteger(int64)(QuotaAmount)required

Defines the amount of the quota.

Example: "20000"
curl -i -X PUT \
  https://idp.cdq.com/_mock/apis/service-usage-api/api-v1/quotas/usage \
  -H 'Content-Type: application/json' \
  -d '{
    "values": [
      {
        "service": {
          "technicalKey": "BR_RF",
          "authority": "api.cdq.com",
          "method": "GET",
          "path": "/api/v1/data"
        },
        "organization": {
          "id": "cdq_monitor"
        },
        "workspace": {
          "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
        },
        "usage": "20000"
      }
    ]
  }'

Responses

successful operation

Bodyapplication/json
valuesArray of objects(QuotaUsageUpdateResult)

List of quota usage update results.

Response
application/json
{
  "values": [
    { … }
  ]
}