basePath: /api/v1/tcidm definitions: agent.CheckGcsAccessReq: properties: gcs_options: $ref: '#/definitions/agent.GcsOptions' gcs_url: type: string type: object agent.CheckGcsAccessResp: properties: error_msg: type: string type: object agent.CheckResult: properties: check_item: type: integer has_passed: type: boolean msg: type: string type: object agent.CheckS3AccessReq: properties: aws_access_key_id: type: string aws_secret_access_key: type: string external_id: type: string role_arn: type: string s3_url: type: string type: object agent.CheckS3AccessResp: properties: error_msg: type: string type: object agent.Cluster: properties: cluster_id: type: integer dev_tier: type: boolean namespace: type: string password: type: string read_timeout: description: unit is second type: integer user: type: string write_timeout: type: integer type: object agent.CsvConfig: properties: backslash_escape: type: boolean delimiter: type: string header: type: boolean separator: type: string trim_last_separator: type: boolean type: object agent.ExecSQLReq: properties: cluster: $ref: '#/definitions/agent.Cluster' column_num: description: column_num represents the column numbers in the SQL sentence type: integer sql: type: string type: object agent.ExecSQLResp: properties: error_msg: type: string rows: items: $ref: '#/definitions/agent.Row' type: array sql_result: type: string type: object agent.GcsOptions: properties: impersonate_service_account: type: string type: object agent.GetClusterTablesResp: properties: schemas: items: $ref: '#/definitions/agent.Schema' type: array type: object agent.LightningPrecheckReq: properties: check_items: items: type: integer type: array cluster_name_prefix: type: string cluster_namespace: type: string gen_gcp_credential: type: boolean lightning_config: type: string type: object agent.LightningPrecheckResp: properties: base_resp: $ref: '#/definitions/base.BaseResp' check_results: items: $ref: '#/definitions/agent.CheckResult' type: array type: object agent.PrecheckImportFileReq: properties: aws_access_key_id: type: string aws_external_id: type: string aws_role_arn: type: string aws_secret_access_key: type: string cluster: $ref: '#/definitions/agent.Cluster' csv_config: $ref: '#/definitions/agent.CsvConfig' data_format: type: integer data_source: type: integer sources: items: $ref: '#/definitions/agent.PrecheckImportFileReq_Source' type: array type: object agent.PrecheckImportFileReq_Source: properties: file: type: string table: $ref: '#/definitions/common.Table' type: object agent.Row: properties: column_values: items: type: string type: array type: object agent.Schema: properties: schema_name: type: string tables: items: $ref: '#/definitions/agent.Table' type: array type: object agent.SearchImportFilesReq: properties: aws_access_key_id: type: string aws_external_id: type: string aws_role_arn: type: string aws_secret_access_key: type: string data_format: description: |- 1: sql 2: aurora snapshot(parquet) 3: csv 4: parquet(not aurora) type: integer data_source_type: description: |- 1: aws s3 2: gcs type: integer gcs_options: $ref: '#/definitions/agent.GcsOptions' source_uri: type: string target_source: items: $ref: '#/definitions/agent.SearchImportFilesReq_TargetSource' type: array type: object agent.SearchImportFilesReq_TargetSource: properties: custom_file: type: string target_table: $ref: '#/definitions/common.Table' type: object agent.SearchImportFilesResp: properties: table_matches: items: $ref: '#/definitions/agent.SearchImportFilesResp_TableMatch' type: array type: object agent.SearchImportFilesResp_TableMatch: properties: source_uri: description: if source_uri is empty, it means the table is not found in source type: string target_table: $ref: '#/definitions/common.Table' type: object agent.Table: properties: column_auto_gen: description: column_auto_gen represents column is auto_increment or auto_random items: type: boolean type: array column_is_pk: items: type: boolean type: array row_data_types: items: type: string type: array row_headers: items: type: string type: array row_values: items: $ref: '#/definitions/agent.Row' type: array schema_name: type: string table_name: type: string type: object base.BaseResp: properties: err_code: type: integer err_msg: type: string tags: additionalProperties: type: string type: object type: object common.Table: properties: schema: type: string table: type: string type: object dto.CheckGcsAccessRes: properties: code: type: integer data: $ref: '#/definitions/agent.CheckGcsAccessResp' message: type: string type: object dto.CheckS3AccessRes: properties: code: type: integer data: $ref: '#/definitions/agent.CheckS3AccessResp' message: type: string type: object dto.ExecSQLOnClusterRes: properties: code: type: integer data: $ref: '#/definitions/agent.ExecSQLResp' message: type: string type: object dto.GetClusterTablesRes: properties: code: type: integer data: $ref: '#/definitions/agent.GetClusterTablesResp' message: type: string type: object dto.GetImportCRRes: properties: code: type: integer data: $ref: '#/definitions/v1.Import' message: type: string type: object dto.GetImportProgressRes: properties: code: type: integer data: $ref: '#/definitions/entity.TaskProgress' message: type: string type: object dto.ImportPrecheckRes: properties: code: type: integer data: $ref: '#/definitions/agent.LightningPrecheckResp' message: type: string type: object dto.SearchImportFilesRes: properties: code: type: integer data: $ref: '#/definitions/agent.SearchImportFilesResp' message: type: string type: object dto.SuccessRes: properties: code: type: integer data: type: string message: type: string type: object entity.CheckGcsAccessParam: properties: check_gcs_access: $ref: '#/definitions/agent.CheckGcsAccessReq' cluster_id: type: integer type: object entity.CheckS3AccessParam: properties: check_s3_access: $ref: '#/definitions/agent.CheckS3AccessReq' cluster_id: type: integer type: object entity.ExecSQLOnClusterParam: properties: exec_sql: $ref: '#/definitions/agent.ExecSQLReq' type: object entity.GetClusterTablesParam: properties: cluster: $ref: '#/definitions/agent.Cluster' type: object entity.ImportPrecheckParam: properties: cluster_id: type: integer lightning_precheck: $ref: '#/definitions/agent.LightningPrecheckReq' type: object entity.ImportProgressParam: properties: cluster_id: type: integer namespace: type: string svn: type: string type: object entity.PrecheckImportFileParam: properties: cluster_id: type: integer precheck_import_file: $ref: '#/definitions/agent.PrecheckImportFileReq' type: object entity.SearchImportFilesParam: properties: cluster_id: type: integer search_import_files: $ref: '#/definitions/agent.SearchImportFilesReq' type: object entity.TableProgress: properties: m: type: string s: type: integer w: type: integer z: type: integer type: object entity.TaskProgress: properties: m: type: string s: type: integer t: additionalProperties: $ref: '#/definitions/entity.TableProgress' type: object type: object v1.AccessConfig: properties: roleArn: description: RoleArn is the ARN of the AWS role which the workload will assume. type: string type: object v1.CsvFormat: properties: backslashEscape: type: boolean delimiter: type: string header: type: boolean notNull: type: boolean "null": type: string separator: type: string trimLastSeparator: type: boolean type: object v1.CurrentTableStatus: properties: completed_percent: description: |- CompletedPercent is the completed percentage for importing on this table. The value is in 0 ~ 100. Post-processing time is not included. type: integer message: description: Message is the error message of the table import type: string name: description: Name is the table name to import. type: string phase: description: Phase is the detailed import phase for this table. Such as "Pre-Processing / Importing / ... " type: string postImportCompletedPercent: description: PostImportCompletedPercent is the completed percentage after importing on this table (post-process and analyze). The value is in 0 ~ 100. type: integer processedSize: description: ProcessedSize is the total source data size that has been processed. Processing data means the source data is converted into local temp KV storage for quick import. type: integer size: description: Size is the total size of the source data of this table. type: integer timeRecord: $ref: '#/definitions/v1.TableImportTimeRecord' description: TimeRecord is detailed time record of the whole importing process on this table. type: object v1.FieldsV1: type: object v1.GCS: properties: region: type: string url: type: string type: object v1.Import: properties: annotations: additionalProperties: type: string description: |- Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations +optional type: object apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +optional type: string creationTimestamp: description: |- CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional type: string deletionGracePeriodSeconds: description: |- Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +optional type: integer deletionTimestamp: description: |- DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata +optional type: string finalizers: description: |- Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +optional +patchStrategy=merge items: type: string type: array generateName: description: |- GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional type: string generation: description: |- A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional type: integer kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +optional type: string labels: additionalProperties: type: string description: |- Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels +optional type: object managedFields: description: |- ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. +optional items: $ref: '#/definitions/v1.ManagedFieldsEntry' type: array name: description: |- Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names +optional type: string namespace: description: |- Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces +optional type: string ownerReferences: description: |- List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. +optional +patchMergeKey=uid +patchStrategy=merge items: $ref: '#/definitions/v1.OwnerReference' type: array resourceVersion: description: |- An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional type: string selfLink: description: |- Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +optional type: string spec: $ref: '#/definitions/v1.ImportSpec' status: $ref: '#/definitions/v1.ImportStatus' uid: description: |- UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids +optional type: string type: object v1.ImportSpec: properties: accessConfig: $ref: '#/definitions/v1.AccessConfig' description: AccessConfig includes the information for access the import source. clusterName: description: |- ClusterName specifies the name of the cluster where the data is imported to, the Cluster must exist in the same namespace as Import type: string dryRun: description: |- With DryRun marked as true, the import job will only run a dry run job to verify the permission to access the import source type: boolean source: $ref: '#/definitions/v1.Source' description: Source specifies where the import data should be retrieved and parsed storageRequest: description: StorageRequest specifies additional storage size for the import job to use type: string type: object v1.ImportStatus: properties: allTableDetails: description: AllTableDetails is the table detailed status for each table. items: $ref: '#/definitions/v1.CurrentTableStatus' type: array collectTime: description: CollectTime is the UNIX timestamp when the status is collected. type: integer completedPercent: description: |- CompletedPercent is the overall completed percentage for importing. The value is in 0 ~ 100. Post-processing time is not included. type: integer completedTables: description: CompletedTables is the table count that the data has been imported, but the table has not been post-processed. type: integer currentTables: description: CurrentTables is the table detailed status for each importing table. items: $ref: '#/definitions/v1.CurrentTableStatus' type: array isTaskCreated: description: IsTaskCreated means whether the task config has been posted to the Lightning server. type: boolean message: description: Message is the error message of the import. type: string pendingTables: description: PendingTables is the table count that has not started importing. type: integer phase: description: Phase means the overall phase of an import job. Available values are "Prepare / Running / Complete / Failed". type: string postImportCompletedPercent: description: PostImportCompletedPercent is the overall completed percentage after importing (post-process and analyze). The value is in 0 ~ 100. type: integer processedDataSize: description: ProcessedDataSize is the total source data size that has been processed. Processing data means the source data is converted into local temp KV storage for quick import. type: integer taskId: description: TaskId is a uuid generated in the task creating phase. type: integer taskPhase: description: TaskPhase is the phase of a running import task. Available values are "Importing / Post-Processing". type: string totalFiles: description: TotalFiles is the total data source file count. type: integer totalSize: description: TotalSize is the total source data size. type: integer totalTables: description: TotalTables is the total table count for import. type: integer type: object v1.ManagedFieldsEntry: properties: apiVersion: description: |- APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. type: string fieldsType: description: |- FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" type: string fieldsV1: $ref: '#/definitions/v1.FieldsV1' description: |- FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. +optional manager: description: Manager is an identifier of the workflow managing these fields. type: string operation: description: |- Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. type: string subresource: description: |- Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. type: string time: description: |- Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. +optional type: string type: object v1.OwnerReference: properties: apiVersion: description: API version of the referent. type: string blockOwnerDeletion: description: |- If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +optional type: boolean controller: description: |- If true, this reference points to the managing controller. +optional type: boolean kind: description: |- Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string name: description: |- Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names type: string uid: description: |- UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids type: string type: object v1.S3: properties: region: type: string url: type: string type: object v1.Source: properties: csvFormat: $ref: '#/definitions/v1.CsvFormat' description: |- CsvFormat is the format of the CSV files. +optional filters: description: +optional items: type: string type: array format: description: |- Format is the data format of the source data 0: Unknown 1: SQL 2: Amazon Aurora Parquet 3: CSV 4: Raw Parquet type: integer objectNamePattern: description: |- ObjectNamePattern specifies objects which match the pattern to import +optional type: string password: description: Password is the TiDB password for Import job type: string storage: $ref: '#/definitions/v1.Storage' description: Storage specifies where the data is located targetTablePattern: description: |- TargetTablePattern specifies target db name and table name +optional type: string userName: description: UserName is the TiDB username for Import job type: string type: object v1.Storage: properties: gcs: $ref: '#/definitions/v1.GCS' description: +optional s3: $ref: '#/definitions/v1.S3' description: +optional type: object v1.TableImportTimeRecord: properties: analyzeDuration: description: AnalyzeDuration is the duration in seconds of the analyzing phase. type: integer buildIndexDuration: description: BuildIndexDuration is the duration in seconds of the building index phase. type: integer importDuration: description: ImportDuration is the duration in seconds of the data import phase. type: integer importFinishTime: description: ImportFinishTime is the UNIX timestamp when first detected the importing has finished. type: integer importStartTime: description: ImportStartTime is the UNIX timestamp when first detected the importing has started. type: integer postProcessDuration: description: PostProcessDuration is the duration in seconds of the post-processing phase. Post-processing consists of duplication detection and checksum. type: integer postProcessFinishTime: description: PostProcessFinishTime is the UNIX timestamp when first detected the post-processing has finished. type: integer postProcessStartTime: description: PostProcessStartTime is the UNIX timestamp when first detected the post-processing has started. type: integer preProcessDuration: description: PreProcessDuration is the duration in seconds of the pre-process phase. type: integer type: object host: 127.0.0.1:8080 info: contact: { } description: This is regional import server title: Regional Control Import Service API version: "1.0" paths: /blob/check_access: post: consumes: - application/json description: (TODO) Check Azure Blob Access produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.SuccessRes' summary: (TODO) Check Azure Blob Access tags: - regional_util_service /cluster-tables: post: consumes: - application/json description: Get Cluster Tables parameters: - description: request_body in: body name: request_body required: true schema: $ref: '#/definitions/entity.GetClusterTablesParam' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.GetClusterTablesRes' summary: Get Cluster Tables tags: - regional_util_service /cluster/execsql: post: consumes: - application/json description: Exec SQL On Cluster parameters: - description: request_body in: body name: request_body required: true schema: $ref: '#/definitions/entity.ExecSQLOnClusterParam' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.ExecSQLOnClusterRes' summary: Exec SQL On Cluster tags: - regional_util_service /gcs/check_access: post: consumes: - application/json description: Check GCS Access parameters: - description: request_body in: body name: request_body required: true schema: $ref: '#/definitions/entity.CheckGcsAccessParam' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.CheckGcsAccessRes' summary: Check GCS Access tags: - regional_util_service /import/cr: delete: consumes: - application/json description: Delete Import CR parameters: - description: 'value: ns' in: query name: namespace required: true type: string - description: 'value: name' in: query name: name required: true type: string produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.SuccessRes' summary: Delete Import CR tags: - regional_import_service get: consumes: - application/json description: Get Import CR parameters: - description: 'value: ns' in: query name: namespace required: true type: string - description: 'value: name' in: query name: name required: true type: string produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.GetImportCRRes' summary: Get Import CR tags: - regional_import_service post: consumes: - application/json description: Create Import CR parameters: - description: request_body in: body name: request_body required: true schema: $ref: '#/definitions/v1.Import' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.SuccessRes' summary: Create Import CR tags: - regional_import_service /import/hello: get: consumes: - application/json description: hello parameters: - description: 'value: hello' in: query name: param required: true type: string produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.SuccessRes' summary: hello tags: - regional_import_service /import/precheck: post: consumes: - application/json description: Import Precheck parameters: - description: request_body in: body name: request_body required: true schema: $ref: '#/definitions/entity.ImportPrecheckParam' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.ImportPrecheckRes' summary: Import Precheck tags: - regional_import_service /import/precheck-import-file: post: consumes: - application/json description: Precheck Import File parameters: - description: request_body in: body name: request_body required: true schema: $ref: '#/definitions/entity.PrecheckImportFileParam' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.SuccessRes' summary: Precheck Import File tags: - regional_import_service /import/progress: post: consumes: - application/json description: Get Import Task Progress parameters: - description: request_body in: body name: request_body required: true schema: $ref: '#/definitions/entity.ImportProgressParam' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.GetImportProgressRes' summary: Get Import Task Progress tags: - regional_import_service /import/search-import-files: post: consumes: - application/json description: Search Import Files parameters: - description: request_body in: body name: request_body required: true schema: $ref: '#/definitions/entity.SearchImportFilesParam' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.SearchImportFilesRes' summary: Search Import Files tags: - regional_import_service /s3/check_access: post: consumes: - application/json description: Check S3 Access parameters: - description: request_body in: body name: request_body required: true schema: $ref: '#/definitions/entity.CheckS3AccessParam' produces: - application/json responses: "200": description: OK schema: $ref: '#/definitions/dto.CheckS3AccessRes' summary: Check S3 Access tags: - regional_util_service swagger: "2.0"