Huawei StopJobRun

Huawei StopJobRun

Certified

Stop an in-progress DataArts Factory job run

Cancels a running supplement-data (PatchData) run — one created by StartJobRun — via POST /v2/{project_id}/factory/supplement-data/{instance_name}/stop.

Scope: this is the only stop route DataArts Factory publishes. There is no API to stop a plain job instance, so a run triggered from the DataArts Studio console cannot be stopped from Kestra — only one created by StartJobRun. Identify the run by the runName that task returned.

When wait is true (the default), the task polls until the run reaches a terminal state before returning. maxDuration bounds the polling so a run that never confirms the stop fails with a timeout rather than hanging.

yaml
type: io.kestra.plugin.huawei.dataarts.StopJobRun

Stop a run started earlier in the same flow.

yaml
id: dataarts_stop_job
namespace: company.team

tasks:
  - id: start_run
    type: io.kestra.plugin.huawei.dataarts.StartJobRun
    accessKeyId: "{{ secret('HUAWEI_AK') }}"
    secretAccessKey: "{{ secret('HUAWEI_SK') }}"
    region: eu-west-101
    projectId: "{{ secret('HUAWEI_PROJECT_ID') }}"
    workspaceId: "{{ secret('HUAWEI_WORKSPACE_ID') }}"
    jobName: my_etl_job
    wait: false

  - id: stop_run
    type: io.kestra.plugin.huawei.dataarts.StopJobRun
    accessKeyId: "{{ secret('HUAWEI_AK') }}"
    secretAccessKey: "{{ secret('HUAWEI_SK') }}"
    region: eu-west-101
    projectId: "{{ secret('HUAWEI_PROJECT_ID') }}"
    workspaceId: "{{ secret('HUAWEI_WORKSPACE_ID') }}"
    runName: "{{ outputs.start_run.runName }}"
    maxDuration: PT10M
Properties

Name of the supplement-data run to stop

The runName output of StartJobRun.

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') }}.

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.

DataArts Studio endpoint URL override

Overrides the default endpoint derived from region. Use this when running against a private endpoint, a non-standard deployment, or in tests.

When set, the region property is ignored for endpoint resolution. Format: https://dayu.<region>.myhuaweicloud.com (without trailing slash).

DefaultPT3S

Polling interval while waiting for the stop to complete

ISO-8601 duration (e.g. PT3S). Defaults to 3 seconds.

DefaultPT10M

Maximum time to wait for the stop to be confirmed

ISO-8601 duration (e.g. PT10M, PT1H). When the deadline is reached before the run reaches a terminal state, the task fails with a timeout error. Only relevant when wait is true. Defaults to 10 minutes.

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

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.

Huawei Cloud region

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

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') }}.

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.

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
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.

Defaulttrue

Wait for the run to reach a terminal state after stopping

When true (the default), polls the run's status until it stops. Set to false to return as soon as the stop request is accepted.

DataArts Studio workspace ID

Identifies the DataArts Studio workspace to target. Required for all DataArts Factory operations when your account has multiple workspaces. When omitted, the default workspace is used.

Find the workspace ID in the DataArts Studio console under Workspaces → Settings.

Formatdate-time

End of the covered business-date range

SubTypestring

Jobs covered by the run

Number of instances executed in parallel

Name of the supplement-data run

Formatdate-time

Start of the covered business-date range

Status of the run after stopping

Formatdate-time

Time the run was submitted

User the run was submitted as

More Plugins in this Category

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks

OPA (Open Policy Agent)
OPA (Open Policy Agent)
Enterprise

Tasks to manage Open Policy Agent policies and decisions, including upload, evaluation, and partial evaluation.

Infrastructure

5 tasks

3 blueprints