#Archive

#/platform/logging.alauda.io/v2/logs/archive

#get Log Archive

Export logs as a file with authentication.

#Parameters

• start (in query): number required

  Start time of the time range.

• end (in query): number required

  End time of the time range.

• page (in query): integer required

  Page number for the query results.

• pageSize (in query): integer

  Number of records per page. For export, 0 means export all.

• ascending (in query): boolean

  Sort order. Default is false (descending).

• cluster (in query): string required

  Name of the cluster.

• logType (in query): string

  Type of log. Options: system, platform, kubernetes, workload. Default is workload.

• projects (in query): string

  Project names for application logs, comma separated.

• namespaces (in query): string

  Namespace names for application logs, comma separated.

• workloads (in query): string

  Workload type and name pairs for application logs, e.g., Deployment:lanaya. Multiple values separated by commas.

• podNames (in query): string

  Pod names, comma separated.

• containerNames (in query): string

  Container names, comma separated.

• nodes (in query): string

  Node names, comma separated.

• paths (in query): string

  Path names, comma separated.

• products (in query): string

  Product names for product logs, comma separated.

• components (in query): string

  Component names for product logs or Kubernetes logs, comma separated.

• query (in query): string

  Query keywords, supports AND, OR, and escape with backslash.

• fileType (in query): string

  File type for export. Options: txt, csv.

• fields (in query): string

  Output field names, comma separated.

#Response

• 200 string: Successful log export

#/platform/logging.alauda.io/v2/clusters/{cluster}/logs/archive

#get Log Archive by Cluster

Export logs by cluster as a file with authentication.

#Parameters

• cluster (in path): string required

  Name of the cluster.

• start (in query): number required

  Start time of the time range.

• end (in query): number required

  End time of the time range.

• page (in query): integer required

  Page number for the query results.

• pageSize (in query): integer

  Number of records per page. For export, 0 means export all.

• ascending (in query): boolean

  Sort order. Default is false (descending).

• logType (in query): string

  Type of log. Options: system, platform, kubernetes, workload. Default is workload.

• projects (in query): string

  Project names for application logs, comma separated.

• namespaces (in query): string

  Namespace names for application logs, comma separated.

• workloads (in query): string

  Workload type and name pairs for application logs, e.g., Deployment:lanaya. Multiple values separated by commas.

• podNames (in query): string

  Pod names, comma separated.

• containerNames (in query): string

  Container names, comma separated.

• nodes (in query): string

  Node names, comma separated.

• paths (in query): string

  Path names, comma separated.

• products (in query): string

  Product names for product logs, comma separated.

• components (in query): string

  Component names for product logs or Kubernetes logs, comma separated.

• query (in query): string

  Query keywords, supports AND, OR, and escape with backslash.

• fileType (in query): string

  File type for export. Options: txt, csv.

• fields (in query): string

  Output field names, comma separated.

#Response

• 200 string: Successful log export

#/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/archive

#get Log Archive by Project, Cluster and Namespace

Export logs within a specific project, cluster, and namespace as a file with authentication.

#Parameters

• project (in path): string required

  Name of the project.

• cluster (in path): string required

  Name of the cluster.

• namespace (in path): string required

  Name of the namespace.

• start (in query): number required

  Start time of the time range.

• end (in query): number required

  End time of the time range.

• page (in query): integer required

  Page number for the query results.

• pageSize (in query): integer

  Number of records per page. For export, 0 means export all.

• ascending (in query): boolean

  Sort order. Default is false (descending).

• logType (in query): string

  Type of log. Options: system, platform, kubernetes, workload. Default is workload.

• workloads (in query): string

  Workload type and name pairs for application logs, e.g., Deployment:lanaya. Multiple values separated by commas.

• podNames (in query): string

  Pod names, comma separated.

• containerNames (in query): string

  Container names, comma separated.

• namespaces (in query): string

  Namespace names for application logs, comma separated.

• nodes (in query): string

  Node names, comma separated.

• paths (in query): string

  Path names, comma separated.

• products (in query): string

  Product names for product logs, comma separated.

• components (in query): string

  Component names for product logs or Kubernetes logs, comma separated.

• query (in query): string

  Query keywords, supports AND, OR, and escape with backslash.

• fileType (in query): string

  File type for export. Options: txt, csv.

• fields (in query): string

  Output field names, comma separated.

#Response

• 200 string: Successful log export