Huawei Query

Huawei Query
Certified
Query metric statistics from Huawei Cloud CES (Cloud Eye Service)

Queries a single metric's datapoints over a time window, aggregated at a given period using the requested statistic. Works for both system metrics (e.g. SYS.ECS) and custom metrics pushed with the Push task.

Authentication uses AK/SK request signing. Provide accessKeyId and secretAccessKey via {{ secret('NAME') }}, or configure temporaryCredentials for inline IAM credential exchange.

yaml
type: io.kestra.plugin.huawei.ces.Query

Examples

Query the average CPU utilization of an ECS instance over the last hour.

yaml
id: ces_query
namespace: company.team

tasks:
  - id: query
    type: io.kestra.plugin.huawei.ces.Query
    accessKeyId: "{{ secret('HUAWEI_AK') }}"
    secretAccessKey: "{{ secret('HUAWEI_SK') }}"
    region: eu-west-101
    namespace: SYS.ECS
    metricName: cpu_util
    dimensions:
      - name: instance_id
        value: "abc123def456"
    statistic: AVERAGE
    period: FIVE_MINUTES
    window: PT1H

Properties

dimensions *array

Dimensions identifying the monitored resource

1 to 3 name/value pairs, e.g. instance_id for an ECS instance. CES requires at least one dimension to identify the exact resource instance.

Definitions

io.kestra.plugin.huawei.ces.Dimension

name*string

Dimension name

E.g. instance_id for an ECS instance dimension.

value*string

Dimension value

E.g. the ECS instance ID.

metricName *string

Metric name

E.g. cpu_util for the ECS CPU utilization metric.

namespace *string

Metric namespace

The service.item namespace the metric belongs to, e.g. SYS.ECS for system-level ECS metrics, or a custom namespace such as MyApp.Custom for metrics pushed with Push.

accessKeyId string

Access Key (AK) used to authenticate with Huawei Cloud

Huawei Cloud access key used together with secretAccessKey to sign API requests. Required for AK/SK-based authentication; not required when providing a pre-obtained securityToken. Sensitive — always provide via {{ secret('NAME') }}.

domainId string

Huawei Cloud Account Domain ID

Identifies the Huawei Cloud account (domain). Required when authenticating against global services such as IAM, or when requesting a domain-scoped IAM token.

endpointOverride string

CES endpoint URL override

Overrides the default endpoint derived from region and endpointSuffix. Use this for private endpoints, non-standard deployments, or tests. When set, endpointSuffix is ignored.

Format: https://ces.<region>.myhuaweicloud.com (without trailing slash).

endpointSuffix string

Huawei Cloud domain suffix

Controls the top-level domain used when deriving the CES endpoint from region. Defaults to myhuaweicloud.com. Set to myhuaweicloud.eu for the Huawei Cloud European sovereign cloud.

Ignored when endpointOverride is set.

period string

DefaultFIVE_MINUTES

Possible Values

RAWONE_MINUTEFIVE_MINUTESTWENTY_MINUTESONE_HOURFOUR_HOURSONE_DAY

Aggregation period

Defaults to FIVE_MINUTES.

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

projectId string

Huawei Cloud Project ID

Identifies the region-scoped project against which most regional services authenticate. Mutually exclusive with domainId for global services such as IAM.

region string

Huawei Cloud region

Region identifier such as eu-west-101, ap-southeast-1, or cn-north-4.

secretAccessKey string

Secret Key (SK) used to authenticate with Huawei Cloud

Huawei Cloud secret key paired with accessKeyId. Required for AK/SK-based authentication. Sensitive — always provide via {{ secret('NAME') }}.

securityToken string

Pre-obtained Huawei Cloud IAM token used as bearer credential for downstream API calls

When set, downstream Huawei tasks send this value in the X-Auth-Token header instead of signing requests with AK/SK. Sensitive.

statistic string

DefaultAVERAGE

Possible Values

AVERAGEMAXMINSUMVARIANCE

Statistic to aggregate datapoints with

Defaults to AVERAGE.

temporaryCredentials string

Inline IAM credential exchange

When set, the connection layer calls the Huawei IAM STS API once per task execution and uses the returned temporary AK/SK + security token instead of the static accessKeyId and secretAccessKey properties.

Configure once via pluginDefaults to apply transparently to every task in a namespace without per-task credential wiring:

pluginDefaults: 
  - type: io.kestra.plugin.huawei.obs
    values: 
      region: eu-west-101
      temporaryCredentials: 
        authMethod: PASSWORD
        username: my-iam-user
        password: "{{ secret('HUAWEI_IAM_PASSWORD') }}"
        domainName: my-account-domain
        durationSeconds: 3600

**Long-running tasks: ** the exchange runs once at execution start. For RealtimeTrigger or long-running Consume tasks that outlive durationSeconds, credentials will expire mid-run. Use long-lived AK/SK properties or refresh externally in that case.

Definitions

io.kestra.plugin.huawei.TemporaryCredentialsConfig

authMethodstring

DefaultPASSWORD

Possible Values

PASSWORDTOKEN

Authentication method

Controls which credentials are used to obtain the session token before exchanging for temporary STS credentials.

PASSWORD (default): provide username, password, and domainName.
TOKEN: provide an existing iamToken (X-Auth-Token).

domainNamestring

Account domain name (PASSWORD method only)

The Huawei Cloud account name (domain name) that owns the IAM user. Required when authMethod is PASSWORD. Visible in the Huawei Cloud console under My Credentials → Domain Name.

durationSecondsintegerstring

Default900

Lifetime of the temporary credentials in seconds

How long the returned temporary AK/SK/security-token should remain valid. Huawei Cloud accepts values between 900 (15 minutes) and 86400 (24 hours). Defaults to 900 seconds.

endpointSuffixstring

Defaultmyhuaweicloud.com

Huawei Cloud IAM endpoint suffix

Domain suffix used to build the IAM endpoint URL when no explicit endpoint override is set. Defaults to myhuaweicloud.com. Set to myhuaweicloud.eu for the European sovereign cloud (region eu-west-101 / EU-Dublin).

iamTokenstring

IAM token to exchange (TOKEN method only)

An existing Huawei Cloud X-Auth-Token to exchange for temporary STS credentials. Required when authMethod is TOKEN. Sensitive — always provide via {{ secret('NAME') }}.

passwordstring

IAM password (PASSWORD method only)

Password for the IAM user identified by username. Required when authMethod is PASSWORD. Sensitive — always provide via {{ secret('NAME') }}.

projectNamestring

Project name for project-scoped tokens (PASSWORD method only)

Overrides the project name used for scope=PROJECT token requests. Defaults to the task's region value when omitted, which is correct for most regions.

scopestring

DefaultPROJECT

Possible Values

PROJECTDOMAIN

Token scope (PASSWORD method only)

Scope of the session token obtained during password authentication.

PROJECT (default): token is scoped to the project matching projectName (or the task's region when projectName is omitted). Use for most downstream tasks.
DOMAIN: token is scoped to the domain.

usernamestring

IAM username (PASSWORD method only)

Huawei Cloud IAM username. Required when authMethod is PASSWORD.

window string

DefaultPT1H

Time window to query, ending now

How far back from the current time to query datapoints for, as an ISO-8601 duration. Defaults to PT1H. Maximum: 30 days (P30D).

Outputs

count integer

Number of datapoints returned

series array

Datapoints sorted by timestamp ascending

Capped at 1440 datapoints (the most recent ones) to bound memory usage. Narrow window or increase period if you need finer-grained coverage over a longer range.

Definitions

io.kestra.plugin.huawei.ces.Query-Point

timestampstring

Formatdate-time

Datapoint timestamp

unitstring

Unit reported by CES for this datapoint

E.g. %, Count, Bytes.

valuenumber

Datapoint value for the requested statistic