获取部分提示信息 - ListCommonTips
功能介绍
获取部分提示信息
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/common/tips
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
limit |
是 |
Integer |
每页显示个数，默认200 |
|
type |
否 |
String |
提示信息的类型，包含如下：
|
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_name |
CommonList object |
主机名称 |
|
host_id |
CommonList object |
主机id |
|
public_ip |
CommonList object |
公网ip |
|
private_ip |
CommonList object |
私网ip |
|
vpc_id |
CommonList object |
vpc id |
|
cluster_id |
CommonList object |
集群 id |
|
host_tags |
HostTagInfoList object |
主机资源标签 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data_list |
Array of HostTagValuesInfo objects |
资源标签列表 |
|
total_num |
Integer |
资源标签总数 |
请求示例
查询前10条提示信息。
GET https://{endpoint}/v5/{project_id}/common/tips?limit=10&enterprise_project_id=all_granted_eps
响应示例
状态码：200
请求已成功
{
"total_num" : 1,
"data_list" : [ "host_name" ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
