获取组件实例列表 - ListComponentInstances
功能介绍
获取组件实例列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/cae/applications/{application_id}/components/{component_id}/instances
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取项目ID请参见获取项目ID。 |
|
application_id |
是 |
String |
应用ID。 |
|
component_id |
是 |
String |
组件ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。
|
|
X-Enterprise-Project-ID |
否 |
String |
企业项目ID。
说明:
关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。
|
|
X-Environment-ID |
是 |
String |
环境ID。
|
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
api_version |
String |
API版本,固定值“v1”,该值不可修改。 |
|
kind |
String |
API类型,固定值“ComponentConfiguration”,该值不可修改。 |
|
items |
Array of Instance objects |
组件实例列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
实例ID。 |
|
name |
String |
实例名称。 |
|
status |
String |
参数解释: 实例状态。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
请求示例
获取组件实例列表。
GET https://{endpoint}/v1/{project_id}/cae/applications/{application_id}/components/{component_id}/instances
响应示例
状态码:200
请求成功。
{
"api_version" : "v1",
"kind" : "ComponentInstance",
"items" : [ {
"id" : "d59a645b-730d-4a1a-951f-822a71dcdb9d",
"name" : "test-image-5787bf845c-wzz99",
"status" : "creating"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
错误码
请参见错误码。