Cadence Domain Rate Limits V2

Operations related to Cadence per-frontend-instance domain request-rate limits.

Create Cadence domain request rate limits

Creates a per-frontend-instance Cadence domain request-rate-limit rule set for a cluster. Fails if an active rule set already exists.

SecurityBasic Authentication
Request
Request Body schema: application/json
required
clusterId
required
string <uuid>

ID of the Cadence cluster.

defaultRequestsPerSecond
integer <int32> >= 1

Requests per second for all domains without a domain-specific limit. Written as the final unconstrained Cadence rule.

Array of objects (CadenceDomainRateLimitSummaryV2) <= 999 items

Per-frontend-instance domain request rate limits.

Responses
202

Cadence domain request rate limits accepted for application.

400

Invalid Cadence domain rate-limit request or cluster state.

403

The account does not have permission to edit cluster settings.

404

Cadence cluster not found.

409

Cadence domain rate limits already exist for this cluster.

post/cluster-management/v2/resources/applications/cadence/domain-rate-limits/v2
Request samples
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "defaultRequestsPerSecond": 250,
  • "domainRateLimits": [
    ],
  • "id": "b997a00d-5bd4-4774-9bd7-5c0ad6189246"
}
Response samples
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "defaultRequestsPerSecond": 250,
  • "domainRateLimits": [
    ],
  • "id": "b997a00d-5bd4-4774-9bd7-5c0ad6189246"
}

Get Cadence domain request rate limits

Gets the latest active per-frontend-instance Cadence domain request-rate-limit rule set for a cluster.

SecurityBasic Authentication
Request
path Parameters
id
required
string

ID of the target Cadence cluster and domain request-rate-limits resource.

Responses
200

Successfully retrieved Cadence domain request rate limits.

400

The cluster is not a Cadence cluster.

403

The account does not have permission to view cluster settings.

404

Cadence cluster or domain rate limits not found.

get/cluster-management/v2/resources/applications/cadence/domain-rate-limits/v2/{id}
Request samples
Response samples
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "defaultRequestsPerSecond": 250,
  • "domainRateLimits": [
    ]
}

Create or replace Cadence domain request rate limits

Creates a per-frontend-instance Cadence domain request-rate-limit rule set that supersedes prior active rule sets for the cluster.

SecurityBasic Authentication
Request
path Parameters
id
required
string

ID of the target Cadence cluster and domain request-rate-limits resource.

Request Body schema: application/json
required
defaultRequestsPerSecond
integer <int32> >= 1

Requests per second for all domains without a domain-specific limit. Written as the final unconstrained Cadence rule.

Array of objects (CadenceDomainRateLimitSummaryV2) <= 999 items

One per-frontend-instance request rate limit per Cadence domain. Supersedes the entire prior active rule set.

Responses
202

Cadence domain request rate limits accepted for application.

400

Invalid Cadence domain rate-limit request or cluster state.

403

The account does not have permission to edit cluster settings.

404

Cadence cluster not found.

put/cluster-management/v2/resources/applications/cadence/domain-rate-limits/v2/{id}
Request samples
application/json
{
  • "defaultRequestsPerSecond": 1,
  • "domainRateLimits": [
    ]
}
Response samples
application/json
{
  • "clusterId": "b997a00d-5bd4-4774-9bd7-5c0ad6189246",
  • "defaultRequestsPerSecond": 250,
  • "domainRateLimits": [
    ]
}

Delete Cadence domain request rate limits

Deletes all active per-frontend-instance Cadence domain request-rate-limit rule sets for a cluster.

SecurityBasic Authentication
Request
path Parameters
id
required
string

ID of the target Cadence cluster and domain request-rate-limits resource.

Responses
204

Cadence domain request rate limits deleted successfully.

400

This cluster is currently unable to delete Cadence domain rate limits.

403

The account does not have permission to edit cluster settings.

404

Cadence cluster or domain rate limits not found.

delete/cluster-management/v2/resources/applications/cadence/domain-rate-limits/v2/{id}
Request samples
Response samples
application/json
{
  • "name": "string",
  • "message": "string"
}