文档首页 > > API参考> 应用管理 API> 实例> 获取应用组件实例

获取应用组件实例

分享
更新时间:2020/06/09 GMT+08:00

功能介绍

通过此API获取组件下的所有组件实例。

URI

GET /v2/{project_id}/cas/applications/{application_id}/components/{component_id}/instances

表1 路径参数

参数

参数类型

必选

描述

project_id

String

租户项目ID

application_id

String

应用ID

component_id

String

组件ID

表2 查询参数

参数

参数类型

必选

描述

limit

Integer

指定个数,取值[0, 100]。默认1000,表示不分页,最大查询1000条记录

offset

Integer

指定偏移量

order_by

String

排序字段,默认按创建时间排序。

排序字段支持枚举值:create_time、name、version、update_time。

order

String

desc/asc,默认desc

请求参数

请求参数

响应参数

响应参数

表3 响应参数

参数

参数类型

描述

count

Integer

实例总数

instances

Array of objects

实例参数,请参考表4

表4 instance参数

参数

参数类型

描述

id

String

应用组件实例ID

application_id

String

应用ID

application_name

String

应用名称

component_id

String

组件ID

component_name

String

组件名称

name

String

应用组件实例名称

environment_id

String

应用组件环境ID

environment_name

String

环境名称

platform_type

String

运行平台类型。

应用可以在不同的平台上运行,可选用的平台的类型有以下几种:cce、vmapp。

artifacts

Map<String, Object>

组件部署件。key为组件component_name,对于Docker多容器场景,key为容器名称,请参考表5

version

String

应用组件版本号

creator

String

创建人

create_time

Integer

创建时间

update_time

Integer

修改时间

external_accesses

Array of objects

访问方式,请参考表6

status_detail

Object

状态详情,请参考表7

表5 artifact参数

参数

参数类型

描述

storage

String

存储方式,支持swr和obs

type

String

类别,虚机部署为package,容器部署为image

url

String

软件包/镜像地址

auth

String

认证方式,支持iam和none,默认为iam

version

String

版本号

properties

Map<String,String>

属性

表6 external_accesses参数

参数

参数类型

描述

id

String

ID

protocol

String

协议

address

String

访问地址

forward_port

Integer

应用组件进程监听端口

type

String

类型

status

String

状态

create_time

Integer

创建时间

update_time

Integer

修改时间

表7 status_detail参数

参数

参数类型

描述

enterprise_project_id

String

企业项目ID

status

String

实例状态

available_replica

Integer

正常实例副本数

replica

Integer

实例副本数

fail_detail

String

失败描述

last_job_id

String

最近Job ID

示例

请求示例

响应示例

{
  "count": 10,
  "instances": [
    {
      "id": "string",
      "application_id": "string",
      "application_name": "string",
      "component_id": "string",
      "component_name": "string",
      "name": "string",
      "environment_id": "string",
      "environment_name": "string",
      "platform_type": "string",
      "version": "string",
      "external_accesses": [
        {
          "id": "xxx",
          "protocol": "HTTP",
          "address": "string",
          "forward_port": 80,
          "type": "AUTO_GENERATED",
          "status": "NORMAL",
          "create_time": 1571626146765,
          "update_time": 1571626146765
        }
      ],
      "artifacts": {
        "container-name": {
          "storage": "swr",
          "type": "image",
          "url": "{IP}:20202/xxxxxxxx/junit-platformstest:1.0",
          "auth": "iam"
        }
      },
      "creator": "string",
      "create_time": 0,
      "update_time": 0,
      "status_detail": {
	    "enterprise_project_id": "0",
        "status": "RUNNING",
        "available_replica": 1,
        "replica": 1,
        "fail_detail": "cluster_deleted",
        "last_job_id": "xxx"
      }
    }
  ]
}

状态码

表8 状态码说明

HTTP状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在

500

内部错误

错误码格式为:SVCSTG.00100.[Error_ID],例如:SVCSTG.00100400。错误码说明请参考应用管理API错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问