From 6b2643632a27d1879ff24c1c80d097c279b23b30 Mon Sep 17 00:00:00 2001 From: vbotbuildovich <62446873+vbotbuildovich@users.noreply.github.com> Date: Thu, 21 Aug 2025 22:52:16 +0000 Subject: [PATCH 1/2] auto-docs: Update Cloud API spec --- cloud-controlplane/cloud-controlplane.yaml | 97 +- cloud-controlplane/x-topics/cloud-regions.md | 901 ++++++++++++- cloud-dataplane/cloud-dataplane.yaml | 1218 ++++++++++++++++-- 3 files changed, 2092 insertions(+), 124 deletions(-) diff --git a/cloud-controlplane/cloud-controlplane.yaml b/cloud-controlplane/cloud-controlplane.yaml index da8e725..75d800d 100644 --- a/cloud-controlplane/cloud-controlplane.yaml +++ b/cloud-controlplane/cloud-controlplane.yaml @@ -315,12 +315,6 @@ components: id: description: ID of the cluster. ID is an output from the Create Cluster endpoint and cannot be set by the caller. type: string - internet_gateways: - description: InternetGateway information of the cluster. - items: - type: string - readOnly: true - type: array kafka_api: $ref: '#/components/schemas/Cluster.KafkaAPI' kafka_connect: @@ -331,6 +325,12 @@ components: description: Unique name of the cluster. example: development-cluster type: string + nat_gateways: + description: NAT gateway information for the cluster. + items: + type: string + readOnly: true + type: array network_id: description: Network ID where cluster is placed. example: cjcuq79c4vs94fcufc2g @@ -2096,6 +2096,8 @@ components: id: title: internal id of the organization type: string + mfa_enforced: + type: boolean name: title: display name of the organization type: string @@ -2103,6 +2105,11 @@ components: nullable: true type: string type: object + OrganizationUpdate: + properties: + mfa_enforced: + type: boolean + type: object Placement: description: Information about creation of new serverless clusters on the serverless region. properties: @@ -2656,6 +2663,17 @@ components: description: The unique name of the service_account. example: billing_admin type: string + role_bindings: + items: + $ref: '#/components/schemas/ServiceAccountCreate.RoleBinding' + type: array + type: object + ServiceAccountCreate.RoleBinding: + properties: + role_name: + type: string + scope: + $ref: '#/components/schemas/Scope' type: object ServiceAccountCredentials: properties: @@ -2791,6 +2809,11 @@ components: enum: - UPDATE_CLUSTER_TYPE_CUSTOMER_CONFIG type: string + UpdateOrganizationResponse: + properties: + organization: + $ref: '#/components/schemas/Organization' + type: object UpdateResourceGroupBody: properties: resource_group: @@ -3232,7 +3255,7 @@ components: x-client-id: dQjapNIAHhF7EQqQToRla3yEII9sUSap type: oauth2 info: - description: 'Use the Control Plane API to manage resources in your Redpanda Cloud organization such as clusters and networks.' + description: The Redpanda Cloud Control Plane API allows programmatic management of Redpanda Cloud resources including clusters, networks, and resource groups. title: Redpanda Cloud Control Plane API version: v1 openapi: 3.0.3 @@ -3309,7 +3332,6 @@ paths: sasl: null url: https://pandaproxy-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092 id: cjd3r21c4vs870t0ku30 - internet_gateways: [] kafka_api: all_seed_brokers: null mtls: null @@ -3319,6 +3341,7 @@ paths: kafka_connect: null maintenance_window_config: null name: my-new-cluster + nat_gateways: [] network_id: cjb69k1c4vs45df9bee0 prometheus: url: https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics @@ -3360,7 +3383,7 @@ paths: tags: - Clusters post: - description: Create a Redpanda cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. Refer to [Regions](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster). + description: Create a Redpanda cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/). To check operation state, call `GET /v1/operations/{id}`. Refer to [Regions](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) for the list of available regions, zones, and tiers combinations for each cloud provider. For BYOC clusters, follow additional steps to [create a BYOC cluster](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-byoc-controlplane-api/#additional-steps-to-create-a-byoc-cluster). operationId: ClusterService_CreateCluster requestBody: content: @@ -3568,7 +3591,7 @@ paths: - Clusters /v1/clusters/{id}: delete: - description: Delete a Redpanda Cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. + description: Delete a Redpanda Cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/). To check operation state, call `GET /v1/operations/{id}`. operationId: ClusterService_DeleteCluster parameters: - in: path @@ -3644,7 +3667,6 @@ paths: sasl: null url: https://pandaproxy-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com:9092 id: cjd3r21c4vs870t0ku30 - internet_gateways: [] kafka_api: all_seed_brokers: null mtls: null @@ -3654,6 +3676,7 @@ paths: kafka_connect: null maintenance_window_config: null name: my-new-cluster + nat_gateways: [] network_id: cjb69k1c4vs45df9bee0 prometheus: url: https://console-aa0000l0.cjd3r21c4vs870t0ku30.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics @@ -3701,7 +3724,7 @@ paths: - Clusters /v1/networks: get: - description: List Redpanda Networks. + description: List Redpanda networks. operationId: NetworkService_ListNetworks parameters: - description: Resource group ID. @@ -3773,7 +3796,7 @@ paths: tags: - Networks post: - description: Create a Redpanda network. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state. + description: Create a Redpanda network. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/). To check operation state, call `GET /v1/operations/{id}`. operationId: NetworkService_CreateNetwork requestBody: content: @@ -4039,7 +4062,6 @@ paths: sasl: null url: https://pandaproxy-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092 id: cjb69h1c4vs42pca89s0 - internet_gateways: [] kafka_api: all_seed_brokers: null mtls: null @@ -4049,6 +4071,7 @@ paths: kafka_connect: null maintenance_window_config: null name: my-new-cluster + nat_gateways: [] network_id: cjb69k1c4vs45df9bee0 prometheus: url: https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics @@ -4164,7 +4187,6 @@ paths: sasl: null url: https://pandaproxy-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com:9092 id: cjb69h1c4vs42pca89s0 - internet_gateways: [] kafka_api: all_seed_brokers: null mtls: null @@ -4174,6 +4196,7 @@ paths: kafka_connect: null maintenance_window_config: null name: my-new-cluster + nat_gateways: [] network_id: cjb69k1c4vs45df9bee0 prometheus: url: https://console-aa0000l0.cjb69h1c4vs42pca89s0.fmc.prd.cloud.redpanda.com/api/cloud/prometheus/public_metrics @@ -4263,7 +4286,7 @@ paths: - Organization /v1/organizations/current: get: - description: Get current organizarion information + description: Get information about the current organization. operationId: OrganizationService_GetCurrentOrganization responses: "200": @@ -4287,9 +4310,41 @@ paths: summary: Get current organization tags: - Organization + patch: + description: Update properties of the current organization. + operationId: OrganizationService_UpdateOrganization + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrganizationUpdate' + required: true + x-originalParamName: organization + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateOrganizationResponse' + description: OK + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Please reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: Update organization + tags: + - Organization /v1/regions/{cloud_provider}: get: - description: List available regions on the different cloud providers + description: List available regions on the different cloud providers. operationId: RegionService_ListRegions parameters: - in: path @@ -4437,7 +4492,7 @@ paths: tags: - Resource Groups post: - description: Create a Redpanda Resource Group. + description: Create a Redpanda resource group. operationId: ResourceGroupService_CreateResourceGroup requestBody: content: @@ -4838,7 +4893,7 @@ paths: tags: - Serverless Clusters post: - description: Create a Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`. + description: Create a Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`. operationId: ServerlessClusterService_CreateServerlessCluster requestBody: content: @@ -4884,7 +4939,7 @@ paths: - Serverless Clusters /v1/serverless/clusters/{id}: delete: - description: Delete Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`. + description: Delete Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`. operationId: ServerlessClusterService_DeleteServerlessCluster parameters: - description: ID of Serverless cluster. @@ -5617,7 +5672,7 @@ servers: - description: Control Plane API url: https://api.redpanda.com tags: - - description: Check the state of long-running operations. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. + - description: Check the state of long-running operations. name: Operations - description: Manage Redpanda Cloud clusters. For detailed steps and information, see [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/). name: Clusters diff --git a/cloud-controlplane/x-topics/cloud-regions.md b/cloud-controlplane/x-topics/cloud-regions.md index c9fdf68..cd434fd 100644 --- a/cloud-controlplane/x-topics/cloud-regions.md +++ b/cloud-controlplane/x-topics/cloud-regions.md @@ -1,5 +1,900 @@ + + + Usage tiers define the sizing of a cluster and provide tested and guaranteed workload configurations for throughput, logical partitions, and connections. Availability depends on the region and the cluster type (BYOC, Dedicated). See [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/) and [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/) for further details. -

GCP

RegionZonesThroughput Tiers
europe-west9europe-west9-a,europe-west9-b,europe-west9-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-southwest1europe-southwest1-a,europe-southwest1-b,europe-southwest1-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
southamerica-west1southamerica-west1-btier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-east1asia-east1-a,asia-east1-b,asia-east1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-northeast1asia-northeast1-a,asia-northeast1-b,asia-northeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-south1asia-south1-a,asia-south1-b,asia-south1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
asia-southeast1asia-southeast1-a,asia-southeast1-b,asia-southeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
australia-southeast1australia-southeast1-a,australia-southeast1-b,australia-southeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west1europe-west1-b,europe-west1-c,europe-west1-dtier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west2europe-west2-a,europe-west2-b,europe-west2-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
europe-west3europe-west3-a,europe-west3-b,europe-west3-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: Dedicated, BYOC
tier-7-gcp-v2-x86: Dedicated, BYOC
tier-8-gcp-v2-x86: Dedicated, BYOC
tier-9-gcp-v2-x86: Dedicated, BYOC
europe-west4europe-west4-a,europe-west4-b,europe-west4-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
northamerica-northeast1northamerica-northeast1-a,northamerica-northeast1-b,northamerica-northeast1-ctier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
southamerica-east1southamerica-east1-b,southamerica-east1-c,southamerica-east1-atier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-central1us-central1-a,us-central1-b,us-central1-c,us-central1-ftier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-east1us-east1-b,us-east1-c,us-east1-dtier-1-gcp-v2-x86: Dedicated, BYOC
tier-2-gcp-v2-x86: Dedicated, BYOC
tier-3-gcp-v2-x86: Dedicated, BYOC
tier-4-gcp-v2-x86: Dedicated, BYOC
tier-5-gcp-v2-x86: Dedicated, BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-east4us-east4-a,us-east4-b,us-east4-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC
us-west1us-west1-a,us-west1-b,us-west1-ctier-1-gcp-v2-x86: BYOC
tier-2-gcp-v2-x86: BYOC
tier-3-gcp-v2-x86: BYOC
tier-4-gcp-v2-x86: BYOC
tier-5-gcp-v2-x86: BYOC
tier-6-gcp-v2-x86: BYOC
tier-7-gcp-v2-x86: BYOC
tier-8-gcp-v2-x86: BYOC
tier-9-gcp-v2-x86: BYOC

AWS

-
RegionZonesThroughput Tiers
ap-southeast-3apse3-az1,apse3-az2,apse3-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
eu-north-1eun1-az1,eun1-az2,eun1-az3tier-1-aws-v3-arm: BYOC
tier-2-aws-v3-arm: BYOC
tier-3-aws-v3-arm: BYOC
tier-4-aws-v3-arm: BYOC
tier-5-aws-v3-arm: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v3-arm: BYOC
eu-south-1eus1-az1,eus1-az2,eus1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
eu-west-3euw3-az1,euw3-az2,euw3-az3tier-1-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-6-aws-v2-arm: Dedicated, BYOC
tier-7-aws-v2-arm: Dedicated, BYOC
tier-8-aws-v2-arm: Dedicated, BYOC
tier-9-aws-v2-arm: Dedicated, BYOC
ap-east-1ape1-az1,ape1-az2,ape1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
ap-northeast-1apne1-az4,apne1-az1,apne1-az2tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
af-south-1afs1-az1,afs1-az2,afs1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
ap-south-1aps1-az1,aps1-az2,aps1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ap-southeast-1apse1-az1,apse1-az2,apse1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ap-southeast-2apse2-az1,apse2-az3,apse2-az2tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
ca-central-1cac1-az1,cac1-az2,cac1-az4tier-1-aws-v2-arm: Dedicated, BYOC
tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-arm: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-arm: BYOC
tier-9-aws-v2-x86: BYOC
eu-central-1euc1-az2,euc1-az3,euc1-az1tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
eu-west-1euw1-az1,euw1-az2,euw1-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
eu-west-2euw2-az1,euw2-az2,euw2-az3tier-1-aws-v2-arm: Dedicated, BYOC
tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-arm: Dedicated, BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-arm: Dedicated, BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-arm: Dedicated, BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-arm: Dedicated, BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-arm: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-arm: BYOC
tier-9-aws-v2-x86: BYOC
me-central-1mec1-az1,mec1-az2,mec1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
sa-east-1sae1-az1,sae1-az2,sae1-az3tier-1-aws-v2-x86: BYOC
tier-2-aws-v2-x86: BYOC
tier-3-aws-v2-x86: BYOC
tier-4-aws-v2-x86: BYOC
tier-5-aws-v2-x86: BYOC
tier-6-aws-v2-x86: BYOC
tier-7-aws-v2-x86: BYOC
tier-8-aws-v2-x86: BYOC
tier-9-aws-v2-x86: BYOC
us-east-1use1-az2,use1-az4,use1-az5,use1-az6tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
us-east-2use2-az1,use2-az2,use2-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC
us-west-2usw2-az1,usw2-az2,usw2-az3tier-1-aws-v2-x86: BYOC
tier-1-aws-v3-arm: BYOC, Dedicated
tier-2-aws-v2-x86: BYOC
tier-2-aws-v3-arm: BYOC, Dedicated
tier-3-aws-v2-x86: BYOC
tier-3-aws-v3-arm: BYOC, Dedicated
tier-4-aws-v2-x86: BYOC
tier-4-aws-v3-arm: BYOC, Dedicated
tier-5-aws-v2-x86: BYOC
tier-5-aws-v3-arm: BYOC, Dedicated
tier-6-aws-v2-x86: BYOC
tier-6-aws-v3-arm: BYOC
tier-7-aws-v2-x86: BYOC
tier-7-aws-v3-arm: BYOC
tier-8-aws-v2-x86: BYOC
tier-8-aws-v3-arm: BYOC
tier-9-aws-v2-x86: BYOC
tier-9-aws-v3-arm: BYOC

AZURE

-
RegionZonesThroughput Tiers
eastuseastus-az1,eastus-az2,eastus-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
uksouthuksouth-az1,uksouth-az2,uksouth-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
norwayeastnorwayeast-az1,norwayeast-az2,norwayeast-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
centraluscentralus-az1,centralus-az2,centralus-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
eastus2eastus2-az1,eastus2-az2,eastus2-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
northeuropenortheurope-az1,northeurope-az2,northeurope-az3tier-1-azure-v3-x86: Dedicated, BYOC
tier-2-azure-v3-x86: Dedicated, BYOC
tier-3-azure-v3-x86: Dedicated, BYOC
tier-4-azure-v3-x86: Dedicated, BYOC
tier-5-azure-v3-x86: Dedicated, BYOC
westeuropewesteurope-az1,westeurope-az2,westeurope-az3tier-1-azure-v3-x86: BYOC
tier-2-azure-v3-x86: BYOC
tier-3-azure-v3-x86: BYOC
tier-4-azure-v3-x86: BYOC
tier-5-azure-v3-x86: BYOC
westus2westus2-az1,westus2-az2,westus2-az3tier-1-azure-v3-x86: BYOC
tier-2-azure-v3-x86: BYOC
tier-3-azure-v3-x86: BYOC
tier-4-azure-v3-x86: BYOC
tier-5-azure-v3-x86: BYOC
\ No newline at end of file + +

GCP

+
Regions for GCP +

Table of cloud regions and throughput tiers for GCP. Use the table headers for more information.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RegionZonesThroughput Tiers
asia-east1asia-east1-a,asia-east1-b,asia-east1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
asia-northeast1asia-northeast1-a,asia-northeast1-b,asia-northeast1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
asia-south1asia-south1-a,asia-south1-b,asia-south1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
asia-southeast1asia-southeast1-a,asia-southeast1-b,asia-southeast1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
australia-southeast1australia-southeast1-a,australia-southeast1-b,australia-southeast1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
europe-southwest1europe-southwest1-a,europe-southwest1-b,europe-southwest1-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
europe-west1europe-west1-b,europe-west1-c,europe-west1-d +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
europe-west2europe-west2-a,europe-west2-b,europe-west2-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
europe-west3europe-west3-a,europe-west3-b,europe-west3-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-7-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-8-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-9-gcp-v2-x86: BYOC, Dedicated
  • +
+
europe-west4europe-west4-a,europe-west4-b,europe-west4-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
europe-west9europe-west9-a,europe-west9-b,europe-west9-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
northamerica-northeast1northamerica-northeast1-a,northamerica-northeast1-b,northamerica-northeast1-c +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
southamerica-east1southamerica-east1-b,southamerica-east1-c,southamerica-east1-a +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
southamerica-west1southamerica-west1-b +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
us-central1us-central1-a,us-central1-b,us-central1-c,us-central1-f +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
us-east1us-east1-b,us-east1-c,us-east1-d +
    +
  • tier-1-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-2-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-3-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-4-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-5-gcp-v2-x86: BYOC, Dedicated
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
us-east4us-east4-a,us-east4-b,us-east4-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
us-west1us-west1-a,us-west1-b,us-west1-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
us-west2us-west2-a,us-west2-b,us-west2-c +
    +
  • tier-1-gcp-v2-x86: BYOC
  • +
  • tier-2-gcp-v2-x86: BYOC
  • +
  • tier-3-gcp-v2-x86: BYOC
  • +
  • tier-4-gcp-v2-x86: BYOC
  • +
  • tier-5-gcp-v2-x86: BYOC
  • +
  • tier-6-gcp-v2-x86: BYOC
  • +
  • tier-7-gcp-v2-x86: BYOC
  • +
  • tier-8-gcp-v2-x86: BYOC
  • +
  • tier-9-gcp-v2-x86: BYOC
  • +
+
+ +
+

AWS

+
Regions for AWS +

Table of cloud regions and throughput tiers for AWS. Use the table headers for more information.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RegionZonesThroughput Tiers
af-south-1afs1-az1,afs1-az2,afs1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
ap-east-1ape1-az1,ape1-az2,ape1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
ap-northeast-1apne1-az4,apne1-az1,apne1-az2 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
ap-south-1aps1-az1,aps1-az2,aps1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
ap-southeast-1apse1-az1,apse1-az2,apse1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
ap-southeast-2apse2-az1,apse2-az3,apse2-az2 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
ap-southeast-3apse3-az1,apse3-az2,apse3-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
ca-central-1cac1-az1,cac1-az2,cac1-az4 +
    +
  • tier-1-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-arm: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
eu-central-1euc1-az2,euc1-az3,euc1-az1 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
eu-north-1eun1-az1,eun1-az2,eun1-az3 +
    +
  • tier-1-aws-v3-arm: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
eu-south-1eus1-az1,eus1-az2,eus1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
eu-west-1euw1-az1,euw1-az2,euw1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
eu-west-2euw2-az1,euw2-az2,euw2-az3 +
    +
  • tier-1-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-arm: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
eu-west-3euw3-az1,euw3-az2,euw3-az3 +
    +
  • tier-1-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-7-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-8-aws-v2-arm: BYOC, Dedicated
  • +
  • tier-9-aws-v2-arm: BYOC, Dedicated
  • +
+
me-central-1mec1-az1,mec1-az2,mec1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
sa-east-1sae1-az1,sae1-az2,sae1-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
+
us-east-1use1-az1,use1-az2,use1-az4,use1-az5,use1-az6 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
us-east-2use2-az1,use2-az2,use2-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
us-west-2usw2-az1,usw2-az2,usw2-az3 +
    +
  • tier-1-aws-v2-x86: BYOC
  • +
  • tier-1-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-2-aws-v2-x86: BYOC
  • +
  • tier-2-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-3-aws-v2-x86: BYOC
  • +
  • tier-3-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-4-aws-v2-x86: BYOC
  • +
  • tier-4-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-5-aws-v2-x86: BYOC
  • +
  • tier-5-aws-v3-arm: BYOC, Dedicated
  • +
  • tier-6-aws-v2-x86: BYOC
  • +
  • tier-6-aws-v3-arm: BYOC
  • +
  • tier-7-aws-v2-x86: BYOC
  • +
  • tier-7-aws-v3-arm: BYOC
  • +
  • tier-8-aws-v2-x86: BYOC
  • +
  • tier-8-aws-v3-arm: BYOC
  • +
  • tier-9-aws-v2-x86: BYOC
  • +
  • tier-9-aws-v3-arm: BYOC
  • +
+
+ +
+

Azure

+
Regions for Azure +

Table of cloud regions and throughput tiers for Azure. Use the table headers for more information.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RegionZonesThroughput Tiers
centraluscentralus-az1,centralus-az2,centralus-az3 +
    +
  • tier-1-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-2-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-3-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-4-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-5-azure-v3-x86: BYOC, Dedicated
  • +
+
eastuseastus-az1,eastus-az2,eastus-az3 +
    +
  • tier-1-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-2-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-3-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-4-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-5-azure-v3-x86: BYOC, Dedicated
  • +
+
eastus2eastus2-az1,eastus2-az2,eastus2-az3 +
    +
  • tier-1-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-2-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-3-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-4-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-5-azure-v3-x86: BYOC, Dedicated
  • +
+
northeuropenortheurope-az1,northeurope-az2,northeurope-az3 +
    +
  • tier-1-azure-v3-x86: BYOC
  • +
  • tier-2-azure-v3-x86: BYOC
  • +
  • tier-3-azure-v3-x86: BYOC
  • +
  • tier-4-azure-v3-x86: BYOC
  • +
  • tier-5-azure-v3-x86: BYOC
  • +
+
norwayeastnorwayeast-az1,norwayeast-az2,norwayeast-az3 +
    +
  • tier-1-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-2-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-3-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-4-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-5-azure-v3-x86: BYOC, Dedicated
  • +
+
uksouthuksouth-az1,uksouth-az2,uksouth-az3 +
    +
  • tier-1-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-2-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-3-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-4-azure-v3-x86: BYOC, Dedicated
  • +
  • tier-5-azure-v3-x86: BYOC, Dedicated
  • +
+
westeuropewesteurope-az1,westeurope-az2,westeurope-az3 +
    +
  • tier-1-azure-v3-x86: BYOC
  • +
  • tier-2-azure-v3-x86: BYOC
  • +
  • tier-3-azure-v3-x86: BYOC
  • +
  • tier-4-azure-v3-x86: BYOC
  • +
  • tier-5-azure-v3-x86: BYOC
  • +
+
westus2westus2-az1,westus2-az2,westus2-az3 +
    +
  • tier-1-azure-v3-x86: BYOC
  • +
  • tier-2-azure-v3-x86: BYOC
  • +
  • tier-3-azure-v3-x86: BYOC
  • +
  • tier-4-azure-v3-x86: BYOC
  • +
  • tier-5-azure-v3-x86: BYOC
  • +
+
+ +
diff --git a/cloud-dataplane/cloud-dataplane.yaml b/cloud-dataplane/cloud-dataplane.yaml index 735b868..e7de945 100644 --- a/cloud-dataplane/cloud-dataplane.yaml +++ b/cloud-dataplane/cloud-dataplane.yaml @@ -84,6 +84,45 @@ components: type: array title: BadRequest type: object + BatchDeleteQuotaRequest: + properties: + deletions: + items: + $ref: '#/components/schemas/QuotaDeletion' + type: array + type: object + BatchDeleteQuotaResponse: + properties: + failed_entities: + items: + $ref: '#/components/schemas/FailedEntity' + type: array + successful_entities: + items: + $ref: '#/components/schemas/SuccessfulEntity' + type: array + type: object + BatchSetQuotaRequest: + properties: + settings: + description: |- + A list of quota settings to apply. Each setting pairs an entity + with the specific values to be set for it. + items: + $ref: '#/components/schemas/QuotaSetting' + type: array + type: object + BatchSetQuotaResponse: + properties: + failed_entities: + items: + $ref: '#/components/schemas/FailedEntity' + type: array + successful_entities: + items: + $ref: '#/components/schemas/SuccessfulEntity' + type: array + type: object Config: properties: name: @@ -173,7 +212,7 @@ components: info: $ref: '#/components/schemas/ConnectCluster.Info' name: - description: Unique name of Connect cluster. For Redpanda Cloud, the value is `redpanda`. + description: Unique name of connect cluster. For Redpanda Cloud, the value is `redpanda`. type: string plugins: items: @@ -388,6 +427,12 @@ components: pipeline: $ref: '#/components/schemas/Pipeline' type: object + CreateRoleResponse: + description: CreateRoleResponse is the response for CreateRole. + properties: + role: + $ref: '#/components/schemas/Role' + type: object CreateSecretRequest: description: CreateSecretRequest is the request of CreateSecret. properties: @@ -545,6 +590,18 @@ components: type: object DeletePipelineResponse: type: object + DeleteQuotaRequest: + properties: + entity: + $ref: '#/components/schemas/RequestQuotaEntity' + value_type: + $ref: '#/components/schemas/ValueType' + type: object + DeleteQuotaResponse: + type: object + DeleteRoleResponse: + description: DeleteRoleResponse is the response for DeleteRole. + type: object DeleteSecretResponse: description: DeleteSecretResponse is the response of DeleteSecret. type: object @@ -583,6 +640,25 @@ components: - input_topic_name - output_topic_names type: object + Entity: + properties: + entity_name: + type: string + entity_type: + $ref: '#/components/schemas/EntityType' + type: object + EntityType: + description: |- + The type of entity that the quota applies to. + + - ENTITY_TYPE_USER: Not supported in Redpanda + - ENTITY_TYPE_IP: Not supported in Redpanda + enum: + - ENTITY_TYPE_CLIENT_ID + - ENTITY_TYPE_CLIENT_ID_PREFIX + - ENTITY_TYPE_USER + - ENTITY_TYPE_IP + type: string EnvironmentVariable: properties: key: @@ -639,11 +715,12 @@ components: description: |- Additional structured details about this error. - Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in + Keys must match a regular expression of `[a-z][a-zA-Z0-9-_]+` but should + ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than - {"instanceLimit": "100/request"}, should be returned as, - {"instanceLimitPerRequest": "100"}, if the client exceeds the number of + `{"instanceLimit": "100/request"}`, should be returned as, + `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request. type: object reason: @@ -656,6 +733,18 @@ components: type: string title: ErrorInfo type: object + FailedEntity: + properties: + entity_name: + type: string + entity_type: + $ref: '#/components/schemas/EntityType' + error_code: + format: int32 + type: integer + error_message: + type: string + type: object FieldViolation: description: A message type used to describe a single bad request field. properties: @@ -702,6 +791,17 @@ components: * `emailAddresses[3].type[2]` for a violation in the second `type` value in the third `emailAddresses` message. type: string + localized_message: + $ref: '#/components/schemas/LocalizedMessage' + reason: + description: |- + The reason of the field-level error. This is a constant value that + identifies the proximate cause of the field-level error. It should + uniquely identify the type of the FieldViolation within the scope of the + google.rpc.ErrorInfo.domain. This should be at most 63 + characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, + which represents UPPER_SNAKE_CASE. + type: string type: object GetConnectClusterResponse: properties: @@ -759,6 +859,17 @@ components: pipelines_for_secret: $ref: '#/components/schemas/PipelinesForSecret' type: object + GetRoleResponse: + description: GetRoleResponse is the response to GetRole. + properties: + members: + description: Members assigned to the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + role: + $ref: '#/components/schemas/Role' + type: object GetSecretResponse: description: GetSecretResponse is the response of GetSecret. properties: @@ -802,6 +913,43 @@ components: description: The URL of the link. type: string type: object + LintHint: + description: LintHint is a generic linting hint. + properties: + column: + description: Column number of the lint. + format: int32 + type: integer + hint: + description: The hint message. + type: string + line: + description: Line number of the lint. + format: int32 + type: integer + lint_type: + description: Optional lint type or enum. + type: string + type: object + LintPipelineConfigRequest: + properties: + config_yaml: + description: |- + The Redpanda Connect pipeline configuration in YAML format. + See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation + for more details. + type: string + required: + - config_yaml + type: object + LintPipelineConfigResponse: + properties: + lint_hints: + description: A list of linting issues. + items: + $ref: '#/components/schemas/LintHint' + type: array + type: object ListACLsRequest.Filter: properties: host: @@ -891,12 +1039,12 @@ components: ListPipelinesRequest.Filter: properties: name_contains: - description: Substring match on pipeline name. Case-sensitive. + description: Any pipelines that partially match this name will be returned. type: string tags[string]: additionalProperties: type: string - description: Filter pipelines that contain all of these key/value pairs. + description: Pipelines that match all the provided tags will be returned. type: object type: object ListPipelinesResponse: @@ -908,6 +1056,74 @@ components: $ref: '#/components/schemas/Pipeline' type: array type: object + ListQuotasRequest.Filter: + properties: + entity_name: + description: Filter by entity name. If unspecified will return all entities for specified entity type. + type: string + entity_type: + $ref: '#/components/schemas/EntityType' + match_default: + description: If true, the entity_name will match the default entity (e.g., default client-id). + type: boolean + type: object + ListQuotasResponse: + properties: + page_token: + description: Token to retrieve the next page of results. If empty, there are no more results. + type: string + quotas: + items: + $ref: '#/components/schemas/QuotaEntry' + type: array + type: object + ListRoleMembersRequest.Filter: + description: Filter options. + properties: + name_contains: + description: Filter results to only members with names which contain the string. + type: string + type: object + ListRoleMembersResponse: + description: ListRoleMembersResponse is the response for ListRoleMembers. + properties: + members: + description: Members assigned to the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + next_page_token: + description: Token to retrieve the next page. + type: string + role_name: + description: The role name. + type: string + type: object + ListRolesRequest.Filter: + description: Filter options. + properties: + name_contains: + description: Filter results to only roles with names which contain the string. + type: string + name_prefix: + description: Filter results only roles named with the prefix. + type: string + principal: + description: Return only roles assigned to this principal. + type: string + type: object + ListRolesResponse: + description: ListRolesResponse is the response for ListRoles. + properties: + next_page_token: + description: Token to retrieve the next page. + type: string + roles: + description: The roles in the system. + items: + $ref: '#/components/schemas/Role' + type: array + type: object ListSecretScopesResponse: description: ListSecretScopesResponse is the response of ListSecretScopes. properties: @@ -1020,6 +1236,21 @@ components: description: Username. type: string type: object + LocalizedMessage: + description: |- + Provides a localized error message that is safe to return to the user + which can be attached to an RPC error. + properties: + locale: + title: |- + The locale used following the specification defined at + https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + Examples are: "en-US", "fr-CH", "es-MX" + type: string + message: + description: The localized error message in the above locale. + type: string + type: object MatchingACL: properties: error: @@ -1149,7 +1380,7 @@ components: description: Defines the pipeline resource. properties: config_yaml: - description: The Repanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. + description: The Redpanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. title: |- The pipeline configuration in YAML. See https://docs.redpanda.com/redpanda-connect/configuration/about/ @@ -1178,7 +1409,7 @@ components: type: object url: description: |- - URL to connect to the pipeline, for example, using http_server. + URL to connect to the pipeline, for example, via http_server. May be empty if no http_server is used. type: string required: @@ -1214,7 +1445,7 @@ components: description: PipelineCreate contains the details for the pipeline creation request. properties: config_yaml: - description: The Repanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. + description: The Redpanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. type: string description: description: Pipeline description. @@ -1236,7 +1467,7 @@ components: PipelineUpdate: properties: config_yaml: - description: The Repanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. + description: The Redpanda Connect pipeline configuration in YAML format. See the [Redpanda Connect Configuration](https://docs.redpanda.com/redpanda-cloud/develop/connect/configuration/about) documentation for more details. type: string description: description: Pipeline description. @@ -1279,6 +1510,34 @@ components: description: The user for whom this ACL applies. type: string type: object + Quota.Value: + properties: + value: + format: double + type: number + value_type: + $ref: '#/components/schemas/ValueType' + type: object + QuotaDeletion: + properties: + entity: + $ref: '#/components/schemas/RequestQuotaEntity' + value_types: + items: + $ref: '#/components/schemas/ValueType' + title: Value that should be deleted for the specified entity + type: array + type: object + QuotaEntry: + description: QuotaEntry represents the quota for a specific entity type. + properties: + entity: + $ref: '#/components/schemas/Entity' + values: + items: + $ref: '#/components/schemas/Quota.Value' + type: array + type: object QuotaFailure: description: |- Describes how a quota check failed. @@ -1305,6 +1564,22 @@ components: A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded. properties: + api_service: + description: |- + The API Service from which the `QuotaFailure.Violation` orginates. In + some cases, Quota issues originate from an API Service other than the one + that was called. In other words, a dependency of the called API Service + could be the cause of the `QuotaFailure`, and this field would have the + dependency API service name. + + For example, if the called API is Kubernetes Engine API + (container.googleapis.com), and a quota violation occurs in the + Kubernetes Engine API itself, this field would be + "container.googleapis.com". On the other hand, if the quota violation + occurs when the Kubernetes Engine API creates VMs in the Compute Engine + API (compute.googleapis.com), this field would be + "compute.googleapis.com". + type: string description: description: |- A description of how the quota check failed. Clients can use this @@ -1315,6 +1590,66 @@ components: For example: "Service disabled" or "Daily Limit for read operations exceeded". type: string + future_quota_value: + description: |- + The new quota value being rolled out at the time of the violation. At the + completion of the rollout, this value will be enforced in place of + quota_value. If no rollout is in progress at the time of the violation, + this field is not set. + + For example, if at the time of the violation a rollout is in progress + changing the number of CPUs quota from 10 to 20, 20 would be the value of + this field. + format: int64 + nullable: true + type: string + quota_dimensions: + additionalProperties: + type: string + description: |- + The dimensions of the violated quota. Every non-global quota is enforced + on a set of dimensions. While quota metric defines what to count, the + dimensions specify for what aspects the counter should be increased. + + For example, the quota "CPUs per region per VM family" enforces a limit + on the metric "compute.googleapis.com/cpus_per_vm_family" on dimensions + "region" and "vm_family". And if the violation occurred in region + "us-central1" and for VM family "n1", the quota_dimensions would be, + + { + "region": "us-central1", + "vm_family": "n1", + } + + When a quota is enforced globally, the quota_dimensions would always be + empty. + type: object + quota_id: + description: |- + The id of the violated quota. Also know as "limit name", this is the + unique identifier of a quota in the context of an API service. + + For example, "CPUS-PER-VM-FAMILY-per-project-region". + type: string + quota_metric: + description: |- + The metric of the violated quota. A quota metric is a named counter to + measure usage, such as API requests or CPUs. When an activity occurs in a + service, such as Virtual Machine allocation, one or more quota metrics + may be affected. + + For example, "compute.googleapis.com/cpus_per_vm_family", + "storage.googleapis.com/internet_egress_bandwidth". + type: string + quota_value: + description: |- + The enforced quota value at the time of the `QuotaFailure`. + + For example, if the enforced quota value at the time of the + `QuotaFailure` on the number of CPUs is "10", then the value of this + field would reflect this quantity. + format: int64 + type: string subject: description: |- The subject on which the quota check failed. @@ -1322,6 +1657,15 @@ components: developer project id>". type: string type: object + QuotaSetting: + properties: + entity: + $ref: '#/components/schemas/RequestQuotaEntity' + values: + items: + $ref: '#/components/schemas/RequestQuotaValue' + type: array + type: object ReplicaAssignment: properties: partition_id: @@ -1335,6 +1679,25 @@ components: type: integer type: array type: object + RequestQuotaEntity: + properties: + entity_name: + description: |- + Entity name is the name of the entity type specified. + If left empty, the entity will be treated as a default entity (e.g., all clients). + If entity_type is ENTITY_TYPE_CLIENT_ID_PREFIX, this field must be set. + type: string + entity_type: + $ref: '#/components/schemas/EntityType' + type: object + RequestQuotaValue: + properties: + value: + format: double + type: number + value_type: + $ref: '#/components/schemas/ValueType' + type: object Resource: properties: acls: @@ -1371,6 +1734,8 @@ components: - RESOURCE_TYPE_TRANSACTIONAL_ID - RESOURCE_TYPE_DELEGATION_TOKEN - RESOURCE_TYPE_USER + - RESOURCE_TYPE_REGISTRY + - RESOURCE_TYPE_SUBJECT type: string Resources: properties: @@ -1402,6 +1767,20 @@ components: - memory_shares - cpu_shares type: object + Role: + description: Role defines a role in the system. + properties: + name: + description: The name of the role. + type: string + type: object + RoleMembership: + description: RoleMembership is the role membership. + properties: + principal: + description: The name of the principal assigned to the role. + type: string + type: object SASLMechanism: description: SASL mechanism to use for authentication. enum: @@ -1465,6 +1844,15 @@ components: $ref: '#/components/schemas/AlterTopicPartitionStatus' type: array type: object + SetQuotaRequest: + properties: + entity: + $ref: '#/components/schemas/RequestQuotaEntity' + value: + $ref: '#/components/schemas/RequestQuotaValue' + type: object + SetQuotaResponse: + type: object SetTopicConfigurationsResponse: properties: configurations: @@ -1495,6 +1883,13 @@ components: pipeline: $ref: '#/components/schemas/Pipeline' type: object + SuccessfulEntity: + properties: + entity_name: + type: string + entity_type: + $ref: '#/components/schemas/EntityType' + type: object TaskInfo: properties: connector: @@ -1631,6 +2026,42 @@ components: pipeline: $ref: '#/components/schemas/Pipeline' type: object + UpdateRoleMembershipBody: + description: UpdateRoleMembershipRequest is the request to UpdateRoleMembership. + properties: + add: + description: Members to assign to the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + create: + description: |- + Create the role if it doesn't already exist. + If the role is created in this way, the “add” list will be respected, but the “remove” list will be ignored. + type: boolean + remove: + description: Members to remove from the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + type: object + UpdateRoleMembershipResponse: + description: UpdateRoleMembershipResponse is the response for UpdateRoleMembership. + properties: + added: + description: Members assigned to the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + removed: + description: Members removed from the role. + items: + $ref: '#/components/schemas/RoleMembership' + type: array + role_name: + description: The role name. + type: string + type: object UpdateSecretBody: description: UpdateSecretRequest is the request of UpdateSecret. properties: @@ -1694,6 +2125,22 @@ components: connector: $ref: '#/components/schemas/ConnectorSpec' type: object + ValueType: + description: |- + The type of value that the quota represents. + + - VALUE_TYPE_PRODUCER_BYTE_RATE: The rate at which producers can send data. + - VALUE_TYPE_CONSUMER_BYTE_RATE: The rate at which consumers can fetch data. + - VALUE_TYPE_CONTROLLER_MUTATION_RATE: The rate at which topic mutation requests can be made. + - VALUE_TYPE_REQUEST_PERCENTAGE: The percentage of the total throughput that can be used by the entity. + + Not supported in Redpanda + enum: + - VALUE_TYPE_PRODUCER_BYTE_RATE + - VALUE_TYPE_CONSUMER_BYTE_RATE + - VALUE_TYPE_CONTROLLER_MUTATION_RATE + - VALUE_TYPE_REQUEST_PERCENTAGE + type: string rpc.Status: description: |- The `Status` type defines a logical error model that is suitable for @@ -1780,7 +2227,6 @@ components: info: title: Redpanda Cloud Data Plane API version: v1 - description: 'Use the Data Plane API to manage topics, ACLs, and connectors within each cluster.' openapi: 3.0.3 paths: /v1/acls: @@ -1803,6 +2249,8 @@ paths: - RESOURCE_TYPE_TRANSACTIONAL_ID - RESOURCE_TYPE_DELEGATION_TOKEN - RESOURCE_TYPE_USER + - RESOURCE_TYPE_REGISTRY + - RESOURCE_TYPE_SUBJECT type: string - description: The name of the resource this ACL targets. in: query @@ -1913,6 +2361,8 @@ paths: - RESOURCE_TYPE_TRANSACTIONAL_ID - RESOURCE_TYPE_DELEGATION_TOKEN - RESOURCE_TYPE_USER + - RESOURCE_TYPE_REGISTRY + - RESOURCE_TYPE_SUBJECT type: string - description: The name of the resource this ACL targets. in: query @@ -2360,7 +2810,7 @@ paths: - Cloud Storage /v1/kafka-connect/clusters: get: - description: List Connect clusters available in Console. + description: List connect clusters available for being consumed by the console's kafka-connect service. operationId: KafkaConnectService_ListConnectClusters responses: "200": @@ -2387,7 +2837,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Connect clusters + summary: List connect clusters tags: - Kafka Connect /v1/kafka-connect/clusters/{cluster_name}: @@ -2395,7 +2845,7 @@ paths: description: Get information about an available Kafka Connect cluster. operationId: KafkaConnectService_GetConnectCluster parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2406,7 +2856,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetConnectClusterResponse' + $ref: '#/components/schemas/ConnectCluster' description: OK "401": content: @@ -2432,7 +2882,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Connect cluster + summary: Get connect cluster tags: - Kafka Connect /v1/kafka-connect/clusters/{cluster_name}/connectors: @@ -2507,7 +2957,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateConnectorResponse' + $ref: '#/components/schemas/ConnectorSpec' description: Created "401": content: @@ -2595,7 +3045,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetConnectorResponse' + $ref: '#/components/schemas/ConnectorSpec' description: OK "401": content: @@ -2636,12 +3086,6 @@ paths: schema: type: string responses: - "200": - content: - application/json: - schema: - $ref: '#/components/schemas/GetConnectorConfigResponse' - description: OK "401": content: application/json: @@ -2696,7 +3140,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpsertConnectorResponse' + $ref: '#/components/schemas/ConnectorSpec' description: Updated "201": content: @@ -2730,7 +3174,7 @@ paths: description: Pause the connector and its tasks, which stops messages from processing until the connector is resumed. This call is asynchronous and may take some time to process. operationId: KafkaConnectService_PauseConnector parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2774,7 +3218,7 @@ paths: description: Triggers a connector restart. You must specify whether or not tasks are also restarted, and whether only failed connectors are restarted. operationId: KafkaConnectService_RestartConnector parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2825,7 +3269,7 @@ paths: description: Resume a paused connector and its tasks, and resumes message processing. This call is asynchronous and may take some time to process. If the connector was not paused, this operation does not do anything. operationId: KafkaConnectService_ResumeConnector parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2869,7 +3313,7 @@ paths: description: Gets the current status of the connector, including the state for each of its tasks, error information, etc. operationId: KafkaConnectService_GetConnectorStatus parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2886,7 +3330,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetConnectorStatusResponse' + $ref: '#/components/schemas/ConnectorStatus' description: OK "401": content: @@ -2914,7 +3358,7 @@ paths: description: Stops a connector, but does not delete it. All tasks for the connector are shut down completely. This call is asynchronous and may take some time to process. operationId: KafkaConnectService_StopConnector parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2958,7 +3402,7 @@ paths: description: Returns a list of connector topic names. If the connector is inactive, this call returns an empty list. operationId: KafkaConnectService_ListConnectorTopics parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3003,7 +3447,7 @@ paths: description: Resets the set of topic names that the connector is using. operationId: KafkaConnectService_ResetConnectorTopics parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3047,7 +3491,7 @@ paths: description: 'List Kafka Connect cluster secrets. Optional: filter based on secret name and labels.' operationId: SecretService_ListKafkaConnectSecrets parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3091,7 +3535,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ListKafkaConnectSecretsResponse' + $ref: '#/components/schemas/ListSecretsResponse' description: OK "401": content: @@ -3111,7 +3555,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Connect cluster secrets + summary: List Connect Cluster Secrets tags: - Secrets post: @@ -3136,7 +3580,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateKafkaConnectSecretResponse' + $ref: '#/components/schemas/GetKafkaConnectSecretResponse' description: Secret created "401": content: @@ -3156,7 +3600,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Connect cluster secret + summary: Create Connect Cluster Secret tags: - Secrets /v1/kafka-connect/clusters/{cluster_name}/secrets/{id}: @@ -3164,7 +3608,7 @@ paths: description: Delete a Kafka Connect cluster secret. operationId: SecretService_DeleteKafkaConnectSecret parameters: - - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3206,7 +3650,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Connect cluster secret + summary: Delete Connect Cluster Secret tags: - Secrets get: @@ -3256,7 +3700,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Connect cluster secret + summary: Get Connect Cluster Secret tags: - Secrets put: @@ -3313,19 +3757,55 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update Connect cluster secret + summary: Update Connect Cluster Secret tags: - Secrets - /v1/redpanda-connect/config-schema: + /v1/quotas: get: - description: The configuration schema includes available [components and processors](https://docs.redpanda.com/redpanda-cloud/develop/connect/components/about) in this Redpanda Connect instance. - operationId: PipelineService_GetPipelineServiceConfigSchema + description: List client quotas. Use filter parameters to narrow results by entity type and filter criteria. + operationId: QuotaService_ListQuotas + parameters: + - description: |- + The type of entity to filter by. If unspecified, all entities will be returned. + + - ENTITY_TYPE_USER: Not supported in Redpanda + - ENTITY_TYPE_IP: Not supported in Redpanda + in: query + name: filter.entity_type + schema: + enum: + - ENTITY_TYPE_CLIENT_ID + - ENTITY_TYPE_CLIENT_ID_PREFIX + - ENTITY_TYPE_USER + - ENTITY_TYPE_IP + type: string + - description: Filter by entity name. If unspecified will return all entities for specified entity type. + in: query + name: filter.entity_name + schema: + type: string + - description: If true, the entity_name will match the default entity (e.g., default client-id). + in: query + name: filter.match_default + schema: + type: boolean + - description: Limit the paginated response to a number of items. Defaults to 100. Use -1 to disable pagination. + in: query + name: page_size + schema: + format: int32 + type: integer + - description: Value of the next_page_token field returned by the previous response. If not provided, the system assumes the first page is requested. + in: query + name: page_token + schema: + type: string responses: "200": content: application/json: schema: - $ref: '#/components/schemas/GetPipelineServiceConfigSchemaResponse' + $ref: '#/components/schemas/ListQuotasResponse' description: OK "401": content: @@ -3345,27 +3825,214 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Retrieve the schema for Redpanda Connect pipeline configurations. + summary: List quotas tags: - - Redpanda Connect Pipeline - /v1/redpanda-connect/pipelines: - get: - description: 'List Redpanda Connect pipelines. Optional: filter based on pipeline name.' - operationId: PipelineService_ListPipelines - parameters: - - description: Substring match on pipeline name. Case-sensitive. - in: query - name: filter.name_contains - schema: - type: string - - description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18 - in: query - name: filter.tags[string] - schema: - type: string - - description: Limit the paginated response to a number of items. Defaults to 100. Use -1 to disable pagination. - in: query - name: page_size + - Quotas + post: + description: Create or update client throughput quotas for a single entity. This operation is an upsert. + operationId: QuotaService_SetQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetQuotaRequest' + required: true + x-originalParamName: body + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/SetQuotaResponse' + description: Quota Set + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: Set a quota + tags: + - Quotas + /v1/quotas:batchDelete: + post: + description: Delete client quotas for multiple entities and values in a single request. + operationId: QuotaService_BatchDeleteQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchDeleteQuotaRequest' + required: true + x-originalParamName: body + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/BatchDeleteQuotaResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: Delete multiple quotas + tags: + - Quotas + /v1/quotas:batchSet: + post: + description: Create or update client throughput quotas for multiple entities in a single request. + operationId: QuotaService_BatchSetQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BatchSetQuotaRequest' + required: true + x-originalParamName: body + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/BatchSetQuotaResponse' + description: Quotas Set + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: Set multiple quotas + tags: + - Quotas + /v1/quotas:delete: + post: + description: Delete client quotas for single entity and value. + operationId: QuotaService_DeleteQuota + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteQuotaRequest' + required: true + x-originalParamName: body + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/DeleteQuotaResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: Delete a quota + tags: + - Quotas + /v1/redpanda-connect/config-schema: + get: + description: The configuration schema includes available [components and processors](https://docs.redpanda.com/redpanda-cloud/develop/connect/components/about) in this Redpanda Connect instance. + operationId: PipelineService_GetPipelineServiceConfigSchema + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetPipelineServiceConfigSchemaResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: Retrieve the schema for Redpanda Connect pipeline configurations. + tags: + - Redpanda Connect Pipeline + /v1/redpanda-connect/pipelines: + get: + description: 'List Redpanda Connect pipelines. Optional: filter based on pipeline name.' + operationId: PipelineService_ListPipelines + parameters: + - description: Any pipelines that partially match this name will be returned. + in: query + name: filter.name_contains + schema: + type: string + - description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18 + in: query + name: filter.tags[string] + schema: + type: string + - description: Limit the paginated response to a number of items. Defaults to 100. Use -1 to disable pagination. + in: query + name: page_size schema: format: int32 type: integer @@ -3419,7 +4086,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreatePipelineResponse' + $ref: '#/components/schemas/Pipeline' description: OK "401": content: @@ -3572,7 +4239,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetPipelineResponse' + $ref: '#/components/schemas/Pipeline' description: OK "401": content: @@ -3630,7 +4297,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdatePipelineResponse' + $ref: '#/components/schemas/Pipeline' description: OK "401": content: @@ -3669,7 +4336,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StartPipelineResponse' + $ref: '#/components/schemas/Pipeline' description: Started "401": content: @@ -3714,7 +4381,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/StopPipelineResponse' + $ref: '#/components/schemas/Pipeline' description: Stopped "401": content: @@ -3743,6 +4410,346 @@ paths: summary: Stops a Redpanda Connect pipeline tags: - Redpanda Connect Pipeline + /v1/redpanda-connect/pipelines:lint-config: + post: + description: Validates a supplied Redpanda Connect pipeline YAML and returns a list of linting hints. If no problems are found, the list is empty. + operationId: PipelineService_LintPipelineConfig + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LintPipelineConfigRequest' + required: true + x-originalParamName: body + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/LintPipelineConfigResponse' + description: Linting finished. See `lint_hints` for details. + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: Lint a Redpanda Connect pipeline configuration + tags: + - Redpanda Connect Pipeline + /v1/roles: + get: + description: 'List roles. Optional: filter based on role name and principal.' + operationId: SecurityService_ListRoles + parameters: + - description: Filter results only roles named with the prefix. + in: query + name: filter.name_prefix + schema: + type: string + - description: Filter results to only roles with names which contain the string. + in: query + name: filter.name_contains + schema: + type: string + - description: Return only roles assigned to this principal. + in: query + name: filter.principal + schema: + type: string + - description: Page size. + in: query + name: page_size + schema: + format: int32 + type: integer + - description: |- + Value of the next_page_token field returned by the previous response. + If not provided, the system assumes the first page is requested. + in: query + name: page_token + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListRolesResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: List Roles + tags: + - Security + post: + description: Create a role. + operationId: SecurityService_CreateRole + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + description: The role to create. + required: true + x-originalParamName: role + responses: + "201": + content: + application/json: + schema: + $ref: '#/components/schemas/CreateRoleResponse' + description: Role created + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: Create Role + tags: + - Security + /v1/roles/{role_name}: + delete: + description: Delete a Role. + operationId: SecurityService_DeleteRole + parameters: + - description: The role name. + in: path + name: role_name + required: true + schema: + type: string + - description: Whether to delete the ACLs bound to the role. + in: query + name: delete_acls + schema: + type: boolean + responses: + "204": + content: + application/json: + schema: {} + description: Role deleted successfully + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: Delete Role + tags: + - Security + get: + description: Get a role. + operationId: SecurityService_GetRole + parameters: + - description: The role name. + in: path + name: role_name + required: true + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/GetRoleResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: Get Role + tags: + - Security + put: + description: Update a role. + operationId: SecurityService_UpdateRoleMembership + parameters: + - description: The role name. + in: path + name: role_name + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRoleMembershipBody' + required: true + x-originalParamName: body + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateRoleMembershipResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "404": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Not Found + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: Update Role + tags: + - Security + /v1/roles/{role_name}/members: + get: + description: List members assigned to a role. + operationId: SecurityService_ListRoleMembers + parameters: + - description: The role name. + in: path + name: role_name + required: true + schema: + type: string + - description: Filter results to only members with names which contain the string. + in: query + name: filter.name_contains + schema: + type: string + - description: Page size. + in: query + name: page_size + schema: + format: int32 + type: integer + - description: |- + Value of the next_page_token field returned by the previous response. + If not provided, the system assumes the first page is requested. + in: query + name: page_token + schema: + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ListRoleMembersResponse' + description: OK + "401": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Unauthenticated. + "500": + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: Internal Server Error. Reach out to support. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/rpc.Status' + description: An unexpected error response. + summary: List Role Members + tags: + - Security /v1/secret-scopes: get: description: List supported secret scopes. @@ -3772,7 +4779,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List secret scopes + summary: List Secret Scopes tags: - Secrets /v1/secrets: @@ -3838,7 +4845,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List secrets + summary: List Secrets tags: - Secrets post: @@ -3877,7 +4884,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create secret + summary: Create Secret tags: - Secrets /v1/secrets/{id}: @@ -3921,7 +4928,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete secret + summary: Delete Secret tags: - Secrets get: @@ -3965,7 +4972,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get secret + summary: Get Secret tags: - Secrets put: @@ -4016,7 +5023,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update secret + summary: Update Secret tags: - Secrets /v1/topics: @@ -4065,7 +5072,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List topics + summary: List Topics tags: - Topics post: @@ -4112,7 +5119,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create topic + summary: Create Topic tags: - Topics /v1/topics-partitions: @@ -4157,7 +5164,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Add topic partitions + summary: Add Topic Partitions tags: - Topics put: @@ -4201,7 +5208,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set topic partitions + summary: Set Topic Partitions tags: - Topics /v1/topics/{topic_name}: @@ -4245,7 +5252,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete topic + summary: Delete Topic tags: - Topics /v1/topics/{topic_name}/configurations: @@ -4290,7 +5297,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get topic configurations + summary: Get Topic Configurations tags: - Topics patch: @@ -4343,7 +5350,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update topic configuration + summary: Update Topic Configuration tags: - Topics put: @@ -4396,7 +5403,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set topic configurations + summary: Set Topic Configurations tags: - Topics /v1/topics/{topic_name}/partitions: @@ -4448,7 +5455,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Add topic partitions + summary: Add Topic Partitions tags: - Topics put: @@ -4499,7 +5506,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set topic partitions + summary: Set Topic Partitions tags: - Topics /v1/transforms: @@ -4575,7 +5582,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List transforms + summary: List Transforms tags: - WASM Transforms put: @@ -4603,7 +5610,7 @@ paths: schema: $ref: '#/components/schemas/TransformMetadata' description: Created - summary: Deploy transform + summary: Deploy Transform tags: - WASM Transforms /v1/transforms/{name}: @@ -4650,7 +5657,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete transform + summary: Delete Transform tags: - WASM Transforms get: @@ -4709,7 +5716,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get transform + summary: Get Transform tags: - WASM Transforms /v1/users: @@ -4770,7 +5777,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List users + summary: List Users tags: - Redpanda Users post: @@ -4812,8 +5819,12 @@ paths: field_violations: - description: value length must be at least 3 characters field: user.password + localized_message: null + reason: "" - description: value is required field: user.mechanism + localized_message: null + reason: "" message: provided parameters are invalid schema: $ref: '#/components/schemas/rpc.Status' @@ -4836,7 +5847,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create user + summary: Create User tags: - Redpanda Users /v1/users/{name}: @@ -4889,7 +5900,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete user + summary: Delete User tags: - Redpanda Users /v1/users/{user.name}: @@ -4945,8 +5956,12 @@ paths: field_violations: - description: value length must be at least 3 characters field: user.password + localized_message: null + reason: "" - description: value is required field: user.mechanism + localized_message: null + reason: "" message: provided parameters are invalid schema: $ref: '#/components/schemas/rpc.Status' @@ -4969,7 +5984,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update user + summary: Update User tags: - Redpanda Users security: @@ -4981,10 +5996,9 @@ servers: dataplane_api_url: default: https://{dataplane_api_url} description: |- - Find the Data Plane API base URL of a cluster by calling the Get Cluster endpoint of the Control Plane API. The dataplane_api.url field is returned in the response body. - - Example (BYOC): "https://api-a4cb21.ck09mi9c4vs17hng9gig.byoc.prd.cloud.redpanda.com" - Example (Dedicated): "https://api-a4cb21.ck09mi9c4vs17hng9gig.fmc.prd.cloud.redpanda.com" + Find the Data Plane API base URL of a cluster by calling the Get Cluster endpoint of the Control Plane API. The dataplane_api.url field is returned in the response body.

+ Example (Dedicated): "https://api-a4cb21.ck09mi9c4vs17hng9gig.fmc.prd.cloud.redpanda.com"
+ Example (BYOC): "https://api-a4cb21.ck09mi9c4vs17hng9gig.byoc.prd.cloud.redpanda.com" tags: - description: Manage Redpanda access control lists (ACLs). See [Redpanda Cloud Authorization](https://docs.redpanda.com/redpanda-cloud/security/authorization/cloud-authorization/) for more information. name: Redpanda ACLs @@ -4996,9 +6010,13 @@ tags: name: Kafka Connect - description: Create and manage [Redpanda Connect](https://docs.redpanda.com/redpanda-cloud/develop/connect/about) pipelines and their configurations. name: Redpanda Connect Pipeline + - description: Manage client throughput limits. See [Redpanda Client Throughput Limits](https://docs.redpanda.com/current/manage/cluster-maintenance/manage-throughput/#client-throughput-limits) for more information. + name: Quotas - description: Manage [secrets](https://docs.redpanda.com/redpanda-cloud/security/secrets) for Redpanda Cloud. name: Secrets + - description: Manage Redpanda roles. + name: Security - description: Manage Redpanda topics. name: Topics - - description: Manage Redpanda users. To manage access, see the Data Plane [ACL endpoints](https://docs.redpanda.com/api/doc/cloud-dataplane/group/endpoint-redpanda-users). + - description: Manage Redpanda users. To manage access, see the Data Plane [ACL endpoints](https://docs.redpanda.com/api/cloud-dataplane-api/#get-/v1/acls). name: Redpanda Users From ca458566b440b56d2c21315f44f55e858e9a9ded Mon Sep 17 00:00:00 2001 From: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> Date: Sun, 24 Aug 2025 22:04:10 -0700 Subject: [PATCH 2/2] Apply suggestions from code review --- cloud-controlplane/cloud-controlplane.yaml | 2 +- cloud-dataplane/cloud-dataplane.yaml | 105 +++++++++++---------- 2 files changed, 54 insertions(+), 53 deletions(-) diff --git a/cloud-controlplane/cloud-controlplane.yaml b/cloud-controlplane/cloud-controlplane.yaml index 75d800d..6970dd3 100644 --- a/cloud-controlplane/cloud-controlplane.yaml +++ b/cloud-controlplane/cloud-controlplane.yaml @@ -3255,7 +3255,7 @@ components: x-client-id: dQjapNIAHhF7EQqQToRla3yEII9sUSap type: oauth2 info: - description: The Redpanda Cloud Control Plane API allows programmatic management of Redpanda Cloud resources including clusters, networks, and resource groups. + description: 'Use the Control Plane API to manage resources in your Redpanda Cloud organization such as clusters and networks.' title: Redpanda Cloud Control Plane API version: v1 openapi: 3.0.3 diff --git a/cloud-dataplane/cloud-dataplane.yaml b/cloud-dataplane/cloud-dataplane.yaml index e7de945..e56d32c 100644 --- a/cloud-dataplane/cloud-dataplane.yaml +++ b/cloud-dataplane/cloud-dataplane.yaml @@ -212,7 +212,7 @@ components: info: $ref: '#/components/schemas/ConnectCluster.Info' name: - description: Unique name of connect cluster. For Redpanda Cloud, the value is `redpanda`. + description: Unique name of Connect cluster. For Redpanda Cloud, the value is `redpanda`. type: string plugins: items: @@ -2227,6 +2227,7 @@ components: info: title: Redpanda Cloud Data Plane API version: v1 + description: 'Use the Data Plane API to manage topics, ACLs, and connectors within each cluster.' openapi: 3.0.3 paths: /v1/acls: @@ -2810,7 +2811,7 @@ paths: - Cloud Storage /v1/kafka-connect/clusters: get: - description: List connect clusters available for being consumed by the console's kafka-connect service. + description: List Connect clusters available in Console. operationId: KafkaConnectService_ListConnectClusters responses: "200": @@ -2837,7 +2838,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List connect clusters + summary: List Connect clusters tags: - Kafka Connect /v1/kafka-connect/clusters/{cluster_name}: @@ -2845,7 +2846,7 @@ paths: description: Get information about an available Kafka Connect cluster. operationId: KafkaConnectService_GetConnectCluster parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -2882,7 +2883,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get connect cluster + summary: Get Connect cluster tags: - Kafka Connect /v1/kafka-connect/clusters/{cluster_name}/connectors: @@ -3174,7 +3175,7 @@ paths: description: Pause the connector and its tasks, which stops messages from processing until the connector is resumed. This call is asynchronous and may take some time to process. operationId: KafkaConnectService_PauseConnector parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3218,7 +3219,7 @@ paths: description: Triggers a connector restart. You must specify whether or not tasks are also restarted, and whether only failed connectors are restarted. operationId: KafkaConnectService_RestartConnector parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3269,7 +3270,7 @@ paths: description: Resume a paused connector and its tasks, and resumes message processing. This call is asynchronous and may take some time to process. If the connector was not paused, this operation does not do anything. operationId: KafkaConnectService_ResumeConnector parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3313,7 +3314,7 @@ paths: description: Gets the current status of the connector, including the state for each of its tasks, error information, etc. operationId: KafkaConnectService_GetConnectorStatus parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3358,7 +3359,7 @@ paths: description: Stops a connector, but does not delete it. All tasks for the connector are shut down completely. This call is asynchronous and may take some time to process. operationId: KafkaConnectService_StopConnector parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3402,7 +3403,7 @@ paths: description: Returns a list of connector topic names. If the connector is inactive, this call returns an empty list. operationId: KafkaConnectService_ListConnectorTopics parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3447,7 +3448,7 @@ paths: description: Resets the set of topic names that the connector is using. operationId: KafkaConnectService_ResetConnectorTopics parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3491,7 +3492,7 @@ paths: description: 'List Kafka Connect cluster secrets. Optional: filter based on secret name and labels.' operationId: SecretService_ListKafkaConnectSecrets parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3555,7 +3556,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Connect Cluster Secrets + summary: List Connect cluster secrets tags: - Secrets post: @@ -3600,7 +3601,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Connect Cluster Secret + summary: Create Connect cluster secret tags: - Secrets /v1/kafka-connect/clusters/{cluster_name}/secrets/{id}: @@ -3608,7 +3609,7 @@ paths: description: Delete a Kafka Connect cluster secret. operationId: SecretService_DeleteKafkaConnectSecret parameters: - - description: Unique name of target connect cluster. For Redpanda Cloud, use `redpanda`. + - description: Unique name of target Connect cluster. For Redpanda Cloud, use `redpanda`. in: path name: cluster_name required: true @@ -3650,7 +3651,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Connect Cluster Secret + summary: Delete Connect cluster secret tags: - Secrets get: @@ -3700,7 +3701,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Connect Cluster Secret + summary: Get Connect cluster secret tags: - Secrets put: @@ -3757,7 +3758,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update Connect Cluster Secret + summary: Update Connect cluster secret tags: - Secrets /v1/quotas: @@ -4012,7 +4013,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Retrieve the schema for Redpanda Connect pipeline configurations. + summary: Retrieve the schema for Redpanda Connect pipeline configurations tags: - Redpanda Connect Pipeline /v1/redpanda-connect/pipelines: @@ -4507,7 +4508,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Roles + summary: List roles tags: - Security post: @@ -4546,12 +4547,12 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Role + summary: Create role tags: - Security /v1/roles/{role_name}: delete: - description: Delete a Role. + description: Delete a role. operationId: SecurityService_DeleteRole parameters: - description: The role name. @@ -4595,7 +4596,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Role + summary: Delete role tags: - Security get: @@ -4639,7 +4640,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Role + summary: Get role tags: - Security put: @@ -4690,7 +4691,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update Role + summary: Update role tags: - Security /v1/roles/{role_name}/members: @@ -4747,7 +4748,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Role Members + summary: List role members tags: - Security /v1/secret-scopes: @@ -4779,7 +4780,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Secret Scopes + summary: List secret scopes tags: - Secrets /v1/secrets: @@ -4845,7 +4846,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Secrets + summary: List secrets tags: - Secrets post: @@ -4884,7 +4885,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Secret + summary: Create secret tags: - Secrets /v1/secrets/{id}: @@ -4928,7 +4929,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Secret + summary: Delete secret tags: - Secrets get: @@ -4972,7 +4973,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Secret + summary: Get secret tags: - Secrets put: @@ -5023,7 +5024,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update Secret + summary: Update secret tags: - Secrets /v1/topics: @@ -5072,7 +5073,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Topics + summary: List topics tags: - Topics post: @@ -5119,7 +5120,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create Topic + summary: Create topic tags: - Topics /v1/topics-partitions: @@ -5164,7 +5165,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Add Topic Partitions + summary: Add topic partitions tags: - Topics put: @@ -5208,7 +5209,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set Topic Partitions + summary: Set topic partitions tags: - Topics /v1/topics/{topic_name}: @@ -5252,7 +5253,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Topic + summary: Delete topic tags: - Topics /v1/topics/{topic_name}/configurations: @@ -5297,7 +5298,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Topic Configurations + summary: Get topic configurations tags: - Topics patch: @@ -5350,7 +5351,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update Topic Configuration + summary: Update topic configuration tags: - Topics put: @@ -5403,7 +5404,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set Topic Configurations + summary: Set topic configurations tags: - Topics /v1/topics/{topic_name}/partitions: @@ -5455,7 +5456,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Add Topic Partitions + summary: Add topic partitions tags: - Topics put: @@ -5506,7 +5507,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Set Topic Partitions + summary: Set topic partitions tags: - Topics /v1/transforms: @@ -5582,7 +5583,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Transforms + summary: List transforms tags: - WASM Transforms put: @@ -5610,7 +5611,7 @@ paths: schema: $ref: '#/components/schemas/TransformMetadata' description: Created - summary: Deploy Transform + summary: Deploy transform tags: - WASM Transforms /v1/transforms/{name}: @@ -5657,7 +5658,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete Transform + summary: Delete transform tags: - WASM Transforms get: @@ -5716,7 +5717,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Get Transform + summary: Get transform tags: - WASM Transforms /v1/users: @@ -5777,7 +5778,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: List Users + summary: List users tags: - Redpanda Users post: @@ -5847,7 +5848,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Create User + summary: Create user tags: - Redpanda Users /v1/users/{name}: @@ -5900,7 +5901,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Delete User + summary: Delete user tags: - Redpanda Users /v1/users/{user.name}: @@ -5984,7 +5985,7 @@ paths: schema: $ref: '#/components/schemas/rpc.Status' description: An unexpected error response. - summary: Update User + summary: Update user tags: - Redpanda Users security: @@ -6018,5 +6019,5 @@ tags: name: Security - description: Manage Redpanda topics. name: Topics - - description: Manage Redpanda users. To manage access, see the Data Plane [ACL endpoints](https://docs.redpanda.com/api/cloud-dataplane-api/#get-/v1/acls). + - description: Manage Redpanda users. To manage access, see the Data Plane [ACL endpoints](https://docs.redpanda.com/api/doc/cloud-dataplane/group/endpoint-redpanda-users). name: Redpanda Users