コンテンツにスキップ
Authrim

Update region shard config

PUT
/api/admin/settings/region-shards
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/settings/region-shards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "totalShards": 16, "regionDistribution": { "iad": 50, "fra": 50 }, "groups": { "user_client": { "totalShards": 16, "members": [ "users", "clients" ], "description": "Keep users and clients colocated" } } }'

Updates region shard distribution and optional colocation groups, creating a new generation when the effective config changes.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
totalShards
required
integer
>= 1
regionDistribution
required
object
key
additional properties
number
groups
object
key
additional properties
object
totalShards
required
integer
>= 1
members
required
Array<string>
description
string
key
additional properties
key
additional properties
Example 
{
  "totalShards": 16,
  "regionDistribution": {
    "iad": 50,
    "fra": 50
  },
  "groups": {
    "user_client": {
      "totalShards": 16,
      "members": [
        "users",
        "clients"
      ],
      "description": "Keep users and clients colocated"
    }
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Region shard configuration updated.

Media type application/json
object
success
boolean
generationIncremented
boolean
currentGeneration
integer
currentTotalShards
integer
currentRegions
object
key
additional properties
previousGenerationsCount
integer
updatedAt
integer format: int64
version
integer
groups
object
key
additional properties
object
totalShards
required
integer
>= 1
members
required
Array<string>
description
string
name
string
validation
object
valid
boolean
errors
Array<string>
warnings
Array<string>
key
additional properties
note
string
key
additional properties
Example 
{
  "success": true,
  "generationIncremented": true,
  "currentGeneration": 2,
  "currentTotalShards": 16,
  "currentRegions": {
    "iad": {
      "start": 0,
      "end": 7
    },
    "fra": {
      "start": 8,
      "end": 15
    }
  },
  "previousGenerationsCount": 1,
  "updatedAt": 1770000000000,
  "version": 2,
  "groups": {
    "user_client": {
      "name": "user_client",
      "totalShards": 16,
      "members": [
        "users",
        "clients"
      ]
    }
  },
  "validation": {
    "valid": true,
    "errors": [],
    "warnings": []
  },
  "note": "New generation created. Existing resources will continue to use old config until they expire."
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}