{
  "swagger": "2.0",
  "info": {
    "title": "global/nextgen/v1/region.proto",
    "version": "version not set"
  },
  "tags": [
    {
      "name": "RegionService"
    }
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {},
  "definitions": {
    "ListByocVcpuPoolsResponsePool": {
      "type": "object",
      "properties": {
        "resourcePoolId": {
          "type": "string",
          "format": "uint64",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "readOnly": true
        },
        "dataplaneId": {
          "type": "string",
          "description": "The control-plane recorded dataplane locator used by clients for O11Y discovery.\nIts presence does not guarantee runtime discovery or metrics query success.",
          "readOnly": true
        },
        "vcpusLimit": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "vcpusUsed": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "isDefault": {
          "type": "boolean",
          "description": "Whether this pool is the default BYOC pool for the current organization\nunder the same cloud provider and region.",
          "readOnly": true
        },
        "highAvailabilityType": {
          "description": "Availability scope of the underlying resource pool.",
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ResourcePoolHighAvailabilityType"
            }
          ]
        },
        "zoneConfig": {
          "description": "Runtime placement zones reported by dataplane-manager for the resource pool.",
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ResourcePoolZoneConfig"
            }
          ]
        },
        "state": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/ListByocVcpuPoolsResponsePoolState"
            }
          ]
        },
        "tidbInstances": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/ListByocVcpuPoolsResponseTidbInstance"
          },
          "readOnly": true
        }
      }
    },
    "ListByocVcpuPoolsResponsePoolState": {
      "type": "string",
      "enum": [
        "AVAILABLE",
        "MODIFYING"
      ]
    },
    "ListByocVcpuPoolsResponseTidbInstance": {
      "type": "object",
      "properties": {
        "clusterId": {
          "type": "string",
          "format": "uint64",
          "readOnly": true
        },
        "baseState": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/globalnextgenv1ClusterState"
            }
          ]
        },
        "deleting": {
          "type": "boolean",
          "readOnly": true
        }
      }
    },
    "commonv1RegionState": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ]
    },
    "commonv1ServicePlan": {
      "type": "string",
      "enum": [
        "Starter",
        "Essential",
        "Premium",
        "BYOC",
        "Premium_Reserved",
        "Essential_V2"
      ]
    },
    "globalcommonv1CloudProvider": {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/definitions/v1CloudProviderName"
        },
        "displayName": {
          "type": "string"
        },
        "state": {
          "$ref": "#/definitions/v1CloudProviderState"
        },
        "regions": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/globalcommonv1Region"
          }
        },
        "isPublic": {
          "type": "boolean"
        },
        "servicePlan": {
          "$ref": "#/definitions/commonv1ServicePlan"
        },
        "servicePlans": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/commonv1ServicePlan"
          }
        }
      },
      "required": [
        "id",
        "displayName"
      ]
    },
    "globalcommonv1Region": {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/definitions/v1RegionName"
        },
        "cloudProviderId": {
          "$ref": "#/definitions/v1CloudProviderName"
        },
        "displayName": {
          "type": "string",
          "title": "display name of the region"
        },
        "openedTenantIds": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uint64"
          },
          "title": "if public is false, only these tenants can use this region"
        },
        "sortPriority": {
          "type": "integer",
          "format": "int32",
          "title": "not used now"
        },
        "area": {
          "type": "string",
          "title": "for example: Europe, Americas"
        },
        "countryCode": {
          "type": "string",
          "title": "such as: CN, US"
        },
        "state": {
          "title": "region state, if state is inactive, the region is not available, can not use it",
          "allOf": [
            {
              "$ref": "#/definitions/commonv1RegionState"
            }
          ]
        },
        "isPublic": {
          "type": "boolean",
          "title": "whether the region is public, if true, all organizations can use it"
        },
        "defaultBackupTime": {
          "type": "string",
          "title": "cluster's default auto backup time in this region(dataflow-service), such as \"10:00\""
        },
        "serviceAddress": {
          "type": "string",
          "title": "regional service address"
        },
        "logicalName": {
          "type": "string",
          "title": "logic region name, such as \"cn-north-1\" , if local name is not equal to id , is a byoc region and only set public to false"
        },
        "servicePlan": {
          "title": "service plan of the region, if not set, use default service plan",
          "allOf": [
            {
              "$ref": "#/definitions/commonv1ServicePlan"
            }
          ]
        },
        "sharedBucketUrl": {
          "type": "string",
          "x-nullable": true,
          "title": "shared bucket url of the region, if not set, keep empty"
        },
        "opsAuditLogSetting": {
          "title": "ops audit log setting of the region",
          "allOf": [
            {
              "$ref": "#/definitions/v1RegionOpsAuditLogSetting"
            }
          ]
        },
        "regionWhiteLists": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/v1RegionWhiteList"
          }
        },
        "engineType": {
          "$ref": "#/definitions/v1RegionEngineType"
        },
        "sys9Config": {
          "$ref": "#/definitions/v1RegionSys9Config"
        }
      },
      "required": [
        "id",
        "cloudProviderId",
        "displayName"
      ]
    },
    "globalnextgenv1ClusterState": {
      "type": "string",
      "enum": [
        "CREATING",
        "AVAILABLE",
        "MODIFYING",
        "UNAVAILABLE",
        "DELETED",
        "PAUSING",
        "PAUSED",
        "RESUMING"
      ]
    },
    "globalnextgenv1ListCloudProvidersResponse": {
      "type": "object",
      "properties": {
        "cloudProviders": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/globalcommonv1CloudProvider"
          }
        }
      }
    },
    "globalnextgenv1ListRegionsResponse": {
      "type": "object",
      "properties": {
        "regions": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/globalcommonv1Region"
          }
        }
      }
    },
    "globalnextgenv1SelectRegionByOrgIdRequest": {
      "type": "object",
      "properties": {
        "organizationId": {
          "type": "string",
          "format": "uint64"
        },
        "cloudProviderId": {
          "$ref": "#/definitions/v1CloudProviderName"
        },
        "regionId": {
          "$ref": "#/definitions/v1RegionName"
        },
        "servicePlan": {
          "$ref": "#/definitions/commonv1ServicePlan"
        }
      },
      "required": [
        "organizationId",
        "cloudProviderId",
        "regionId"
      ]
    },
    "googlerpcStatus": {
      "type": "object",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32",
          "description": "The status code, which should be an enum value of\n[google.rpc.Code][google.rpc.Code]."
        },
        "message": {
          "type": "string",
          "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\n[google.rpc.Status.details][google.rpc.Status.details] field, or localized\nby the client."
        },
        "details": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/protobufAny"
          },
          "description": "A list of messages that carry the error details.  There is a common set of\nmessage types for APIs to use."
        }
      },
      "description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors)."
    },
    "nextgenv1ByocSharedComponentScaleConstraint": {
      "type": "object",
      "properties": {
        "componentType": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ByocSharedComponentType"
            }
          ]
        },
        "componentId": {
          "type": "string",
          "readOnly": true
        },
        "exists": {
          "type": "boolean",
          "readOnly": true
        },
        "phase": {
          "type": "string",
          "readOnly": true
        },
        "current": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleTarget"
            }
          ]
        },
        "blockingReasons": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleConstraintReason"
          },
          "readOnly": true
        },
        "nodeCountConstraints": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleNodeCountConstraints"
            }
          ]
        },
        "nodeSpecConstraints": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleNodeSpecConstraints"
            }
          ]
        }
      }
    },
    "nextgenv1ByocSharedComponentScaleConstraintReason": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "readOnly": true
        },
        "message": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "nextgenv1ByocSharedComponentScaleConstraints": {
      "type": "object",
      "properties": {
        "resourcePoolId": {
          "type": "string",
          "format": "uint64",
          "readOnly": true
        },
        "vcpusLimit": {
          "type": "string",
          "format": "uint64",
          "readOnly": true
        },
        "preview": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ByocSharedComponentScalePreviewSummary"
            }
          ]
        },
        "components": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleConstraint"
          },
          "readOnly": true
        }
      }
    },
    "nextgenv1ByocSharedComponentScaleNodeCountConstraints": {
      "type": "object",
      "properties": {
        "current": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "min": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "max": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "rule": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleNodeCountRule"
            }
          ]
        },
        "allowCrossZero": {
          "type": "boolean",
          "readOnly": true
        }
      }
    },
    "nextgenv1ByocSharedComponentScaleNodeCountRule": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "readOnly": true
        },
        "value": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        }
      }
    },
    "nextgenv1ByocSharedComponentScaleNodeSpecCandidate": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "readOnly": true
        },
        "cpu": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "memoryGi": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "available": {
          "type": "boolean",
          "readOnly": true
        },
        "isCurrent": {
          "type": "boolean",
          "readOnly": true
        },
        "reasons": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleConstraintReason"
          },
          "readOnly": true
        },
        "requiredMinSpec": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleRequiredMinSpec"
            }
          ]
        },
        "storageConstraints": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleStorageConstraint"
          },
          "readOnly": true
        }
      }
    },
    "nextgenv1ByocSharedComponentScaleNodeSpecConstraints": {
      "type": "object",
      "properties": {
        "current": {
          "type": "string",
          "readOnly": true
        },
        "candidates": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleNodeSpecCandidate"
          },
          "readOnly": true
        }
      }
    },
    "nextgenv1ByocSharedComponentScalePlanComponent": {
      "type": "object",
      "properties": {
        "componentType": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ByocSharedComponentType"
            }
          ]
        },
        "componentId": {
          "type": "string",
          "readOnly": true
        },
        "current": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleTarget"
            }
          ]
        },
        "target": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ByocSharedComponentScaleTarget"
            }
          ]
        },
        "allowed": {
          "type": "boolean",
          "readOnly": true
        },
        "blockingReasons": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        }
      }
    },
    "nextgenv1ByocSharedComponentScalePreviewSummary": {
      "type": "object",
      "properties": {
        "currentVcpusUsed": {
          "type": "string",
          "format": "uint64",
          "readOnly": true
        },
        "scalingVcpusUsed": {
          "type": "string",
          "format": "uint64",
          "readOnly": true
        },
        "maxVcpusLimit": {
          "type": "string",
          "format": "uint64",
          "readOnly": true
        },
        "allowed": {
          "type": "boolean",
          "readOnly": true
        },
        "blockingReasons": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        }
      }
    },
    "nextgenv1ByocSharedComponentScaleRequiredMinSpec": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "readOnly": true
        },
        "cpu": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "memoryGi": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        }
      }
    },
    "nextgenv1ByocSharedComponentScaleStorageConstraint": {
      "type": "object",
      "properties": {
        "storageName": {
          "type": "string",
          "readOnly": true
        },
        "resizable": {
          "type": "boolean",
          "readOnly": true
        },
        "currentSizeGi": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "maxSizeGi": {
          "type": "integer",
          "format": "int64",
          "x-nullable": true,
          "readOnly": true
        }
      }
    },
    "nextgenv1ByocSharedComponentScaleTarget": {
      "type": "object",
      "properties": {
        "nodeCount": {
          "type": "integer",
          "format": "int64",
          "x-nullable": true
        },
        "cpu": {
          "type": "integer",
          "format": "int64",
          "x-nullable": true
        },
        "memoryGi": {
          "type": "integer",
          "format": "int64",
          "x-nullable": true
        },
        "storages": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ByocSharedComponentStorage"
          }
        }
      }
    },
    "nextgenv1ByocSharedComponentStorage": {
      "type": "object",
      "properties": {
        "storageName": {
          "type": "string"
        },
        "sizeGi": {
          "type": "integer",
          "format": "int64",
          "x-nullable": true
        },
        "iops": {
          "type": "integer",
          "format": "int64",
          "x-nullable": true
        },
        "throughputMbs": {
          "type": "integer",
          "format": "int64",
          "x-nullable": true
        }
      },
      "required": [
        "storageName"
      ]
    },
    "nextgenv1ByocSharedComponentType": {
      "type": "string",
      "enum": [
        "BYOC_SHARED_COMPONENT_TYPE_TIKV",
        "BYOC_SHARED_COMPONENT_TYPE_TIFLASH_WRITE",
        "BYOC_SHARED_COMPONENT_TYPE_TIFLASH_COMPUTE"
      ]
    },
    "nextgenv1ListByocVcpuPoolsResponse": {
      "type": "object",
      "properties": {
        "groups": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ListByocVcpuPoolsResponseGroup"
          }
        }
      }
    },
    "nextgenv1ListByocVcpuPoolsResponseGroup": {
      "type": "object",
      "properties": {
        "region": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/globalcommonv1Region"
            }
          ]
        },
        "totalVcpusLimit": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "pools": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/ListByocVcpuPoolsResponsePool"
          },
          "readOnly": true
        }
      }
    },
    "nextgenv1ListNodeSpecsResponse": {
      "type": "object",
      "properties": {
        "nodeSpecs": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/v1ResourcePoolNodeSpec"
          }
        },
        "nodeCountOptions": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1NodeCountOptions"
            }
          ]
        },
        "totalSize": {
          "type": "integer",
          "format": "int32"
        },
        "nextPageToken": {
          "type": "string"
        }
      }
    },
    "nextgenv1ListRegionCapacitiesRequestUsageRequest": {
      "type": "object",
      "properties": {
        "startTime": {
          "type": "string",
          "format": "date-time",
          "title": "Reserved for future use to specify the start of the time range"
        },
        "endTime": {
          "type": "string",
          "format": "date-time",
          "description": "End time for the metrics query. The query will return historical data up to this timestamp."
        }
      },
      "required": [
        "endTime"
      ]
    },
    "nextgenv1ListRegionCapacitiesResponse": {
      "type": "object",
      "properties": {
        "capacities": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ListRegionCapacitiesResponseRegionCapacity"
          }
        }
      }
    },
    "nextgenv1ListRegionCapacitiesResponseRegionCapacity": {
      "type": "object",
      "properties": {
        "region": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/globalcommonv1Region"
            }
          ]
        },
        "totalVcpusLimit": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "usedVcpus": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "historyUsages": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ListRegionCapacitiesResponseUsageMetrics"
          },
          "title": "Historical usage metrics over time",
          "readOnly": true
        }
      }
    },
    "nextgenv1ListRegionCapacitiesResponseUsageMetrics": {
      "type": "object",
      "properties": {
        "metricsTime": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "usedVcpus": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        }
      }
    },
    "nextgenv1NodeCountOptions": {
      "type": "object",
      "properties": {
        "defaultNodeCount": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "minNodeCount": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "maxNodeCount": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "rule": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1NodeCountRule"
            }
          ]
        }
      }
    },
    "nextgenv1NodeCountRule": {
      "type": "object",
      "properties": {
        "type": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1NodeCountRuleType"
            }
          ]
        },
        "value": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        }
      }
    },
    "nextgenv1NodeCountRuleType": {
      "type": "string",
      "enum": [
        "NODE_COUNT_RULE_TYPE_NONE",
        "NODE_COUNT_RULE_TYPE_MULTIPLE_OF",
        "NODE_COUNT_RULE_TYPE_FIXED"
      ]
    },
    "nextgenv1NodeSpecComponentType": {
      "type": "string",
      "enum": [
        "NODE_SPEC_COMPONENT_TYPE_TIKV",
        "NODE_SPEC_COMPONENT_TYPE_TIFLASH"
      ]
    },
    "nextgenv1NodeSpecStorage": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "readOnly": true
        },
        "defaultSizeGi": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "minSizeGi": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "maxSizeGi": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "resizable": {
          "type": "boolean",
          "x-nullable": true,
          "readOnly": true
        },
        "currentSizeGi": {
          "type": "string",
          "format": "int64",
          "x-nullable": true,
          "readOnly": true
        }
      }
    },
    "nextgenv1PlanResourcePoolCidrResponse": {
      "type": "object",
      "properties": {
        "cloudProviderId": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/v1CloudProviderName"
            }
          ]
        },
        "regionId": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/v1RegionName"
            }
          ]
        },
        "policy": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ResourcePoolCidrPolicy"
            }
          ]
        },
        "exclusions": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ResourcePoolCidrExclusion"
          },
          "readOnly": true
        },
        "recommendationStatus": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1PlanResourcePoolCidrResponseRecommendationStatus"
            }
          ]
        },
        "recommendation": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ResourcePoolCidrRecommendation"
            }
          ]
        }
      }
    },
    "nextgenv1PlanResourcePoolCidrResponseRecommendationStatus": {
      "type": "string",
      "enum": [
        "AVAILABLE",
        "EXHAUSTED"
      ]
    },
    "nextgenv1ResourcePoolCidrExclusion": {
      "type": "object",
      "properties": {
        "type": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ResourcePoolCidrExclusionType"
            }
          ]
        },
        "cidr": {
          "type": "string",
          "readOnly": true
        },
        "resourcePoolId": {
          "type": "string",
          "format": "uint64",
          "x-nullable": true,
          "readOnly": true
        },
        "resourcePoolDisplayName": {
          "type": "string",
          "x-nullable": true,
          "readOnly": true
        },
        "regionId": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/v1RegionName"
            }
          ]
        },
        "cloudProviderId": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/v1CloudProviderName"
            }
          ]
        }
      }
    },
    "nextgenv1ResourcePoolCidrExclusionType": {
      "type": "string",
      "enum": [
        "RESOURCE_POOL",
        "O11Y_CLUSTER",
        "TIDB_CLOUD_RESERVED"
      ]
    },
    "nextgenv1ResourcePoolCidrPolicy": {
      "type": "object",
      "properties": {
        "supportedPrivateCidrs": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "allowedPrefixRanges": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ResourcePoolCidrPrefixRange"
          },
          "readOnly": true
        }
      }
    },
    "nextgenv1ResourcePoolCidrPrefixRange": {
      "type": "object",
      "properties": {
        "minPrefixLength": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "maxPrefixLength": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        }
      }
    },
    "nextgenv1ResourcePoolCidrRecommendation": {
      "type": "object",
      "properties": {
        "cidr": {
          "type": "string",
          "readOnly": true
        },
        "supportedNodeCount": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        }
      }
    },
    "nextgenv1ResourcePoolCidrValidationFinding": {
      "type": "object",
      "properties": {
        "code": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ResourcePoolCidrValidationFindingCode"
            }
          ]
        },
        "message": {
          "type": "string",
          "readOnly": true
        },
        "conflictingExclusion": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ResourcePoolCidrExclusion"
            }
          ]
        }
      }
    },
    "nextgenv1ResourcePoolCidrValidationFindingCode": {
      "type": "string",
      "enum": [
        "INVALID_CIDR",
        "CIDR_NOT_PRIVATE",
        "CIDR_PREFIX_UNSUPPORTED",
        "CIDR_OVERLAPS_RESOURCE_POOL",
        "CIDR_OVERLAPS_O11Y",
        "CIDR_OVERLAPS_RESERVED_NETWORK"
      ]
    },
    "nextgenv1ResourcePoolHighAvailabilityType": {
      "type": "string",
      "enum": [
        "REGIONAL",
        "ZONAL"
      ]
    },
    "nextgenv1ResourcePoolZoneConfig": {
      "type": "object",
      "properties": {
        "nodeZones": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Explicit node zones for the dataplane nodes.\nMust contain exactly 1 zone for ZONAL pools or exactly 3 zones for REGIONAL pools."
        }
      }
    },
    "nextgenv1ScaleByocSharedComponentsResponse": {
      "type": "object",
      "properties": {
        "preview": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1ByocSharedComponentScalePreviewSummary"
            }
          ]
        },
        "components": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ByocSharedComponentScalePlanComponent"
          },
          "readOnly": true
        },
        "operationId": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "nextgenv1ValidateResourcePoolCidrResponse": {
      "type": "object",
      "properties": {
        "cloudProviderId": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/v1CloudProviderName"
            }
          ]
        },
        "regionId": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/v1RegionName"
            }
          ]
        },
        "cidr": {
          "type": "string",
          "readOnly": true
        },
        "supportedNodeCount": {
          "type": "string",
          "format": "int64",
          "x-nullable": true,
          "readOnly": true
        },
        "blockingFindings": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1ResourcePoolCidrValidationFinding"
          },
          "readOnly": true
        }
      }
    },
    "protobufAny": {
      "type": "object",
      "properties": {
        "@type": {
          "type": "string",
          "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
        }
      },
      "additionalProperties": {},
      "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(\u0026foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n    // or ...\n    if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n      foo = any.unpack(Foo.getDefaultInstance());\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := \u0026pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := \u0026pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": \u003cstring\u003e,\n      \"lastName\": \u003cstring\u003e\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
    },
    "v1CloudProviderName": {
      "type": "string",
      "enum": [
        "AWS",
        "GCP",
        "AZURE",
        "ALICLOUD"
      ],
      "description": "Refer to terraform provider name: https://registry.terraform.io/browse/providers."
    },
    "v1CloudProviderState": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "INACTIVE"
      ]
    },
    "v1DefaultRegionProviderIdentity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uint64",
          "readOnly": true
        },
        "tenantId": {
          "type": "string",
          "format": "uint64"
        },
        "identity": {
          "type": "string"
        },
        "servicePlan": {
          "$ref": "#/definitions/commonv1ServicePlan"
        }
      },
      "required": [
        "tenantId",
        "identity",
        "servicePlan"
      ]
    },
    "v1ListRegionProviderIdentitiesResponse": {
      "type": "object",
      "properties": {
        "region": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/globalcommonv1Region"
            }
          ]
        },
        "regionProviderIdentities": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/v1RegionProviderIdentity"
          }
        },
        "defaultProviderIdentities": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/v1DefaultRegionProviderIdentity"
          }
        }
      }
    },
    "v1RegionEngineType": {
      "type": "string",
      "enum": [
        "MYSQL_COMPATIBLE",
        "POSTGRESQL_COMPATIBLE"
      ]
    },
    "v1RegionIdentifier": {
      "type": "object",
      "properties": {
        "orgRegion": {
          "$ref": "#/definitions/globalnextgenv1SelectRegionByOrgIdRequest"
        },
        "regionLogicalName": {
          "type": "string"
        }
      }
    },
    "v1RegionName": {
      "type": "string",
      "enum": [
        "AWS_US_EAST_2",
        "AWS_US_EAST_1",
        "AWS_US_WEST_1",
        "AWS_US_WEST_2",
        "AWS_AF_SOUTH_1",
        "AWS_AP_EAST_1",
        "AWS_AP_SOUTH_2",
        "AWS_AP_SOUTHEAST_3",
        "AWS_AP_SOUTHEAST_4",
        "AWS_AP_SOUTH_1",
        "AWS_AP_NORTHEAST_3",
        "AWS_AP_NORTHEAST_2",
        "AWS_AP_SOUTHEAST_1",
        "AWS_AP_SOUTHEAST_2",
        "AWS_AP_NORTHEAST_1",
        "AWS_CA_CENTRAL_1",
        "AWS_CA_WEST_1",
        "AWS_EU_CENTRAL_1",
        "AWS_EU_WEST_1",
        "AWS_EU_WEST_2",
        "AWS_EU_SOUTH_1",
        "AWS_EU_WEST_3",
        "AWS_EU_SOUTH_2",
        "AWS_EU_NORTH_1",
        "AWS_EU_CENTRAL_2",
        "AWS_IL_CENTRAL_1",
        "AWS_ME_SOUTH_1",
        "AWS_ME_CENTRAL_1",
        "AWS_SA_EAST_1",
        "AWS_AP_SOUTHEAST_5",
        "AWS_AP_SOUTHEAST_6",
        "AWS_AP_SOUTHEAST_7",
        "AWS_MX_CENTRAL_1",
        "GCP_ASIA_EAST1",
        "GCP_ASIA_EAST2",
        "GCP_ASIA_NORTHEAST1",
        "GCP_ASIA_NORTHEAST2",
        "GCP_ASIA_NORTHEAST3",
        "GCP_ASIA_SOUTH1",
        "GCP_ASIA_SOUTH2",
        "GCP_ASIA_SOUTHEAST1",
        "GCP_ASIA_SOUTHEAST2",
        "GCP_AUSTRALIA_SOUTHEAST1",
        "GCP_AUSTRALIA_SOUTHEAST2",
        "GCP_EUROPE_CENTRAL2",
        "GCP_EUROPE_NORTH1",
        "GCP_EUROPE_SOUTHWEST1",
        "GCP_EUROPE_WEST1",
        "GCP_EUROPE_WEST10",
        "GCP_EUROPE_WEST12",
        "GCP_EUROPE_WEST2",
        "GCP_EUROPE_WEST3",
        "GCP_EUROPE_WEST4",
        "GCP_EUROPE_WEST6",
        "GCP_EUROPE_WEST8",
        "GCP_EUROPE_WEST9",
        "GCP_ME_CENTRAL1",
        "GCP_ME_CENTRAL2",
        "GCP_ME_WEST1",
        "GCP_NORTHAMERICA_NORTHEAST1",
        "GCP_NORTHAMERICA_NORTHEAST2",
        "GCP_SOUTHAMERICA_EAST1",
        "GCP_SOUTHAMERICA_WEST1",
        "GCP_US_CENTRAL1",
        "GCP_US_EAST1",
        "GCP_US_EAST4",
        "GCP_US_EAST5",
        "GCP_US_SOUTH1",
        "GCP_US_WEST1",
        "GCP_US_WEST2",
        "GCP_US_WEST3",
        "GCP_US_WEST4",
        "AZURE_EASTUS",
        "AZURE_SOUTHCENTRALUS",
        "AZURE_WESTUS2",
        "AZURE_WESTUS3",
        "AZURE_AUSTRALIAEAST",
        "AZURE_SOUTHEASTASIA",
        "AZURE_NORTHEUROPE",
        "AZURE_SWEDENCENTRAL",
        "AZURE_UKSOUTH",
        "AZURE_WESTEUROPE",
        "AZURE_CENTRALUS",
        "AZURE_SOUTHAFRICANORTH",
        "AZURE_CENTRALINDIA",
        "AZURE_EASTASIA",
        "AZURE_JAPANEAST",
        "AZURE_KOREACENTRAL",
        "AZURE_CANADACENTRAL",
        "AZURE_FRANCECENTRAL",
        "AZURE_GERMANYWESTCENTRAL",
        "AZURE_ITALYNORTH",
        "AZURE_NORWAYEAST",
        "AZURE_POLANDCENTRAL",
        "AZURE_SPAINCENTRAL",
        "AZURE_SWITZERLANDNORTH",
        "AZURE_MEXICOCENTRAL",
        "AZURE_UAENORTH",
        "AZURE_BRAZILSOUTH",
        "AZURE_ISRAELCENTRAL",
        "AZURE_QATARCENTRAL",
        "AZURE_CENTRALUSSTAGE",
        "AZURE_EASTUSSTAGE",
        "AZURE_EASTUS2STAGE",
        "AZURE_NORTHCENTRALUSSTAGE",
        "AZURE_SOUTHCENTRALUSSTAGE",
        "AZURE_WESTUSSTAGE",
        "AZURE_WESTUS2STAGE",
        "AZURE_ASIA",
        "AZURE_ASIAPACIFIC",
        "AZURE_AUSTRALIA",
        "AZURE_BRAZIL",
        "AZURE_CANADA",
        "AZURE_EUROPE",
        "AZURE_FRANCE",
        "AZURE_GERMANY",
        "AZURE_GLOBAL",
        "AZURE_INDIA",
        "AZURE_ISRAEL",
        "AZURE_ITALY",
        "AZURE_JAPAN",
        "AZURE_KOREA",
        "AZURE_NEWZEALAND",
        "AZURE_NORWAY",
        "AZURE_POLAND",
        "AZURE_QATAR",
        "AZURE_SINGAPORE",
        "AZURE_SOUTHAFRICA",
        "AZURE_SWEDEN",
        "AZURE_SWITZERLAND",
        "AZURE_UAE",
        "AZURE_UK",
        "AZURE_UNITEDSTATES",
        "AZURE_UNITEDSTATESEUAP",
        "AZURE_EASTASIASTAGE",
        "AZURE_SOUTHEASTASIASTAGE",
        "AZURE_BRAZILUS",
        "AZURE_EASTUS2",
        "AZURE_EASTUSSTG",
        "AZURE_NORTHCENTRALUS",
        "AZURE_WESTUS",
        "AZURE_JAPANWEST",
        "AZURE_JIOINDIAWEST",
        "AZURE_CENTRALUSEUAP",
        "AZURE_EASTUS2EUAP",
        "AZURE_WESTCENTRALUS",
        "AZURE_SOUTHAFRICAWEST",
        "AZURE_AUSTRALIACENTRAL",
        "AZURE_AUSTRALIACENTRAL2",
        "AZURE_AUSTRALIASOUTHEAST",
        "AZURE_JIOINDIACENTRAL",
        "AZURE_KOREASOUTH",
        "AZURE_SOUTHINDIA",
        "AZURE_WESTINDIA",
        "AZURE_CANADAEAST",
        "AZURE_FRANCESOUTH",
        "AZURE_GERMANYNORTH",
        "AZURE_NORWAYWEST",
        "AZURE_SWITZERLANDWEST",
        "AZURE_UKWEST",
        "AZURE_UAECENTRAL",
        "AZURE_BRAZILSOUTHEAST",
        "ALICLOUD_AP_SOUTHEAST_1",
        "ALICLOUD_AP_NORTHEAST_1",
        "ALICLOUD_AP_NORTHEAST_2",
        "ALICLOUD_AP_SOUTHEAST_3",
        "ALICLOUD_AP_SOUTHEAST_5",
        "ALICLOUD_AP_SOUTHEAST_6",
        "ALICLOUD_AP_SOUTHEAST_7",
        "ALICLOUD_NA_SOUTH_1",
        "ALICLOUD_US_WEST_1",
        "ALICLOUD_US_EAST_1",
        "ALICLOUD_EU_CENTRAL_1",
        "ALICLOUD_EU_WEST_1",
        "ALICLOUD_ME_EAST_1",
        "ALICLOUD_ME_CENTRAL_1",
        "ALICLOUD_CN_HONGKONG"
      ],
      "description": "- AWS_US_EAST_2: AWS.\n - GCP_ASIA_EAST1: GCP.\n - AZURE_EASTUS: Azure\n - ALICLOUD_AP_SOUTHEAST_1: AliCloud",
      "title": "Refer to:\n  - AWS: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints.\n  - GCP: https://console.cloud.google.com/compute/zones\n  - Azure: https://gist.github.com/ausfestivus/04e55c7d80229069bf3bc75870630ec8"
    },
    "v1RegionOpsAuditLogSetting": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "logLocation": {
          "$ref": "#/definitions/v1RegionOpsAuditLogSettingLogLocation"
        },
        "logRotation": {
          "$ref": "#/definitions/v1RegionOpsAuditLogSettingLogRotation"
        }
      },
      "required": [
        "enabled"
      ]
    },
    "v1RegionOpsAuditLogSettingLogLocation": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/definitions/v1RegionOpsAuditLogSettingType"
        },
        "bucketUri": {
          "type": "string"
        },
        "roleArn": {
          "type": "string"
        },
        "externalId": {
          "type": "string"
        },
        "accountId": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "bucketUri",
        "roleArn",
        "externalId",
        "accountId"
      ]
    },
    "v1RegionOpsAuditLogSettingLogRotation": {
      "type": "object",
      "properties": {
        "fileSizeLimitInMb": {
          "type": "string",
          "format": "uint64"
        },
        "rotationIntervalInMin": {
          "type": "string",
          "format": "uint64"
        }
      },
      "required": [
        "fileSizeLimitInMb",
        "rotationIntervalInMin"
      ]
    },
    "v1RegionOpsAuditLogSettingType": {
      "type": "string",
      "enum": [
        "TYPE_STANDARD",
        "TYPE_CUSTOMIZED"
      ]
    },
    "v1RegionProviderIdentity": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uint64",
          "readOnly": true
        },
        "identity": {
          "type": "string"
        },
        "isDefault": {
          "type": "boolean"
        }
      },
      "required": [
        "identity"
      ]
    },
    "v1RegionSys9Config": {
      "type": "object",
      "properties": {
        "oemProfileRef": {
          "type": "string"
        },
        "authMode": {
          "type": "string"
        },
        "tokenTtlSec": {
          "type": "integer",
          "format": "int64"
        },
        "sessionRefreshBeforeSec": {
          "type": "integer",
          "format": "int64"
        },
        "retryPolicyRef": {
          "type": "string"
        }
      }
    },
    "v1RegionWhiteList": {
      "type": "object",
      "properties": {
        "servicePlan": {
          "$ref": "#/definitions/commonv1ServicePlan"
        },
        "isPublic": {
          "type": "boolean"
        },
        "openedTenantIds": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uint64"
          }
        }
      },
      "required": [
        "servicePlan"
      ]
    },
    "v1ResourcePoolNodeSpec": {
      "type": "object",
      "properties": {
        "nodeSpecKey": {
          "type": "string",
          "readOnly": true
        },
        "displayName": {
          "type": "string",
          "readOnly": true
        },
        "componentType": {
          "readOnly": true,
          "allOf": [
            {
              "$ref": "#/definitions/nextgenv1NodeSpecComponentType"
            }
          ]
        },
        "cpu": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "memoryGi": {
          "type": "string",
          "format": "int64",
          "readOnly": true
        },
        "isDefault": {
          "type": "boolean",
          "readOnly": true
        },
        "storages": {
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/nextgenv1NodeSpecStorage"
          },
          "readOnly": true
        }
      }
    },
    "v1UpdateRegionOpsAuditLogSettingResponse": {
      "type": "object",
      "properties": {
        "region": {
          "$ref": "#/definitions/globalcommonv1Region"
        }
      }
    }
  }
}