查询组件 - ListApplicationComponents
功能介绍
根据不同场景,查询子应用或组件。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
coc:application:list
List
application *
-
-
-
URI
GET /v1/components
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
application_id |
否 |
String |
参数解释: 应用id。 约束限制: 不涉及。 取值范围: 组件对应的应用id,有一级一级关系。 默认取值: 不涉及。 |
|
marker |
否 |
String |
参数解释: 用于分页查询。 约束限制: 不涉及。 取值范围: 上一次查询的最后一条记录ID。 默认取值: 不涉及。 |
|
limit |
是 |
Integer |
参数解释: 分页查询每页显示的条目数量。 约束限制: 不涉及。 取值范围: 自定义,在1-500范围。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
Array of data objects |
参数解释: 组件查询信息列表。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: COC-CMDB分配的uuid。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 组件名称。 取值范围: 不涉及。 |
|
code |
String |
参数解释: 组件code。 取值范围: 不涉及。 |
|
domain_id |
String |
参数解释: 租户id。 取值范围: 不涉及。 |
|
application_id |
String |
参数解释: 应用id。 取值范围: 组件所在的应用id。 |
|
ep_id |
String |
参数解释: 企业项目id。 取值范围: 请选择企业管理中存在的项目ID。 |
请求示例
查询组件信息。
GET https://{Endpoint}/v1/components
响应示例
状态码:200
查询组件信息成功。
{
"data" : [ {
"id" : "string",
"name" : "string",
"code" : "string",
"domain_id" : "string",
"application_id" : "string",
"ep_id" : "string"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询组件信息成功。 |
错误码
请参见错误码。