更新时间:2022-02-22 GMT+08:00

查询堆栈元素

功能介绍

用于查询堆栈的某个元素。

URI

GET /v2/stacks/{stack_id}/elements/{node_id}

表1 参数说明

参数

是否必选

描述

stack_id

堆栈id,长度[1, 64]。

node_id

堆栈元素id,长度[1, 64]。

请求消息

N/A。

响应消息

  • 响应参数

    响应参数是一个返回堆栈元素结构或返回消息结构。

    • 查询成功时返回堆栈元素结构。
    • 查询失败时返回消息结构。

    其中,返回堆栈元素结构如表2 响应参数所示, 失败时返回消息结构如表5所示。

    表2 响应参数

    参数

    参数类型

    描述

    instances

    Array of objects

    instances结构,详情请参见表3。只有应用实例会返回在该结构中。对于云服务该字段内容为空。

    id

    String

    元素的名称

    description

    String

    元素的描述

    properties

    Object

    元素的属性,与模板内容相对应。

    runtime_properties

    Object

    元素运行时属性

    relationships

    Array of objects

    元素的关系,详情请参见表4

    stack_id

    String

    元素所属的堆栈的guid

    type

    String

    元素的类型

    create_at

    String

    元素创建时间

    update_at

    String

    元素更新时间

    type_hierarchy

    String

    堆栈元素类型

    action_status

    Object

    堆栈元素当前的状态,详情请参见表5

    表3 instances字段数据结构说明

    参数

    参数类型

    描述

    items

    Array<Map<String,Map<String,String>>>

    元素的所有实例信息

  • 响应示例
    {
        "create_at": "2020-07-21T05:45:19Z",
        "description": "",
        "id": "redis-app",
        "properties": {},
        "relationships": [],
        "runtime_properties": {},
        "stack_id": "0404c915-4a0c-260f-e146-eea4b95ee578",
        "type": "Cloud.AOS.Stack",
        "update_at": "2020-07-21T05:45:19Z",
        "instances": {
            "items": []
        }
    }

状态码

  • 正常
    表4 状态码

    状态码

    描述

    200

    查询堆栈元素成功

  • 异常
    表5 状态码

    状态码

    描述

    404

    请求堆栈或元素不存在

    500

    服务器遇到了一个未曾预料的状况,导致无法完成对请求的处理。