Path parameters

• id string Required

Responses

• 200 application/json

  OK

  Hide response attribute Show response attribute object

  • cluster object

    Resource describing a Cluster.

    Hide cluster attributes Show cluster attributes object

    • aws_private_link object
      Hide aws_private_link attributes Show aws_private_link attributes object

      • allowed_principals array[string]

        The ARN of the principals that can access the Redpanda AWS PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).

      • connect_console boolean

        Whether Console is connected in Redpanda AWS Private Link Service.

      • enabled boolean

        Whether Redpanda AWS Private Link Endpoint Service is enabled.

      • http_proxy_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • kafka_api_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • schema_registry_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • status object
        Hide status attributes Show status attributes object

        • console_port integer(int32)

          The port of Redpanda Console.

        • created_at string(date-time)

          Redpanda AWS PrivateLink Endpoint Service creation timestamp.

        • deleted_at string(date-time)

          Redpanda AWS PrivateLink Service deletion timestamp.

        • kafka_api_node_base_port integer(int32)

          Kafka API node service base port. The port for node i (0 .. node_count-1) is kafka_api_node_base_port + i.

        • kafka_api_seed_port integer(int32)

          Kafka API seed service port.

        • redpanda_proxy_node_base_port integer(int32)

          HTTP Proxy node service base port. The port for node i (0 .. node_count-1) is redpanda_proxy_node_base_port + i.

        • redpanda_proxy_seed_port integer(int32)

          HTTP Proxy seed service port.

        • schema_registry_seed_port integer(int32)

          Schema Registry seed service port.

        • service_id string

          ID of Redpanda AWS PrivateLink Endpoint Service.

        • service_name string

          Name of Redpanda AWS PrivateLink Endpoint Service.

        • service_state string

          State of Redpanda AWS PrivateLink Endpoint Service.

        • vpc_endpoint_connections array[object]

          List of VPC endpoints with established connections to Redpanda AWS PrivateLink Endpoint Service.

          Hide vpc_endpoint_connections attributes Show vpc_endpoint_connections attributes object

          • connection_id string

            Connection ID of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.

          • created_at string(date-time)

            VPC endpoint creation timestamp.

          • dns_entries array[object]

            The list of DNS entries associated with VPC endpoint.

            Hide dns_entries attributes Show dns_entries attributes object

            • dns_name string

              DNS entry of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.

            • hosted_zone_id string

              The ID of Route53 DNS zone.

          • id string

            The ID of VPC endpoint.

          • load_balancer_arns array[string]

            List of load balancer ARNs.

          • owner string

            The owner of VPC endpoint.

          • state string

            The state of VPC endpoint connected to Redpanda AWS PrivateLink Endpoint Service.

    • azure_private_link object
      Hide azure_private_link attributes Show azure_private_link attributes object

      • allowed_subscriptions array[string]

        The subscriptions that can access the Redpanda Azure PrivateLink Endpoint Service. To grant permissions to all principals, use an asterisk (*).

      • connect_console boolean

        Whether Console is connected in Redpanda Azure Private Link Service.

      • enabled boolean

        Whether Redpanda AWS Private Link Endpoint Service is enabled.

      • http_proxy_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • kafka_api_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • schema_registry_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • status object
        Hide status attributes Show status attributes object

        • approved_subscriptions array[string]
        • console_port integer(int32)

          The port of Redpanda Console.

        • created_at string(date-time)

          Redpanda Azure PrivateLink Endpoint Service creation timestamp.

        • deleted_at string(date-time)

          Redpanda Azure PrivateLink Service deletion timestamp.

        • dns_a_record string
        • kafka_api_node_base_port integer(int32)

          Kafka API node service base port. The port for node i (0 .. node_count-1) is kafka_api_node_base_port + i.

        • kafka_api_seed_port integer(int32)

          Kafka API seed service port.

        • private_endpoint_connections array[object]

          List of private endpoint connections to Redpanda Azure Private Link Service.

          Hide private_endpoint_connections attributes Show private_endpoint_connections attributes object

          • connection_id string
          • connection_name string
          • created_at string(date-time)

            PrivateEndpointConnection creation timestamp.

          • private_endpoint_id string

            Resource ID of Private Endpoint to Redpanda Azure PrivateLink Endpoint Service.

          • private_endpoint_name string

            The name of the PrivateEndpointConnection.

          • status string

            The status of private endpoint connected to Redpanda Azure PrivateLink Endpoint Service.

        • redpanda_proxy_node_base_port integer(int32)

          HTTP Proxy node service base port. The port for node i (0 .. node_count-1) is redpanda_proxy_node_base_port + i.

        • redpanda_proxy_seed_port integer(int32)

          HTTP Proxy seed service port.

        • schema_registry_seed_port integer(int32)

          Schema Registry seed service port.

        • service_id string

          ID of Redpanda Azure PrivateLink Endpoint Service.

        • service_name string

          Name of Redpanda Azure PrivateLink Endpoint Service.

    • cloud_provider string

      Cloud provider where resources are created.

      Values are CLOUD_PROVIDER_AWS, CLOUD_PROVIDER_GCP, or CLOUD_PROVIDER_AZURE.

    • cloud_provider_tags object

      Tags placed on cloud resources. If the cloud provider is GCP and the name of a tag has the prefix "gcp.network-tag.", the tag is a network tag that will be added to the Redpanda cluster GKE nodes. Otherwise, the tag is a normal tag. For example, if the name of a tag is "gcp.network-tag.network-tag-foo", the network tag named "network-tag-foo" will be added to the Redpanda cluster GKE nodes. Note: The value of a network tag will be ignored. See the official GCP VPC for more details on network tags.

      Hide cloud_provider_tags attribute Show cloud_provider_tags attribute object

      • * string Additional properties
    • cloud_storage object
      Hide cloud_storage attributes Show cloud_storage attributes object

      • aws object
        Hide aws attribute Show aws attribute object

        • arn string
      • azure object
        Hide azure attributes Show azure attributes object

        • allowed_ips array[string]

          List of public IP or IP ranges in CIDR Format.

          • Only IPv4 addresses are allowed.
          • Private IP address ranges as defined in RFC 1918 are not allowed.
          • Private IP address ranges as defined in RFC 6598 are not allowed.
          • Small address ranges using "/31" or "/32" prefix sizes are not supported. These ranges should be configured using individual IP address rules without prefix specified.
          • allowed_ips have no effect on requests originating from the same Azure region as the storage account. Use allowed_subnet_ids to allow same-region requests. Services deployed in the same region as the storage account use private Azure IP addresses for communication. Thus, you cannot allow access to specific Azure services based on their public outbound IP address range.
        • allowed_subnet_ids array[string]

          A list of virtual network subnet IDs that are allowed to access the storage account.

        • container_name string
        • resource_group_name string
        • storage_account_name string
        • subscription_id string
      • gcp object
        Hide gcp attribute Show gcp attribute object

        • name string
      • skip_destroy boolean
    • cluster_configuration object
      Hide cluster_configuration attributes Show cluster_configuration attributes object

      • computed_properties object
      • custom_properties object
    • connection_type string

      Cluster connection type. Private clusters are not exposed to the internet. For BYOC clusters, Private is best-practice.

      Values are CONNECTION_TYPE_PUBLIC or CONNECTION_TYPE_PRIVATE.

    • created_at string(date-time)

      Cluster creation timestamp.

    • current_redpanda_version string

      Current Redpanda version of the cluster.

    • customer_managed_resources object

      The cloud resources created by user.

      Hide customer_managed_resources attributes Show customer_managed_resources attributes object

      • aws object

        AWS resources created and managed by user, and required to deploy the Redpanda cluster.

        Hide aws attributes Show aws attributes object

        • agent_instance_profile object Required

          AWS instance profile.

          Hide agent_instance_profile attribute Show agent_instance_profile attribute object

          • arn string Required

            AWS instance profile ARN.

        • cloud_storage_bucket object Required

          AWS storage bucket properties by ARN.

          Hide cloud_storage_bucket attribute Show cloud_storage_bucket attribute object

          • arn string Required

            AWS storage bucket identifier.

        • cluster_security_group object Required

          Security Group identifies AWS security group.

          Hide cluster_security_group attribute Show cluster_security_group attribute object

          • arn string Required

            AWS security group ARN.

        • connectors_node_group_instance_profile object Required

          AWS instance profile.

          Hide connectors_node_group_instance_profile attribute Show connectors_node_group_instance_profile attribute object

          • arn string Required

            AWS instance profile ARN.

        • connectors_security_group object Required

          Security Group identifies AWS security group.

          Hide connectors_security_group attribute Show connectors_security_group attribute object

          • arn string Required

            AWS security group ARN.

        • k8s_cluster_role object Required

          Role identifies AWS role.

          Hide k8s_cluster_role attribute Show k8s_cluster_role attribute object

          • arn string Required

            AWS role ARN.

        • node_security_group object Required

          Security Group identifies AWS security group.

          Hide node_security_group attribute Show node_security_group attribute object

          • arn string Required

            AWS security group ARN.

        • permissions_boundary_policy object Required

          Policy identifies an AWS policy.

          Hide permissions_boundary_policy attribute Show permissions_boundary_policy attribute object

          • arn string Required

            AWS policy ARN.

        • redpanda_agent_security_group object Required

          Security Group identifies AWS security group.

          Hide redpanda_agent_security_group attribute Show redpanda_agent_security_group attribute object

          • arn string Required

            AWS security group ARN.

        • redpanda_connect_node_group_instance_profile object

          AWS instance profile.

          Hide redpanda_connect_node_group_instance_profile attribute Show redpanda_connect_node_group_instance_profile attribute object

          • arn string Required

            AWS instance profile ARN.

        • redpanda_connect_security_group object

          Security Group identifies AWS security group.

          Hide redpanda_connect_security_group attribute Show redpanda_connect_security_group attribute object

          • arn string Required

            AWS security group ARN.

        • redpanda_node_group_instance_profile object Required

          AWS instance profile.

          Hide redpanda_node_group_instance_profile attribute Show redpanda_node_group_instance_profile attribute object

          • arn string Required

            AWS instance profile ARN.

        • redpanda_node_group_security_group object Required

          Security Group identifies AWS security group.

          Hide redpanda_node_group_security_group attribute Show redpanda_node_group_security_group attribute object

          • arn string Required

            AWS security group ARN.

        • utility_node_group_instance_profile object Required

          AWS instance profile.

          Hide utility_node_group_instance_profile attribute Show utility_node_group_instance_profile attribute object

          • arn string Required

            AWS instance profile ARN.

        • utility_security_group object Required

          Security Group identifies AWS security group.

          Hide utility_security_group attribute Show utility_security_group attribute object

          • arn string Required

            AWS security group ARN.

      • azure object

        Azure resources created and managed by user, and required to deploy the Redpanda cluster.

        Hide azure attributes Show azure attributes object

        • cidrs object Required

          Additional CIDRs allocated to Redpanda cluster.

          Hide cidrs attribute Show cidrs attribute object

          • aks_service_cidr string Required

            CIDR used by AKS Kubernetes services.

        • key_vaults object Required

          Azure key vaults used by Redpanda Cluster. All key vaults shall be in redpanda_resource_group.

          Hide key_vaults attributes Show key_vaults attributes object

          • console_vault object Required

            Azure Key Vault.

            Hide console_vault attribute Show console_vault attribute object

            • name string Required
          • management_vault object Required

            Azure Key Vault.

            Hide management_vault attribute Show management_vault attribute object

            • name string Required
        • resource_groups object Required

          Azure resource groups holding the Redpanda cluster resources.

          Hide resource_groups attributes Show resource_groups attributes object

          • iam_resource_group object Required

            Azure Resource Group Specification

            Hide iam_resource_group attribute Show iam_resource_group attribute object

            • name string Required
          • redpanda_resource_group object Required

            Azure Resource Group Specification

            Hide redpanda_resource_group attribute Show redpanda_resource_group attribute object

            • name string Required
          • storage_resource_group object Required

            Azure Resource Group Specification

            Hide storage_resource_group attribute Show storage_resource_group attribute object

            • name string Required
        • security_groups object Required

          Azure security groups for Redpanda Cluster. All security groups shall be in the network resource group.

          Hide security_groups attribute Show security_groups attribute object

          • redpanda_security_group object Required

            Azure security group.

            Hide redpanda_security_group attribute Show redpanda_security_group attribute object

            • name string Required
        • tiered_cloud_storage object Required

          Azure Bucket Specification

          Hide tiered_cloud_storage attributes Show tiered_cloud_storage attributes object

          • resource_group object

            Azure Resource Group Specification

            Hide resource_group attribute Show resource_group attribute object

            • name string Required
          • storage_account_name string Required
          • storage_container_name string Required
        • user_assigned_identities object Required

          Azure user assigned identities used by Redpanda cluster. All identities shall be in iam_resource_group.

          Hide user_assigned_identities attributes Show user_assigned_identities attributes object

          • agent_user_assigned_identity object Required

            Azure user assigned identity.

            Hide agent_user_assigned_identity attribute Show agent_user_assigned_identity attribute object

            • name string Required
          • aks_user_assigned_identity object Required

            Azure user assigned identity.

            Hide aks_user_assigned_identity attribute Show aks_user_assigned_identity attribute object

            • name string Required
          • cert_manager_assigned_identity object Required

            Azure user assigned identity.

            Hide cert_manager_assigned_identity attribute Show cert_manager_assigned_identity attribute object

            • name string Required
          • external_dns_assigned_identity object Required

            Azure user assigned identity.

            Hide external_dns_assigned_identity attribute Show external_dns_assigned_identity attribute object

            • name string Required
          • kafka_connect_assigned_identity object Required

            Azure user assigned identity.

            Hide kafka_connect_assigned_identity attribute Show kafka_connect_assigned_identity attribute object

            • name string Required
          • redpanda_cluster_assigned_identity object Required

            Azure user assigned identity.

            Hide redpanda_cluster_assigned_identity attribute Show redpanda_cluster_assigned_identity attribute object

            • name string Required
          • redpanda_connect_api_assigned_identity object Required

            Azure user assigned identity.

            Hide redpanda_connect_api_assigned_identity attribute Show redpanda_connect_api_assigned_identity attribute object

            • name string Required
          • redpanda_connect_assigned_identity object Required

            Azure user assigned identity.

            Hide redpanda_connect_assigned_identity attribute Show redpanda_connect_assigned_identity attribute object

            • name string Required
          • redpanda_console_assigned_identity object Required

            Azure user assigned identity.

            Hide redpanda_console_assigned_identity attribute Show redpanda_console_assigned_identity attribute object

            • name string Required
          • redpanda_operator_assigned_identity object Required

            Azure user assigned identity.

            Hide redpanda_operator_assigned_identity attribute Show redpanda_operator_assigned_identity attribute object

            • name string Required
      • gcp object

        GCP resources created and managed by user, and required to deploy the Redpanda cluster. See Create a BYOVPC Cluster on GCP.

        Hide gcp attributes Show gcp attributes object

        • agent_service_account object Required

          GCP service account.

          Hide agent_service_account attribute Show agent_service_account attribute object

          • email string Required

            GCP service account email.

        • connector_service_account object Required

          GCP service account.

          Hide connector_service_account attribute Show connector_service_account attribute object

          • email string Required

            GCP service account email.

        • console_service_account object Required

          GCP service account.

          Hide console_service_account attribute Show console_service_account attribute object

          • email string Required

            GCP service account email.

        • gke_service_account object Required

          GCP service account.

          Hide gke_service_account attribute Show gke_service_account attribute object

          • email string Required

            GCP service account email.

        • psc_nat_subnet_name string

          NAT subnet name if GCP Private Service Connect (a.k.a Private Link) is enabled. If it is used for PSC v1, use psc_v2_nat_subnet_name to set NAT subnet name for PSC v2.

        • psc_v2_nat_subnet_name string

          NAT subnet name for PSC v2 if GCP Private Service Connect (a.k.a Private Link) is enabled and psc_nat_subnet_name is used for PSC v1.

        • redpanda_cluster_service_account object Required

          GCP service account.

          Hide redpanda_cluster_service_account attribute Show redpanda_cluster_service_account attribute object

          • email string Required

            GCP service account email.

        • redpanda_connect_api_service_account object Required

          GCP service account.

          Hide redpanda_connect_api_service_account attribute Show redpanda_connect_api_service_account attribute object

          • email string Required

            GCP service account email.

        • redpanda_connect_service_account object Required

          GCP service account.

          Hide redpanda_connect_service_account attribute Show redpanda_connect_service_account attribute object

          • email string Required

            GCP service account email.

        • redpanda_operator_service_account object

          GCP service account.

          Hide redpanda_operator_service_account attribute Show redpanda_operator_service_account attribute object

          • email string Required

            GCP service account email.

        • subnet object Required

          GCP subnet properties. See the official GCP API reference.

          Hide subnet attributes Show subnet attributes object

          • k8s_master_ipv4_range string Required

            Kubernetes Master IPv4 range, e.g. 10.0.0.0/24.

          • name string Required

            Subnet name.

          • secondary_ipv4_range_pods object Required

            Secondary IPv4 range.

            Hide secondary_ipv4_range_pods attribute Show secondary_ipv4_range_pods attribute object

            • name string
          • secondary_ipv4_range_services object Required

            Secondary IPv4 range.

            Hide secondary_ipv4_range_services attribute Show secondary_ipv4_range_services attribute object

            • name string
        • tiered_storage_bucket object Required

          GCP storage bucket properties.

          Hide tiered_storage_bucket attribute Show tiered_storage_bucket attribute object

          • name string Required

            Name of GCP storage bucket. See the official GCP documentation for naming restrictions.

    • dataplane_api object

      Cluster's Data Plane API properties.

      Hide dataplane_api attribute Show dataplane_api attribute object

      • url string

        Data Plane API URL.

    • desired_redpanda_version string

      Desired Redpanda version of the cluster.

    • gcp_global_access_enabled boolean | null
    • gcp_private_service_connect object
      Hide gcp_private_service_connect attributes Show gcp_private_service_connect attributes object

      • consumer_accept_list array[object]

        List of consumers that are allowed to connect to Redpanda GCP PSC (Private Service Connect) service attachment.

        GCP Private Service Connect consumer specifications.

        Hide consumer_accept_list attribute Show consumer_accept_list attribute object

        • source string

          Either the GCP project number or its alphanumeric ID.

      • enabled boolean

        Whether Redpanda GCP Private Service Connect is enabled.

      • global_access_enabled boolean

        Whether global access is enabled.

      • http_proxy_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • kafka_api_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • schema_registry_auth_mode string

        Private link authentication mode.

        • PRIVATE_LINK_AUTH_MODE_MATCH: Match the authentication methods configured for the normal API endpoint, i.e. Kafka, HTTP Proxy, or Schema Registry.
        • PRIVATE_LINK_AUTH_MODE_SASL: SASL authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS: mTLS authentication mode only.
        • PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL: Both SASL and mTLS authentication modes.
        • PRIVATE_LINK_AUTH_MODE_NONE: Neither SASL or mTLS is enabled for Private Link.

        Values are PRIVATE_LINK_AUTH_MODE_MATCH, PRIVATE_LINK_AUTH_MODE_SASL, PRIVATE_LINK_AUTH_MODE_MTLS, PRIVATE_LINK_AUTH_MODE_MTLS_AND_SASL, or PRIVATE_LINK_AUTH_MODE_NONE.

      • status object
        Hide status attributes Show status attributes object

        • connected_endpoints array[object]

          List of VPC endpoints with established connections to GCP Private Service Connect.

          ConnectedEndpoint defines endpoint connection connected to Redpanda GCP PSC (Private Service Connect) service.

          Hide connected_endpoints attributes Show connected_endpoints attributes object

          • connection_id string

            Connection ID of the endpoint.

          • consumer_network string

            Network of the consumer connecting to Redpanda GCP Private Service Connect service. See the official GCP documentation for Private Service Connect.

          • endpoint string

            Connection endpoint. See the official GCP API reference for Private Service Connect.

          • status string

            Endpoint status (ACCEPTED | REJECTED).

            The ServiceAttachment API resource (https://cloud.google.com/compute/docs/reference/rest/v1/serviceAttachments) does have more fields, such as connection ID & consumer network, but the Terraform provider (https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_service_attachment#nested_connected_endpoints) doesn't return them as outputs.

        • created_at string(date-time)

          Redpanda GCP Private Service Connect service creation timestamp.

        • deleted_at string(date-time)

          Redpanda GCP Private Service Connect service deletion timestamp.

        • dns_a_records array[string]

          Customer-created DNS A records that point at the PSC endpoint on the consumer side.

        • kafka_api_node_base_port integer(int32)

          Kafka API node service base port. The port for node i (0 .. node_count-1) is kafka_api_node_base_port + i.

        • kafka_api_seed_port integer(int32)

          Kafka API seed service port.

        • redpanda_proxy_node_base_port integer(int32)

          HTTP Proxy node service base port. The port for node i (0 .. node_count-1) is redpanda_proxy_node_base_port + i.

        • redpanda_proxy_seed_port integer(int32)

          HTTP Proxy seed service port.

        • schema_registry_seed_port integer(int32)

          Schema Registry seed service port.

        • seed_hostname string

          Hostname for clients to initiate connections to the APIs exposed through Private Service Connect.

        • service_attachment string

          Service attachment used by consumers to create endpoint connections to Redpanda GCP Private Service Connect service.

    • http_proxy object

      HTTP Proxy properties.

      Hide http_proxy attributes Show http_proxy attributes object

      • all_urls object

        The endpoints of Redpanda HTTP Proxy or Schema Registry.

        Hide all_urls attributes Show all_urls attributes object

        • mtls string

          URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.

        • private_link_mtls string

          URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.

        • private_link_sasl string

          URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.

        • sasl string

          URL of the seed broker for SASL. If SASL is not enabled, the field is empty.

      • mtls object

        mTLS configuration.

        Hide mtls attributes Show mtls attributes object

        • ca_certificates_pem array[string]

          CA certificate in PEM format.

        • enabled boolean

          Whether mTLS is enabled.

        • principal_mapping_rules array[string]

          Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.

      • sasl object
        Hide sasl attribute Show sasl attribute object

        • enabled boolean

          Whether SASL is enabled.

      • url string

        HTTP Proxy URL of cluster.

    • id string

      ID of the cluster. ID is an output from the Create Cluster endpoint and cannot be set by the caller.

    • internet_gateways array[string]

      InternetGateway information of the cluster.

    • kafka_api object

      Cluster's Kafka API properties.

      Hide kafka_api attributes Show kafka_api attributes object

      • all_seed_brokers object

        Seed brokers of Redpanda Kafka API.

        Hide all_seed_brokers attributes Show all_seed_brokers attributes object

        • mtls string

          URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.

        • private_link_mtls string

          URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.

        • private_link_sasl string

          URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.

        • sasl string

          URL of the seed broker for SASL. If SASL is not enabled, the field is empty.

      • mtls object

        mTLS configuration.

        Hide mtls attributes Show mtls attributes object

        • ca_certificates_pem array[string]

          CA certificate in PEM format.

        • enabled boolean

          Whether mTLS is enabled.

        • principal_mapping_rules array[string]

          Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.

      • sasl object
        Hide sasl attribute Show sasl attribute object

        • enabled boolean

          Whether SASL is enabled.

      • seed_brokers array[string]

        Kafka API Seed Brokers (also known as Bootstrap servers).

    • kafka_connect object
      Hide kafka_connect attribute Show kafka_connect attribute object

      • enabled boolean
    • maintenance_window_config object

      Resource describing the maintenance window configuration of a cluster.

      Hide maintenance_window_config attributes Show maintenance_window_config attributes object

      • anytime object
      • day_hour object
        Hide day_hour attributes Show day_hour attributes object

        • day_of_week string

          Represents a day of the week.

          • MONDAY: Monday
          • TUESDAY: Tuesday
          • WEDNESDAY: Wednesday
          • THURSDAY: Thursday
          • FRIDAY: Friday
          • SATURDAY: Saturday
          • SUNDAY: Sunday

          Values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, or SUNDAY.

        • hour_of_day integer(int32)
      • unspecified object
    • name string

      Unique name of the cluster.

    • network_id string

      Network ID where cluster is placed.

    • prometheus object

      Prometheus metrics endpoint properties.

      Hide prometheus attribute Show prometheus attribute object

      • url string

        Prometheus API URL.

    • read_replica_cluster_ids array[string]

      IDs of clusters which may create read-only topics from this cluster.

    • redpanda_console object

      Cluster's Redpanda Console properties.

      Hide redpanda_console attribute Show redpanda_console attribute object

      • url string

        Redpanda Console API URL.

    • redpanda_node_count integer(int32)
    • region string

      Region represents the name of the region where the cluster will be provisioned.

    • resource_group_id string

      Resource group ID of the cluster.

    • schema_registry object

      Cluster's Schema Registry properties.

      Hide schema_registry attributes Show schema_registry attributes object

      • all_urls object

        The endpoints of Redpanda HTTP Proxy or Schema Registry.

        Hide all_urls attributes Show all_urls attributes object

        • mtls string

          URL of the seed broker for mTLS. If mTLS is not enabled, the field is empty.

        • private_link_mtls string

          URL of the seed broker for private link with mTLS. If private link with mTLS is not enabled, the field is empty.

        • private_link_sasl string

          URL of the seed broker for private link with SASL. If private link with SASL is not enabled, the field is empty.

        • sasl string

          URL of the seed broker for SASL. If SASL is not enabled, the field is empty.

      • mtls object

        mTLS configuration.

        Hide mtls attributes Show mtls attributes object

        • ca_certificates_pem array[string]

          CA certificate in PEM format.

        • enabled boolean

          Whether mTLS is enabled.

        • principal_mapping_rules array[string]

          Principal mapping rules for mTLS authentication. Only valid for Kafka API. See the Redpanda documentation on configuring authentication.

      • sasl object
        Hide sasl attribute Show sasl attribute object

        • enabled boolean

          Whether SASL is enabled.

      • url string

        Schema Registry URL.

    • state string

      State describes the state of the cluster.

      Values are STATE_CREATING_AGENT, STATE_CREATING, STATE_READY, STATE_DELETING, STATE_DELETING_AGENT, STATE_UPGRADING, STATE_FAILED, or STATE_SUSPENDED.

    • state_description object

      Describes errors

      Hide state_description attributes Show state_description attributes object

      • code string(int32)

        RPC status code, as described here.

        Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

      • details array[object]

        A list of messages that carries the error details.

        Details of the error.

        Details of the error.

        One of:

        BadRequest object ErrorInfo object QuotaFailure object Help object

        Describes violations in a client request. This error type focuses on the syntactic aspects of the request.

        Hide attributes Show attributes

        • @type string

          Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

          Value is type.googleapis.com/google.rpc.BadRequest.

        • field_violations array[object]

          Describes all violations in a client request.

          A message type used to describe a single bad request field.

          Hide field_violations attributes Show field_violations attributes object

          • description string

            A description of why the request element is bad.

          • field string

            A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.

            Consider the following:

            message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; }

            optional string email = 1; repeated EmailType type = 2; }

            string full_name = 1; repeated EmailAddress email_addresses = 2; }

            In this example, in proto field could take one of the following values:

            • full_name for a violation in the full_name value
            • email_addresses[1].email for a violation in the email field of the first email_addresses message
            • email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.

            In JSON, the same values are represented as:

            • fullName for a violation in the fullName value
            • emailAddresses[1].email for a violation in the email field of the first emailAddresses message
            • emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
          • localized_message object

            Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

            Hide localized_message attributes Show localized_message attributes object

            • locale string
            • message string

              The localized error message in the above locale.

          • reason string

            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.

        Describes the cause of the error with structured details.

        Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:

        { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } }

        This response indicates that the pubsub.googleapis.com API is not enabled.

        Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:

        { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }

        Hide attributes Show attributes

        • @type string

          Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

          Value is type.googleapis.com/google.rpc.ErrorInfo.

        • domain string

          The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

        • metadata object

          Additional structured details about this error.

          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 instances that can be created in a single (batch) request.

          Hide metadata attribute Show metadata attribute object

          • * string Additional properties
        • reason string

          The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. 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.

        Describes how a quota check failed.

        For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.

        Also see RetryInfo and Help types for other details about handling a quota failure.

        Hide attributes Show attributes

        • @type string

          Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

          Value is type.googleapis.com/google.rpc.QuotaFailure.

        • violations array[object]

          Describes all quota violations.

          A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.

          Hide violations attributes Show violations attributes object

          • api_service string

            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".

          • description string

            A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.

            For example: "Service disabled" or "Daily Limit for read operations exceeded".

          • future_quota_value string(int64) | null

            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.

          • quota_dimensions object

            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.

            Hide quota_dimensions attribute Show quota_dimensions attribute object

            • * string Additional properties
          • quota_id string

            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".

          • quota_metric string

            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".

          • quota_value string(int64)

            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.

          • subject string

            The subject on which the quota check failed. For example, "clientip:" or "project:".

        Provides links to documentation or for performing an out of band action.

        For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

        Hide attributes Show attributes

        • @type string

          Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

          Value is type.googleapis.com/google.rpc.Help.

        • links array[object]

          URL(s) pointing to additional information on handling the current error.

          Describes a URL link.

          Hide links attributes Show links attributes object

          • description string

            Describes what the link offers.

          • url string

            The URL of the link.

      • message string

        Detailed error message. No compatibility guarantees are given for the text contained in this message.

    • throughput_tier string

      Throughput tier of the cluster.

    • type string

      Cluster type. Type is immutable and can only be set on cluster creation.

      Values are TYPE_DEDICATED or TYPE_BYOC.

    • updated_at string(date-time)

      Cluster update timestamp.

    • zones array[string]

      Zones of the cluster. Must be valid zones within the selected region. If multiple zones are used, the cluster is a multi-AZ cluster.

• 404 application/json

  Not Found

  Hide response attributes Show response attributes object

  • code string(int32)

    RPC status code, as described here.

    Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

  • details array[object]

    A list of messages that carries the error details.

    Details of the error.

    Details of the error.

    One of:

    BadRequest object ErrorInfo object QuotaFailure object Help object

    Describes violations in a client request. This error type focuses on the syntactic aspects of the request.

    Hide attributes Show attributes

    • @type string

      Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

      Value is type.googleapis.com/google.rpc.BadRequest.

    • field_violations array[object]

      Describes all violations in a client request.

      A message type used to describe a single bad request field.

      Hide field_violations attributes Show field_violations attributes object

      • description string

        A description of why the request element is bad.

      • field string

        A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.

        Consider the following:

        message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; }

        optional string email = 1; repeated EmailType type = 2; }

        string full_name = 1; repeated EmailAddress email_addresses = 2; }

        In this example, in proto field could take one of the following values:

        • full_name for a violation in the full_name value
        • email_addresses[1].email for a violation in the email field of the first email_addresses message
        • email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.

        In JSON, the same values are represented as:

        • fullName for a violation in the fullName value
        • emailAddresses[1].email for a violation in the email field of the first emailAddresses message
        • emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
      • localized_message object

        Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

        Hide localized_message attributes Show localized_message attributes object

        • locale string
        • message string

          The localized error message in the above locale.

      • reason string

        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.

    Describes the cause of the error with structured details.

    Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:

    { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } }

    This response indicates that the pubsub.googleapis.com API is not enabled.

    Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:

    { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }

    Hide attributes Show attributes

    • @type string

      Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

      Value is type.googleapis.com/google.rpc.ErrorInfo.

    • domain string

      The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

    • metadata object

      Additional structured details about this error.

      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 instances that can be created in a single (batch) request.

      Hide metadata attribute Show metadata attribute object

      • * string Additional properties
    • reason string

      The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. 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.

    Describes how a quota check failed.

    For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.

    Also see RetryInfo and Help types for other details about handling a quota failure.

    Hide attributes Show attributes

    • @type string

      Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

      Value is type.googleapis.com/google.rpc.QuotaFailure.

    • violations array[object]

      Describes all quota violations.

      A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.

      Hide violations attributes Show violations attributes object

      • api_service string

        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".

      • description string

        A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.

        For example: "Service disabled" or "Daily Limit for read operations exceeded".

      • future_quota_value string(int64) | null

        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.

      • quota_dimensions object

        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.

        Hide quota_dimensions attribute Show quota_dimensions attribute object

        • * string Additional properties
      • quota_id string

        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".

      • quota_metric string

        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".

      • quota_value string(int64)

        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.

      • subject string

        The subject on which the quota check failed. For example, "clientip:" or "project:".

    Provides links to documentation or for performing an out of band action.

    For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

    Hide attributes Show attributes

    • @type string

      Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

      Value is type.googleapis.com/google.rpc.Help.

    • links array[object]

      URL(s) pointing to additional information on handling the current error.

      Describes a URL link.

      Hide links attributes Show links attributes object

      • description string

        Describes what the link offers.

      • url string

        The URL of the link.

  • message string

    Detailed error message. No compatibility guarantees are given for the text contained in this message.

• 500 application/json

  Internal Server Error. Please reach out to support.

  Hide response attributes Show response attributes object

  • code string(int32)

    RPC status code, as described here.

    Values are OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT, DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED, UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED, OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, or DATA_LOSS.

  • details array[object]

    A list of messages that carries the error details.

    Details of the error.

    Details of the error.

    One of:

    BadRequest object ErrorInfo object QuotaFailure object Help object

    Describes violations in a client request. This error type focuses on the syntactic aspects of the request.

    Hide attributes Show attributes

    • @type string

      Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

      Value is type.googleapis.com/google.rpc.BadRequest.

    • field_violations array[object]

      Describes all violations in a client request.

      A message type used to describe a single bad request field.

      Hide field_violations attributes Show field_violations attributes object

      • description string

        A description of why the request element is bad.

      • field string

        A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.

        Consider the following:

        message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; }

        optional string email = 1; repeated EmailType type = 2; }

        string full_name = 1; repeated EmailAddress email_addresses = 2; }

        In this example, in proto field could take one of the following values:

        • full_name for a violation in the full_name value
        • email_addresses[1].email for a violation in the email field of the first email_addresses message
        • email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.

        In JSON, the same values are represented as:

        • fullName for a violation in the fullName value
        • emailAddresses[1].email for a violation in the email field of the first emailAddresses message
        • emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
      • localized_message object

        Provides a localized error message that is safe to return to the user which can be attached to an RPC error.

        Hide localized_message attributes Show localized_message attributes object

        • locale string
        • message string

          The localized error message in the above locale.

      • reason string

        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.

    Describes the cause of the error with structured details.

    Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled:

    { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } }

    This response indicates that the pubsub.googleapis.com API is not enabled.

    Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock:

    { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }

    Hide attributes Show attributes

    • @type string

      Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

      Value is type.googleapis.com/google.rpc.ErrorInfo.

    • domain string

      The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".

    • metadata object

      Additional structured details about this error.

      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 instances that can be created in a single (batch) request.

      Hide metadata attribute Show metadata attribute object

      • * string Additional properties
    • reason string

      The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. 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.

    Describes how a quota check failed.

    For example if a daily limit was exceeded for the calling project, a service could respond with a QuotaFailure detail containing the project id and the description of the quota limit that was exceeded. If the calling project hasn't enabled the service in the developer console, then a service could respond with the project id and set service_disabled to true.

    Also see RetryInfo and Help types for other details about handling a quota failure.

    Hide attributes Show attributes

    • @type string

      Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

      Value is type.googleapis.com/google.rpc.QuotaFailure.

    • violations array[object]

      Describes all quota violations.

      A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.

      Hide violations attributes Show violations attributes object

      • api_service string

        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".

      • description string

        A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.

        For example: "Service disabled" or "Daily Limit for read operations exceeded".

      • future_quota_value string(int64) | null

        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.

      • quota_dimensions object

        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.

        Hide quota_dimensions attribute Show quota_dimensions attribute object

        • * string Additional properties
      • quota_id string

        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".

      • quota_metric string

        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".

      • quota_value string(int64)

        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.

      • subject string

        The subject on which the quota check failed. For example, "clientip:" or "project:".

    Provides links to documentation or for performing an out of band action.

    For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

    Hide attributes Show attributes

    • @type string

      Fully qualified protobuf type name of the underlying response, prefixed with type.googleapis.com/.

      Value is type.googleapis.com/google.rpc.Help.

    • links array[object]

      URL(s) pointing to additional information on handling the current error.

      Describes a URL link.

      Hide links attributes Show links attributes object

      • description string

        Describes what the link offers.

      • url string

        The URL of the link.

  • message string

    Detailed error message. No compatibility guarantees are given for the text contained in this message.