devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
create_time required | string <date-time> DevOps Project's Creation time' |
creator required | string Creator's username' |
description | string DevOps Projects's Description, used to describe the DevOps Project' |
extra | string Internal Use |
name required | string DevOps Projects's Name |
project_id required | string ProjectId must be unique within a workspace, it is generated by kubesphere. |
status required | string DevOps project's status. e.g. active |
visibility | string Desperated Field |
workspace required | string The workspace to which the devops project belongs |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
create_time | string <date-time> Credential's create_time' |
creator | string Creator's username |
description | string Credential's description' |
display_name | string Credential's display name' |
domain | string Credential's domain,In ks we only use the default domain, default '_'' |
fingerprint | object (devops.JenkinsCredential.fingerprint) |
id required | string Id of Credential, e.g. dockerhub-id |
kubeconfig | object (devops.KubeconfigCredential) |
secret_text | object (devops.SecretTextCredential) |
ssh | object (devops.SshCredential) |
type required | string Type of Credential, e.g. ssh/kubeconfig |
username_password | object (devops.UsernamePasswordCredential) |
OK
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
credential required | string credential's ID, e.g. dockerhub-id |
content | string Get extra credential content if this query parameter is set. Specifically, there are three types of info in a credential. One is the basic info that must be returned for each query such as name, id, etc. The second one is non-encrypted info such as the username of the username-password type of credential, which returns when the "content" parameter is set to non-empty. The last one is encrypted info, such as the password of the username-password type of credential, which never returns. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
credential required | string credential's ID, e.g. dockerhub-id |
create_time | string <date-time> Credential's create_time' |
creator | string Creator's username |
description | string Credential's description' |
display_name | string Credential's display name' |
domain | string Credential's domain,In ks we only use the default domain, default '_'' |
fingerprint | object (devops.JenkinsCredential.fingerprint) |
id required | string Id of Credential, e.g. dockerhub-id |
kubeconfig | object (devops.KubeconfigCredential) |
secret_text | object (devops.SecretTextCredential) |
ssh | object (devops.SshCredential) |
type required | string Type of Credential, e.g. ssh/kubeconfig |
username_password | object (devops.UsernamePasswordCredential) |
OK
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
credential required | string credential's ID, e.g. dockerhub-id |
OK
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
multi_branch_pipeline | object (devops.MultiBranchPipeline) |
pipeline | object (devops.NoScmPipeline) |
type required | string type of devops pipeline, in scm or no scm |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, e.g. sample-pipeline |
multi_branch_pipeline | object (devops.MultiBranchPipeline) |
pipeline | object (devops.NoScmPipeline) |
type required | string type of devops pipeline, in scm or no scm |
OK
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, e.g. sample-pipeline |
OK
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
filter | string <filter=%s> filter remote scm. e.g. origin |
start | string <start=%d> Default: "start=0" the count of branches start. |
limit | string <limit=%d> Default: "limit=100" the count of branches limit. |
ok
devops required | string the name of devops project |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach. |
parameters | Array of objects (devops.RunPayload.parameters) |
ok
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
branch required | string the name of branch, same as repository brnach. |
run required | string pipeline run id, the unique id for a pipeline once build. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach. |
run required | string pipeline run id, the unique id for a pipeline once build. |
start | string <start=%d> the item number of the search starts from. |
limit | string <limit=%d> the limit item count of the search. |
The filed of "Url" in response can download artifacts
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach. |
run required | string pipeline run id, the unique id for a pipeline once build. |
start | string <start=%d> Default: "start=0" the item number of the search starts from. |
OK
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach. |
run required | string pipeline run id, the unique id for a pipeline once build. |
limit | string <limit=%d> Default: "limit=10000" the limit item count of the search. |
ok
devops required | string the name of devops project |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach. |
run required | string pipeline run id, the unique id for a pipeline once build. |
node required | string pipeline node id, the one node in pipeline. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach. |
run required | string pipeline run id, the unique id for a pipeline once build. |
node required | string pipeline node id, the one node in pipeline. |
step required | string pipeline step id, the one step in pipeline. |
abort | boolean abort or not |
id | string id |
parameters | Array of objects (devops.CheckPlayload.parameters) |
OK
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach. |
run required | string pipeline run id, the unique id for a pipeline once build. |
node required | string pipeline node id, the one node in pipeline. |
step required | string pipeline step id, the one step in pipeline. |
start | string <start=%d> Default: "start=0" the item number of the search starts from. |
OK
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach. |
run required | string pipeline run id, the unique id for a pipeline once build. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach. |
run required | string pipeline run id, the unique id for a pipeline once build. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach. |
run required | string pipeline run id, the unique id for a pipeline once build. |
blocking | string <blocking=%t> Default: "blocking=false" stop and between each retries will sleep. |
timeOutInSecs | string <timeOutInSecs=%d> Default: "timeOutInSecs=10" the time of stop and between each retries sleep. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, e.g. sample-pipeline |
branch required | string branch name, e.g. master |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, e.g. sample-pipeline |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
OK
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
start | string <start=%d> the item number of the search starts from |
limit | string <limit=%d> the limit item count of the search |
branch | string <branch=%s> the name of branch, same as repository branch, will be filtered by branch. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
parameters | Array of objects (devops.RunPayload.parameters) |
ok
devops required | string the name of devops project |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
run required | string pipeline run id, the unique id for a pipeline once build. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
run required | string pipeline run id, the unique id for a pipeline once build. |
start | string <start=%d> the item number of the search starts from. |
limit | string <limit=%d> the limit item count of the search. |
The filed of "Url" in response can download artifacts
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
run required | string pipeline run id, the unique id for a pipeline once build. |
start | string <start=%d> Default: "start=0" the item number of the search starts from. |
OK
devops required | string the name of devops project |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
run required | string pipeline run id, the unique id for a pipeline once build |
ok
devops required | string the name of devops project |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
run required | string pipeline run id, the unique id for a pipeline once build |
node required | string pipeline node id, the one node in pipeline. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
run required | string pipeline run id, the unique id for a pipeline once build. |
node required | string pipeline node id, the one node in pipeline. |
step required | string pipeline step id |
abort | boolean abort or not |
id | string id |
parameters | Array of objects (devops.CheckPlayload.parameters) |
OK
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
run required | string pipeline run id, the unique id for a pipeline once build. |
node required | string pipeline node id, the one node in pipeline. |
step required | string pipeline step id, the one step in pipeline. |
start | string <start=%d> Default: "start=0" the item number of the search starts from. |
OK
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
branch required | string the name of branch, same as repository brnach. |
run required | string pipeline run id, the unique id for a pipeline once build. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
run required | string pipeline run id, the unique id for a pipeline once build. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
run required | string pipeline run id, the unique id for a pipeline once build. |
blocking | string <blocking=%t> Default: "blocking=false" stop and between each retries will sleep. |
timeOutInSecs | string <timeOutInSecs=%d> Default: "timeOutInSecs=10" the time of stop and between each retries sleep. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, which helps to deliver continuous integration continuous deployment. |
delay | string <delay=%d> will be delay time to scan. |
OK
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
pipeline required | string the name of pipeline, e.g. sample-pipeline |
ok
q | string <q=%s> query pipelines, condition for filtering. |
filter | string <filter=%s> Filter some types of jobs. e.g. no-folder,will not get a job of type folder |
start | string <start=%d> the item number of the search starts from. |
limit | string <limit=%d> the limit item count of the search. |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
paging | string <limit=%d,page=%d> Default: "limit=10,page=1" page |
conditions | string <key=%s,key~%s> query conditions, support using key-value pairs separated by comma to search, like 'conditions:somekey=somevalue,anotherkey=anothervalue' |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
member required | string member's username, e.g. admin |
ok
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
member required | string member's username, e.g. admin |
OK
devops required | string DevOps project's ID, e.g. project-RRRRAzLBlLEm |
member required | string member's username, e.g. admin |
grand_by | string Username of the user who assigned the role |
project_id required | string the DevOps Projects which project membership belongs to |
role required | string DevOps Project membership's role type. e.g. owner ' |
status required | string Desperated, Status of project membership. e.g. active |
username required | string Member's username,username can uniquely identify a user |
ok
json | string json data |
ok
jenkinsfile | string jenkinsfile |
ok
scm required | string the id of the source configuration management (SCM). |
credentialId required | string <credentialId=%s> credential id for source configuration management (SCM). |
ok
scm required | string The id of the source configuration management (SCM). |
organization required | string organization Id, such as github username. |
credentialId required | string <credentialId=%s> credential id for SCM. |
pageNumber required | string <pageNumber=%d> page number. |
pageSize required | string <pageSize=%d> the item count of one page. |
ok
scm required | string the id of the source configuration management (SCM). |
ok
apiVersion required | string Kubernetes API version |
kind required | string kind of the API object |
spec | object (iam.Spec) |
status | object (iam.Status) |
ok
password required | string password |
username required | string username |
ok
cluster_role required | string user's cluster role |
description required | string user's description |
email required | string email address |
lang | string user's language setting, default is zh-CN |
password required | string password' |
username required | string username |
ok
user required | string username |
ok
user required | string username |
cluster_role required | string user's cluster role |
current_password | string this is necessary if you need to change your password |
description required | string user's description |
email required | string email address |
lang required | string user's language setting, default is zh-CN |
password | string this is necessary if you need to change your password |
username required | string username |
ok
user required | string username |
ok
user required | string username |
ok
clusterrole required | string cluster role name |
ok
clusterrole required | string cluster role name |
ok
devops required | string devops project ID |
role required | string devops role name |
ok
namespace required | string kubernetes namespace |
ok
namespace required | string kubernetes namespace |
role required | string role name |
ok
namespace required | string kubernetes namespace |
role required | string role name |
ok
namespace required | string kubernetes namespace |
ok
ok
ok
user required | string username |
ok
workspace required | string workspace name |
ok
workspace required | string workspace name |
username required | string username |
workspace_role required | string user's workspace role' |
ok
workspace required | string workspace name |
member required | string username |
ok
workspace required | string workspace name |
member required | string username |
ok
workspace required | string workspace name |
ok
workspace required | string workspace name |
role required | string workspace role name |
ok
workspace required | string workspace name |
role required | string workspace role name |
ok
conditions | string <key=value,key~value> query conditions, connect multiple conditions with commas, equal symbol for exact query, wave symbol for fuzzy query e.g. name~a |
cluster_id | string equivalent to application unique ID |
runtime_id | string runtime id initialization when namespace is created, means which namespace |
paging | string <limit=%d,page=%d> Default: "limit=10,page=1" paging query, e.g. limit=100,page=1 |
ok
resources required | string cluster level resource type, e.g. nodes,workspaces,storageclasses,clusterroles. |
conditions | string <key=value,key~value> query conditions, connect multiple conditions with commas, equal symbol for exact query, wave symbol for fuzzy query e.g. name~a |
paging | string <limit=%d,page=%d> Default: "limit=10,page=1" paging query, e.g. limit=100,page=1 |
reverse | string sort parameters, e.g. reverse=true |
orderBy | string sort parameters, e.g. orderBy=createTime |
ok
namespace required | string the name of the project |
ok
namespace required | string the name of the project |
conditions | string <key=value,key~value> query conditions, connect multiple conditions with commas, equal symbol for exact query, wave symbol for fuzzy query e.g. name~a |
paging | string <limit=%d,page=%d> Default: "limit=10,page=1" paging query, e.g. limit=100,page=1 |
ok
namespace required | string the name of the project |
app_id required | string |
conf required | string |
runtime_id required | string |
version_id required | string |
ok
namespace required | string the name of the project |
application required | string application ID |
ok
namespace required | string the name of the project |
application required | string application ID |
ok
daemonset required | string the name of the daemonset |
namespace required | string the namespace of the daemonset |
revision required | string the revision of the daemonset |
ok
deployment required | string the name of deployment |
namespace required | string the namespace of the deployment |
revision required | string the revision of the deployment |
ok
job required | string job name |
namespace required | string the namespace where the job runs in |
a | string action |
ok
namespace required | string the name of the project |
ok
namespace required | string the name of the project |
OK
namespace required | string the name of the project |
OK
namespace required | string the name of the project |
OK
namespace required | string the name of the project |
OK
statefulset required | string the name of the statefulset |
namespace required | string the namespace of the statefulset |
revision required | string the revision of the statefulset |
ok
namespace required | string the name of the project |
resources required | string namespace level resource type, e.g. pods,jobs,configmaps,services. |
conditions | string <key=%s,key~%s> query conditions,connect multiple conditions with commas, equal symbol for exact query, wave symbol for fuzzy query e.g. name~a |
paging | string <limit=%d,page=%d> Default: "limit=10,page=1" paging query, e.g. limit=100,page=1 |
reverse | string sort parameters, e.g. reverse=true |
orderBy | string sort parameters, e.g. orderBy=createTime |
ok
user required | string username |
ok
component required | string component name |
ok
devops required | string devops project id |
ok
operation required | string Query type. This can be one of three types: query (for querying logs), statistics (for retrieving statistical data), and histogram (for displaying log count by time interval). |
workspaces | string A comma-separated list of workspaces. This field restricts the query to specified workspaces. For example, the following filter matches the workspace my-ws and demo-ws: |
workspace_query | string A comma-separated list of keywords. Differing from workspaces, this field performs fuzzy matching on workspaces. For example, the following value limits the query to workspaces whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
namespaces | string A comma-separated list of namespaces. This field restricts the query to specified namespaces. For example, the following filter matches the namespace my-ns and demo-ns: |
namespace_query | string A comma-separated list of keywords. Differing from namespaces, this field performs fuzzy matching on namespaces. For example, the following value limits the query to namespaces whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
workloads | string A comma-separated list of workloads. This field restricts the query to specified workloads. For example, the following filter matches the workload my-wl and demo-wl: |
workload_query | string A comma-separated list of keywords. Differing from workloads, this field performs fuzzy matching on workloads. For example, the following value limits the query to workloads whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
pods | string A comma-separated list of pods. This field restricts the query to specified pods. For example, the following filter matches the pod my-po and demo-po: |
pod_query | string A comma-separated list of keywords. Differing from pods, this field performs fuzzy matching on pods. For example, the following value limits the query to pods whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
containers | string A comma-separated list of containers. This field restricts the query to specified containers. For example, the following filter matches the container my-cont and demo-cont: |
container_query | string A comma-separated list of keywords. Differing from containers, this field performs fuzzy matching on containers. For example, the following value limits the query to containers whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
log_query | string A comma-separated list of keywords. The query returns logs which contain at least one keyword. Case-insensitive matching. For example, if the field is set to |
interval | string Default: "15m" Time interval. It requires operation is set to histogram. The format is [0-9]+[smhdwMqy]. Defaults to 15m (i.e. 15 min). |
start_time | string Start time of query. Default to 0. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
end_time | string End time of query. Default to now. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
sort | string Default: "desc" Direction of the sort. One of acs, desc. This field sorts logs by timestamp. |
from | integer Default: 0 The offset from the result set. This field returns query results from the specified offset. It requires operation is set to query. Defaults to 0 (i.e. from the beginning of the result set). |
size | integer Default: 10 Size of result to return. It requires operation is set to query. Defaults to 10 (i.e. 10 log records). |
ok
namespace required | string namespace |
ok
workspace required | string workspace name |
ok
workspace required | string workspace name |
paging | string <limit=%d,page=%d> Default: "limit=10,page=1" page |
conditions | string <key=%s,key~%s> query conditions |
OK
workspace required | string workspace name |
create_time required | string <date-time> DevOps Project's Creation time' |
creator required | string Creator's username' |
description | string DevOps Projects's Description, used to describe the DevOps Project' |
extra | string Internal Use |
name required | string DevOps Projects's Name |
project_id required | string ProjectId must be unique within a workspace, it is generated by kubesphere. |
status required | string DevOps project's status. e.g. active |
visibility | string Desperated Field |
workspace required | string The workspace to which the devops project belongs |
ok
workspace required | string workspace name |
devops required | string devops project id |
ok
workspace required | string workspace name |
member required | string workspace member's username |
paging | string <limit=%d,page=%d> Default: "limit=10,page=1" page |
conditions | string <key=%s,key~%s> query conditions |
ok
workspace required | string workspace name |
member required | string workspace member's username |
ok
workspace required | string workspace name |
ok
workspace required | string workspace name |
ok
workspace required | string workspace name |
namespace required | string namespace |
ok
workspace required | string workspace name |
ok
remoteUrl required | string git server url |
secretRef | object (v1.SecretReference) SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace |
ok
password required | string password |
serverhost required | string registry server host |
username required | string username |
ok
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both cluster CPU usage and disk usage: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
ok
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both node CPU usage and disk usage: |
resources_filter | string The node filter consists of a regexp pattern. It specifies which node data to return. For example, the following filter matches both node i-caojnter and i-cmu82ogj: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
sort_metric | string Sort nodes by the specified metric. Not applicable if start and end are provided. |
sort_type | string Default: "desc." Sort order. One of asc, desc. |
page | integer The page number. This field paginates result data of each metric, then returns a specific page. For example, setting page to 2 returns the second page. It only applies to sorted metric data. |
limit | integer Default: 5 Page size, the maximum number of results in a single page. Defaults to 5. |
ok
node required | string Node name. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both node CPU usage and disk usage: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
ok
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both namespace CPU usage and memory usage: |
resources_filter | string The namespace filter consists of a regexp pattern. It specifies which namespace data to return. For example, the following filter matches both namespace test and kube-system: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
sort_metric | string Sort namespaces by the specified metric. Not applicable if start and end are provided. |
sort_type | string Default: "desc." Sort order. One of asc, desc. |
page | integer The page number. This field paginates result data of each metric, then returns a specific page. For example, setting page to 2 returns the second page. It only applies to sorted metric data. |
limit | integer Default: 5 Page size, the maximum number of results in a single page. Defaults to 5. |
ok
namespace required | string The name of the namespace. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both namespace CPU usage and memory usage: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
ok
namespace required | string The name of the namespace. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both workload CPU usage and memory usage: |
resources_filter | string The workload filter consists of a regexp pattern. It specifies which workload data to return. For example, the following filter matches any workload whose name begins with prometheus: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
sort_metric | string Sort workloads by the specified metric. Not applicable if start and end are provided. |
sort_type | string Default: "desc." Sort order. One of asc, desc. |
page | integer The page number. This field paginates result data of each metric, then returns a specific page. For example, setting page to 2 returns the second page. It only applies to sorted metric data. |
limit | integer Default: 5 Page size, the maximum number of results in a single page. Defaults to 5. |
ok
namespace required | string The name of the namespace. |
kind required | string Workload kind. One of deployment, daemonset, statefulset. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both workload CPU usage and memory usage: |
resources_filter | string The workload filter consists of a regexp pattern. It specifies which workload data to return. For example, the following filter matches any workload whose name begins with prometheus: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
sort_metric | string Sort workloads by the specified metric. Not applicable if start and end are provided. |
sort_type | string Default: "desc." Sort order. One of asc, desc. |
page | integer The page number. This field paginates result data of each metric, then returns a specific page. For example, setting page to 2 returns the second page. It only applies to sorted metric data. |
limit | integer Default: 5 Page size, the maximum number of results in a single page. Defaults to 5. |
ok
namespace required | string The name of the namespace. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both pod CPU usage and memory usage: |
resources_filter | string The pod filter consists of a regexp pattern. It specifies which pod data to return. For example, the following filter matches any pod whose name begins with redis: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
sort_metric | string Sort pods by the specified metric. Not applicable if start and end are provided. |
sort_type | string Default: "desc." Sort order. One of asc, desc. |
page | integer The page number. This field paginates result data of each metric, then returns a specific page. For example, setting page to 2 returns the second page. It only applies to sorted metric data. |
limit | integer Default: 5 Page size, the maximum number of results in a single page. Defaults to 5. |
ok
namespace required | string The name of the namespace. |
pod required | string Pod name. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both pod CPU usage and memory usage: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
ok
namespace required | string The name of the namespace. |
kind required | string Workload kind. One of deployment, daemonset, statefulset. |
workload required | string Workload name. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both pod CPU usage and memory usage: |
resources_filter | string The pod filter consists of a regexp pattern. It specifies which pod data to return. For example, the following filter matches any pod whose name begins with redis: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
sort_metric | string Sort pods by the specified metric. Not applicable if start and end are provided. |
sort_type | string Default: "desc." Sort order. One of asc, desc. |
page | integer The page number. This field paginates result data of each metric, then returns a specific page. For example, setting page to 2 returns the second page. It only applies to sorted metric data. |
limit | integer Default: 5 Page size, the maximum number of results in a single page. Defaults to 5. |
ok
node required | string Node name. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both pod CPU usage and memory usage: |
resources_filter | string The pod filter consists of a regexp pattern. It specifies which pod data to return. For example, the following filter matches any pod whose name begins with redis: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
sort_metric | string Sort pods by the specified metric. Not applicable if start and end are provided. |
sort_type | string Default: "desc." Sort order. One of asc, desc. |
page | integer The page number. This field paginates result data of each metric, then returns a specific page. For example, setting page to 2 returns the second page. It only applies to sorted metric data. |
limit | integer Default: 5 Page size, the maximum number of results in a single page. Defaults to 5. |
ok
node required | string Node name. |
pod required | string Pod name. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both pod CPU usage and memory usage: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
ok
namespace required | string The name of the namespace. |
pod required | string Pod name. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both container CPU usage and memory usage: |
resources_filter | string The container filter consists of a regexp pattern. It specifies which container data to return. For example, the following filter matches container prometheus and prometheus-config-reloader: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
sort_metric | string Sort containers by the specified metric. Not applicable if start and end are provided. |
sort_type | string Default: "desc." Sort order. One of asc, desc. |
page | integer The page number. This field paginates result data of each metric, then returns a specific page. For example, setting page to 2 returns the second page. It only applies to sorted metric data. |
limit | integer Default: 5 Page size, the maximum number of results in a single page. Defaults to 5. |
ok
namespace required | string The name of the namespace. |
pod required | string Pod name. |
container required | string Container name. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both container CPU usage and memory usage: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
ok
node required | string Node name. |
pod required | string Pod name. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both container CPU usage and memory usage: |
resources_filter | string The container filter consists of a regexp pattern. It specifies which container data to return. For example, the following filter matches container prometheus and prometheus-config-reloader: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
sort_metric | string Sort containers by the specified metric. Not applicable if start and end are provided. |
sort_type | string Default: "desc." Sort order. One of asc, desc. |
page | integer The page number. This field paginates result data of each metric, then returns a specific page. For example, setting page to 2 returns the second page. It only applies to sorted metric data. |
limit | integer Default: 5 Page size, the maximum number of results in a single page. Defaults to 5. |
ok
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both workspace CPU usage and memory usage: |
resources_filter | string The workspace filter consists of a regexp pattern. It specifies which workspace data to return. |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
sort_metric | string Sort workspaces by the specified metric. Not applicable if start and end are provided. |
sort_type | string Default: "desc." Sort order. One of asc, desc. |
page | integer The page number. This field paginates result data of each metric, then returns a specific page. For example, setting page to 2 returns the second page. It only applies to sorted metric data. |
limit | integer Default: 5 Page size, the maximum number of results in a single page. Defaults to 5. |
type | string Additional operations. Currently available types is statistics. It retrieves the total number of workspaces, devops projects, namespaces, accounts in the cluster at the moment. |
ok
workspace required | string Workspace name. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both workspace CPU usage and memory usage: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
type | string Additional operations. Currently available types is statistics. It retrieves the total number of namespaces, devops projects, members and roles in this workspace at the moment. |
ok
component required | string system component to monitor. One of etcd, apiserver, scheduler, controller_manager, coredns, prometheus. |
metrics_filter | string The metric name filter consists of a regexp pattern. It specifies which metric data to return. For example, the following filter matches both etcd server list and total size of the underlying database: |
start | string Start time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1559347200. |
end | string End time of query. Use start and end to retrieve metric data over a time span. It is a string with Unix time format, eg. 1561939200. |
step | string Default: "10m" Time interval. Retrieve metric data at a fixed interval within the time range of start and end. It requires both start and end are provided. The format is [0-9]+[smhdwy]. Defaults to 10m (i.e. 10 min). |
time | string A timestamp in Unix time format. Retrieve metric data at a single point in time. Defaults to now. Time and the combination of start, end, step are mutually exclusive. |
ok
operation | string Default: "query" Query type. This can be one of three types: query (for querying logs), statistics (for retrieving statistical data), and histogram (for displaying log count by time interval). Defaults to query. |
workspaces | string A comma-separated list of workspaces. This field restricts the query to specified workspaces. For example, the following filter matches the workspace my-ws and demo-ws: |
workspace_query | string A comma-separated list of keywords. Differing from workspaces, this field performs fuzzy matching on workspaces. For example, the following value limits the query to workspaces whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
namespaces | string A comma-separated list of namespaces. This field restricts the query to specified namespaces. For example, the following filter matches the namespace my-ns and demo-ns: |
namespace_query | string A comma-separated list of keywords. Differing from namespaces, this field performs fuzzy matching on namespaces. For example, the following value limits the query to namespaces whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
workloads | string A comma-separated list of workloads. This field restricts the query to specified workloads. For example, the following filter matches the workload my-wl and demo-wl: |
workload_query | string A comma-separated list of keywords. Differing from workloads, this field performs fuzzy matching on workloads. For example, the following value limits the query to workloads whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
pods | string A comma-separated list of pods. This field restricts the query to specified pods. For example, the following filter matches the pod my-po and demo-po: |
pod_query | string A comma-separated list of keywords. Differing from pods, this field performs fuzzy matching on pods. For example, the following value limits the query to pods whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
containers | string A comma-separated list of containers. This field restricts the query to specified containers. For example, the following filter matches the container my-cont and demo-cont: |
container_query | string A comma-separated list of keywords. Differing from containers, this field performs fuzzy matching on containers. For example, the following value limits the query to containers whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
log_query | string A comma-separated list of keywords. The query returns logs which contain at least one keyword. Case-insensitive matching. For example, if the field is set to |
interval | string Default: "15m" Time interval. It requires operation is set to histogram. The format is [0-9]+[smhdwMqy]. Defaults to 15m (i.e. 15 min). |
start_time | string Start time of query. Default to 0. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
end_time | string End time of query. Default to now. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
sort | string Default: "desc" Sort order. One of acs, desc. This field sorts logs by timestamp. |
from | integer Default: 0 The offset from the result set. This field returns query results from the specified offset. It requires operation is set to query. Defaults to 0 (i.e. from the beginning of the result set). |
size | integer Default: 10 Size of result to return. It requires operation is set to query. Defaults to 10 (i.e. 10 log records). |
ok
namespace required | string The name of the namespace. |
operation | string Default: "query" Query type. This can be one of three types: query (for querying logs), statistics (for retrieving statistical data), and histogram (for displaying log count by time interval). Defaults to query. |
workloads | string A comma-separated list of workloads. This field restricts the query to specified workloads. For example, the following filter matches the workload my-wl and demo-wl: |
workload_query | string A comma-separated list of keywords. Differing from workloads, this field performs fuzzy matching on workloads. For example, the following value limits the query to workloads whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
pods | string A comma-separated list of pods. This field restricts the query to specified pods. For example, the following filter matches the pod my-po and demo-po: |
pod_query | string A comma-separated list of keywords. Differing from pods, this field performs fuzzy matching on pods. For example, the following value limits the query to pods whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
containers | string A comma-separated list of containers. This field restricts the query to specified containers. For example, the following filter matches the container my-cont and demo-cont: |
container_query | string A comma-separated list of keywords. Differing from containers, this field performs fuzzy matching on containers. For example, the following value limits the query to containers whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
log_query | string A comma-separated list of keywords. The query returns logs which contain at least one keyword. Case-insensitive matching. For example, if the field is set to |
interval | string Default: "15m" Time interval. It requires operation is set to histogram. The format is [0-9]+[smhdwMqy]. Defaults to 15m (i.e. 15 min). |
start_time | string Start time of query. Default to 0. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
end_time | string End time of query. Default to now. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
sort | string Default: "desc" Sort order. One of acs, desc. This field sorts logs by timestamp. |
from | integer Default: 0 The offset from the result set. This field returns query results from the specified offset. It requires operation is set to query. Defaults to 0 (i.e. from the beginning of the result set). |
size | integer Default: 10 Size of result to return. It requires operation is set to query. Defaults to 10 (i.e. 10 log records). |
ok
namespace required | string The name of the namespace. |
pod required | string Pod name. |
operation | string Default: "query" Query type. This can be one of three types: query (for querying logs), statistics (for retrieving statistical data), and histogram (for displaying log count by time interval). Defaults to query. |
containers | string A comma-separated list of containers. This field restricts the query to specified containers. For example, the following filter matches the container my-cont and demo-cont: |
container_query | string A comma-separated list of keywords. Differing from containers, this field performs fuzzy matching on containers. For example, the following value limits the query to containers whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
log_query | string A comma-separated list of keywords. The query returns logs which contain at least one keyword. Case-insensitive matching. For example, if the field is set to |
interval | string Default: "15m" Time interval. It requires operation is set to histogram. The format is [0-9]+[smhdwMqy]. Defaults to 15m (i.e. 15 min). |
start_time | string Start time of query. Default to 0. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
end_time | string End time of query. Default to now. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
sort | string Default: "desc" Sort order. One of acs, desc. This field sorts logs by timestamp. |
from | integer Default: 0 The offset from the result set. This field returns query results from the specified offset. It requires operation is set to query. Defaults to 0 (i.e. from the beginning of the result set). |
size | integer Default: 10 Size of result to return. It requires operation is set to query. Defaults to 10 (i.e. 10 log records). |
ok
namespace required | string The name of the namespace. |
pod required | string Pod name. |
container required | string Container name. |
operation | string Default: "query" Query type. This can be one of three types: query (for querying logs), statistics (for retrieving statistical data), and histogram (for displaying log count by time interval). Defaults to query. |
log_query | string A comma-separated list of keywords. The query returns logs which contain at least one keyword. Case-insensitive matching. For example, if the field is set to |
interval | string Default: "15m" Time interval. It requires operation is set to histogram. The format is [0-9]+[smhdwMqy]. Defaults to 15m (i.e. 15 min). |
start_time | string Start time of query. Default to 0. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
end_time | string End time of query. Default to now. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
sort | string Default: "desc" Sort order. One of acs, desc. This field sorts logs by timestamp. |
from | integer Default: 0 The offset from the result set. This field returns query results from the specified offset. It requires operation is set to query. Defaults to 0 (i.e. from the beginning of the result set). |
size | integer Default: 10 Size of result to return. It requires operation is set to query. Defaults to 10 (i.e. 10 log records). |
ok
namespace required | string The name of the namespace. |
workload required | string The name of the workload. |
operation | string Default: "query" Query type. This can be one of three types: query (for querying logs), statistics (for retrieving statistical data), and histogram (for displaying log count by time interval). Defaults to query. |
pods | string A comma-separated list of pods. This field restricts the query to specified pods. For example, the following filter matches the pod my-po and demo-po: |
pod_query | string A comma-separated list of keywords. Differing from pods, this field performs fuzzy matching on pods. For example, the following value limits the query to pods whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
containers | string A comma-separated list of containers. This field restricts the query to specified containers. For example, the following filter matches the container my-cont and demo-cont: |
container_query | string A comma-separated list of keywords. Differing from containers, this field performs fuzzy matching on containers. For example, the following value limits the query to containers whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
log_query | string A comma-separated list of keywords. The query returns logs which contain at least one keyword. Case-insensitive matching. For example, if the field is set to |
interval | string Default: "15m" Time interval. It requires operation is set to histogram. The format is [0-9]+[smhdwMqy]. Defaults to 15m (i.e. 15 min). |
start_time | string Start time of query. Default to 0. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
end_time | string End time of query. Default to now. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
sort | string Default: "desc" Sort order. One of acs, desc. This field sorts logs by timestamp. |
from | integer Default: 0 The offset from the result set. This field returns query results from the specified offset. It requires operation is set to query. Defaults to 0 (i.e. from the beginning of the result set). |
size | integer Default: 10 Size of result to return. It requires operation is set to query. Defaults to 10 (i.e. 10 log records). |
ok
workspace required | string The name of the workspace. |
operation | string Default: "query" Query type. This can be one of three types: query (for querying logs), statistics (for retrieving statistical data), and histogram (for displaying log count by time interval). Defaults to query. |
namespaces | string A comma-separated list of namespaces. This field restricts the query to specified namespaces. For example, the following filter matches the namespace my-ns and demo-ns: |
namespace_query | string A comma-separated list of keywords. Differing from namespaces, this field performs fuzzy matching on namespaces. For example, the following value limits the query to namespaces whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
workloads | string A comma-separated list of workloads. This field restricts the query to specified workloads. For example, the following filter matches the workload my-wl and demo-wl: |
workload_query | string A comma-separated list of keywords. Differing from workloads, this field performs fuzzy matching on workloads. For example, the following value limits the query to workloads whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
pods | string A comma-separated list of pods. This field restricts the query to specified pods. For example, the following filter matches the pod my-po and demo-po: |
pod_query | string A comma-separated list of keywords. Differing from pods, this field performs fuzzy matching on pods. For example, the following value limits the query to pods whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
containers | string A comma-separated list of containers. This field restricts the query to specified containers. For example, the following filter matches the container my-cont and demo-cont: |
container_query | string A comma-separated list of keywords. Differing from containers, this field performs fuzzy matching on containers. For example, the following value limits the query to containers whose name contains the word my(My,MY,...) OR demo(Demo,DemO,...): |
log_query | string A comma-separated list of keywords. The query returns logs which contain at least one keyword. Case-insensitive matching. For example, if the field is set to |
interval | string Default: "15m" Time interval. It requires operation is set to histogram. The format is [0-9]+[smhdwMqy]. Defaults to 15m (i.e. 15 min). |
start_time | string Start time of query. Default to 0. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
end_time | string End time of query. Default to now. The format is a string representing milliseconds since the epoch, eg. 1559664000000. |
sort | string Default: "desc" Sort order. One of acs, desc. This field sorts logs by timestamp. |
from | integer Default: 0 The offset from the result set. This field returns query results from the specified offset. It requires operation is set to query. Defaults to 0 (i.e. from the beginning of the result set). |
size | integer Default: 10 Size of result to return. It requires operation is set to query. Defaults to 10 (i.e. 10 log records). |
ok
enable required | boolean active status, one of true, false |
id | string output uuid |
name required | string output plugin name, eg. fluentbit-output-es |
parameters required | Array of objects (fluentbitclient.Parameter) output plugin configuration parameters |
type required | string output plugin type, eg. fluentbit-output-es |
updatetime | string <date-time> last updatetime |
ok
output required | string ID of the output. |
enable required | boolean active status, one of true, false |
id | string output uuid |
name required | string output plugin name, eg. fluentbit-output-es |
parameters required | Array of objects (fluentbitclient.Parameter) output plugin configuration parameters |
type required | string output plugin type, eg. fluentbit-output-es |
updatetime | string <date-time> last updatetime |
ok
output required | string ID of the output. |
ok
duration | string Default: "10m" duration of the query period, in seconds |
graphType | string Default: "workload" type of the generated service graph. Available graph types: [app, service, versionedApp, workload]. |
groupBy | string Default: "none" app box grouping characteristic. Available groupings: [app, none, version]. |
queryTime | string from which time point in UNIX timestamp, default now |
injectServiceNodes | string Default: false flag for injecting the requested service node between source and destination nodes. |
ok
bad request
not found
namespace required | string name of a namespace |
app required | string app name |
rateInterval required | string Default: "10m" the rate interval used for fetching error rate |
queryTime | string the time to use for query |
ok
namespace required | string name of the namespace |
app required | string name of the app |
filters[] | string Default: "[]" type of metrics type, fetch all metrics when empty, e.g. request_count, request_duration, request_error_count |
queryTime | string from which UNIX time to extract metrics |
duration | string Default: 1800 duration of the query period, in seconds |
step | string Default: 15 step between graph data points, in seconds. |
rateInterval | string Default: "1m" metrics rate intervals, e.g. 20s |
direction | string Default: "outbound" traffic direction: 'inbound' or 'outbound' |
quantiles[] | string Default: "[]" list of quantiles to fetch, fetch no quantiles when empty. eg. 0.5, 0.9, 0.99 |
byLabels[] | string Default: "[]" list of labels to use for grouping metrics(via Prometheus 'by' clause), e.g. source_workload, destination_service_name |
requestProtocol | string Default: "all protocols" request protocol for the telemetry, e.g. http/tcp/grpc |
reporter | string Default: "source" istio telemetry reporter, 'source' or 'destination' |
ok
namespace required | string name of a namespace |
duration | string Default: "10m" duration of the query period, in seconds |
graphType | string Default: "workload" type of the generated service graph. Available graph types: [app, service, versionedApp, workload]. |
groupBy | string Default: "none" app box grouping characteristic. Available groupings: [app, none, version]. |
queryTime | string from which time point in UNIX timestamp, default now |
injectServiceNodes | string Default: false flag for injecting the requested service node between source and destination nodes. |
ok
bad request
not found
namespace required | string name of a namespace |
type required | string Default: "app" the type of health, app/service/workload, default app |
rateInterval required | string Default: "10m" the rate interval used for fetching error rate |
queryTime | string the time to use for query |
ok
bad request
not found
namespace required | string name of the namespace |
service required | string name of the service |
filters[] | string Default: "[]" type of metrics type, fetch all metrics when empty, e.g. request_count, request_duration, request_error_count |
queryTime | string from which UNIX time to extract metrics |
duration | string Default: 1800 duration of the query period, in seconds |
step | string Default: 15 step between graph data points, in seconds. |
rateInterval | string Default: "1m" metrics rate intervals, e.g. 20s |
direction | string Default: "outbound" traffic direction: 'inbound' or 'outbound' |
quantiles[] | string Default: "[]" list of quantiles to fetch, fetch no quantiles when empty. eg. 0.5, 0.9, 0.99 |
byLabels[] | string Default: "[]" list of labels to use for grouping metrics(via Prometheus 'by' clause), e.g. source_workload, destination_service_name |
requestProtocol | string Default: "all protocols" request protocol for the telemetry, e.g. http/tcp/grpc |
reporter | string Default: "source" istio telemetry reporter, 'source' or 'destination' |
ok
namespace required | string name of a namespace |
service required | string service name |
rateInterval required | string Default: "10m" the rate interval used for fetching error rate |
queryTime | string the time to use for query |
ok
namespace required | string name of the namespace |
service required | string name of the service |
filters[] | string Default: "[]" type of metrics type, fetch all metrics when empty, e.g. request_count, request_duration, request_error_count |
queryTime | string from which UNIX time to extract metrics |
duration | string Default: 1800 duration of the query period, in seconds |
step | string Default: 15 step between graph data points, in seconds. |
rateInterval | string Default: "1m" metrics rate intervals, e.g. 20s |
direction | string Default: "outbound" traffic direction: 'inbound' or 'outbound' |
quantiles[] | string Default: "[]" list of quantiles to fetch, fetch no quantiles when empty. eg. 0.5, 0.9, 0.99 |
byLabels[] | string Default: "[]" list of labels to use for grouping metrics(via Prometheus 'by' clause), e.g. source_workload, destination_service_name |
requestProtocol | string Default: "all protocols" request protocol for the telemetry, e.g. http/tcp/grpc |
reporter | string Default: "source" istio telemetry reporter, 'source' or 'destination' |
ok
namespace required | string namespace of service |
service required | string name of service queried |
start | string start of time range want to query, in unix timestamp |
end | string end of time range want to query, in unix timestamp |
limit | string Default: 10 maximum tracing entries returned at one query, default 10 |
loopback | string loopback of duration want to query, e.g. 30m/1h/2d |
maxDuration | string maximum duration of a request |
minDuration | string minimum duration of a request |
OK
namespace required | string name of a namespace |
workload required | string workload name |
rateInterval required | string Default: "10m" the rate interval used for fetching error rate |
queryTime | string the time to use for query |
ok
namespace required | string name of the namespace |
workload required | string name of the workload |
service required | string name of the service |
filters[] | string Default: "[]" type of metrics type, fetch all metrics when empty, e.g. request_count, request_duration, request_error_count |
queryTime | string from which UNIX time to extract metrics |
duration | string Default: 1800 duration of the query period, in seconds |
step | string Default: 15 step between graph data points, in seconds. |
rateInterval | string Default: "1m" metrics rate intervals, e.g. 20s |
direction | string Default: "outbound" traffic direction: 'inbound' or 'outbound' |
quantiles[] | string Default: "[]" list of quantiles to fetch, fetch no quantiles when empty. eg. 0.5, 0.9, 0.99 |
byLabels[] | string Default: "[]" list of labels to use for grouping metrics(via Prometheus 'by' clause), e.g. source_workload, destination_service_name |
requestProtocol | string Default: "all protocols" request protocol for the telemetry, e.g. http/tcp/grpc |
reporter | string Default: "source" istio telemetry reporter, 'source' or 'destination' |
ok