Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Resource Formation Service/ API Reference (ME-Abu Dhabi Region)/ API/ Querying the Execution Record of a Stack

Querying the Execution Record of a Stack

Updated on 2022-02-22 GMT+08:00

Function

This API is used to query a stack execution record.

URI

GET /v2/stacks/{stack_id}/actions/{action_id}

Table 1 Parameter description

Parameter

Mandatory

Value Range

Description

stack_id

Yes

String

Stack ID. The value must be 1 to 64 characters long.

action_id

Yes

String

Name of the execution record. The value must be 1 to 64 characters long.

Request

N/A

Response

  • Response parameters

    For the description about response parameters, see Table 2.

    Table 2 Response parameters

    Parameter

    Type

    Description

    kind

    String

    API type. The value is fixed at Execution and cannot be changed.

    apiVersion

    String

    API version. The value is fixed at paas/v1alpha1 and cannot be changed.

    metadata

    Object

    Execution metadata. For details, see Table 3.

    spec

    Object

    Execution attributes. For details, see Table 4.

    status

    Object

    Execution status. For details, see Table 7.

    Table 3 Execution Metadata structure

    Parameter

    Type

    Description

    name

    String

    Execution name, which is parsed as action_id when the lifecycle operation is executed.

    labels

    String

    Execution label, which is the same as that of the stack during creation. An additional execution-hash field is added.

    namespace

    String

    Project ID of the stack, which is the same as the namespace field of the stack.

    annotations

    Map<String,String>

    Special attributes of a stack. Currently, there are three fields.

    • paas-iam.alpha.kubernetes.io/domain-id: consistent with the top-level domain_id field
    • namespace: consistent with the top-level namespace field
    • cluster-id: consistent with the top-level cluster_id field

    resourceVersion

    String

    Resource version.

    selfLink

    String

    API address for accessing the resource.

    uid

    String

    Stack resource ID, which is the same as the top-level guid field.

    Table 4 Structure of Execution Spec

    Parameter

    Type

    Description

    actionName

    String

    Lifecycle name of the execution.

    changedObjectData

    String

    Node attribute modified by the execution, which is Base64-encoded.

    disableStrategy

    String

    Perform the operation disabling policy.

    location

    String

    Location of the specified Execution executor.

    metadata

    Object

    Metadata of K8SStackSpec. For details, see Table 5.

    objectData

    String

    Node attribute during execution operation, that is, Base64-encoded template instantiation data.

    objectReference

    Object

    The objectReference parameter of ExecutionSpec. For details, see Table 6.

    onFailureStrategy

    String

    Timeout retry logic of the execution.

    source

    String

    Action source. The options are System and User.

    subObjectNames

    String

    Name of the to-be-executed object specified by the execution. If this parameter is not blank, the lifecycle of the specified object is executed. If this parameter is blank, the lifecycle of all objects is executed.

    timeoutInMinutes

    Integer

    Timeout time of the execution.

    Table 5 Execution Spec Metadata structure

    Parameter

    Type

    Description

    labels

    Object

    Execution label, which is the same as stack.spec.selector.matchlabels during creation.

    Each internal key-value structure indicates a label with key as the name and value as the value.

    namespace

    String

    The value of this parameter is the same as that of the stack namespace.

    Other fields provided by K8S

    -

    -

    Table 6 Execution Spec ObjectReference structure

    Parameter

    Type

    Description

    kind

    Object

    Consistent with kind of the stack.

    namespace

    String

    Consistent with namespace of the stack.

    uid

    String

    Consistent with uid of the stack.

    Table 7 Stack Status ExecutionStatus structure

    Parameter

    Type

    Description

    actionName

    String

    Operation name. The value can be create, delete, upgrade, rollback, reconfig, or retry.

    progress

    Integer

    Execution progress.

    objectStatus

    Object

    Overall execution progress of the operation. For details, see Table 8.

    subObjectStatuses

    Object

    Execution progress of an operation sub-step. Each key-value pair indicates the execution progress of the node corresponding to the key. The value is shown in Table 9.

    Table 8 Stack Status ExecutionStatus ActionStatus structure

    Parameter

    Type

    Description

    phase

    String

    Execution status of an operation step.

    message

    String

    Detailed error information.

    reason

    String

    Brief error description in the CamelCase format.

    updateAt

    String

    UTC timestamp of the information update in the RFC3339 format.

    Table 9 Stack Status ExecutionStatus SubActionStatus structure

    Parameter

    Type

    Description

    phase

    String

    Execution status of an operation step.

    message

    String

    Detailed error information.

    reason

    String

    Brief error description in the CamelCase format.

    updateAt

    String

    UTC timestamp of the information update in the RFC3339 format.

    subActionName

    String

    Name of an element suboperation.

    createAt

    String

    UTC timestamp of the information creation in the RFC3339 format.

  • Example response
    {
        "kind": "Execution",
        "apiVersion": "paas/v1alpha1",
        "metadata": {
            "name": "trim-4074942376",
            "namespace": "aos",
            "selfLink": "/apis/paas/v1alpha1/namespaces/aos/executions/trim-4074942376",
            "uid": "ccb8fec5-cc70-11e6-8448-0242ac001004",
            "resourceVersion": "48180",
            "creationTimestamp": "2016-12-27T20:12:32Z",
            "labels": {
                "execution-hash": "4074942376",
                "stackname": "trim"
            },
            "annotations": {
                "paas-iam.alpha.kubernetes.io/domain-id": "ea816a0cc3204ee09efb6d585bee4c58",
                "stack.kubernetes.io/revision": "1"
            },
            "enable": true
        },
        "spec": {
            "metadata": {
                "namespace": "aos",
                "creationTimestamp": null,
                "labels": {
                    "execution-hash": "4074942376",
                    "stackname": "trim"
                },
                "enable": true
            },
            "objectReference": {
                "namespace": "aos",
                "name": "trim",
                "uid": "cb2cdea0-cc70-11e6-8448-0242ac001004"
            },
            "actionName": "create",
            "timeoutInMinutes": 60,
            "onFailureStrategy": "DoNothing",
            "disableStrategy": "Cancel",
            "source": "User",
            "objectData": "*****",
            "location": "172.16.0.0"
        },
        "status": {
            "actionName": "create",
            "progress": 100,
            "objectStatus": {
                "phase": "Succeeded",
                "updateAt": "2016-12-27T20:12:47Z"
            },
            "subObjectStatuses": {
                "hello-app": {
                    "phase": "Succeeded",
                    "updateAt": "2016-12-27T20:12:33Z"
                },
                "hello-component": {
                    "phase": "Succeeded",
                    "updateAt": "2016-12-27T20:12:47Z"
                },
                "hello-package": {
                    "phase": "Succeeded",
                    "updateAt": "2016-12-27T20:12:34Z"
                }
            }
        }
    }

Status Code

  • Normal
    Table 10 Status code

    Status Code

    Description

    200

    Querying the execution record is successful.

  • Abnormal
    Table 11 Status code

    Status Code

    Description

    400

    The request parameter is incorrect.

    404

    The stack does not exist.

    500

    The server fails to process the request due to an unexpected condition.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback