Usage

Usage service handles licencing

Show usage

put

Retrieve a single usage

Path parameters

metricstringRequired

Usage metric

Example: Est hic voluptatem debitis.

Query parameters

accountIdentifierstringRequired

Account identifier

Example: Velit et.

Responses

200

OK response.

application/json

statusstringRequiredExample: Modi doloribus voluptas.

400

BadRequestError: Bad Request response.

application/vnd.goa.error

401

UnauthorizedError: Unauthorized response.

application/vnd.goa.error

403

ForbiddenError: Forbidden response.

application/vnd.goa.error

404

NotFoundError: Not Found response.

application/vnd.goa.error

408

TimeoutError: Request Timeout response.

application/vnd.goa.error

409

ConflictError: Conflict response.

application/vnd.goa.error

423

LockedError: Locked response.

application/vnd.goa.error

499

ContextCancelledError: response.

application/vnd.goa.error

500

InternalServerError: Internal Server Error response.

application/vnd.goa.error

502

BadGatewayError: Bad Gateway response.

application/vnd.goa.error

put/api/enforcement/client/usage/{metric}

PUT /api/enforcement/client/usage/{metric}?accountIdentifier=Velit+et. HTTP/1.1
Host: localhost:80
Accept: */*

{
  "data": {
    "ansible": {
      "uniqueHosts30d": 4067307001481856000
    },
    "count": 9181301836106756000
  },
  "status": "Vero similique quod molestiae a."
}

Show licence

get

Check whether the account is currently licenced

Header parameters

Harness-AccountstringRequired

Account identifier

Example: Voluptatum voluptatem sint.

Responses

200

OK response.

application/json

accountstring · min: 1 · max: 128Required

Account identifier

Example: m

isLicencedbooleanRequired

True when this account is currently licenced to execute apply operations

Example: false

isPaidbooleanRequired

True when this account is a paid account

Example: true

reasonstringOptional

If the account is not licenced, this is the reason why

Example: Maxime facere sint enim quam ad repellendus.

startTimeinteger · int64Required

The unix timestamp of the current period over which usage was calculated

Example: 8573895961321331000

totalinteger · int64Required

The total number of successful apply operations this account is licenced to perform

Example: 8750728927331978000

usedinteger · int64Required

The count of successful apply operations already performed

Example: 4307504862176186400

400

BadRequestError: Bad Request response.

application/vnd.goa.error

401

UnauthorizedError: Unauthorized response.

application/vnd.goa.error

403

ForbiddenError: Forbidden response.

application/vnd.goa.error

404

NotFoundError: Not Found response.

application/vnd.goa.error

408

TimeoutError: Request Timeout response.

application/vnd.goa.error

409

ConflictError: Conflict response.

application/vnd.goa.error

423

LockedError: Locked response.

application/vnd.goa.error

499

ContextCancelledError: response.

application/vnd.goa.error

500

InternalServerError: Internal Server Error response.

application/vnd.goa.error

502

BadGatewayError: Bad Gateway response.

application/vnd.goa.error

get/api/usage/check-licence

GET /api/usage/check-licence HTTP/1.1
Host: localhost:80
Harness-Account: Voluptatum voluptatem sint.
Accept: */*

{
  "account": "ssb",
  "ansible": {
    "total": 4998838773847544000,
    "used": 286535700307776160
  },
  "isLicenced": true,
  "isPaid": true,
  "reason": "Qui modi.",
  "startTime": 890492665697337700,
  "total": 6672047796945337000,
  "used": 6869223821422257000
}