Obtaining Some Prompt Information

Function

This API is used to obtain some prompt information.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/common/tips

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
limit	Yes	Integer	Number of records displayed on each page. The default value is 200.
type	No	String	Information type. The options are as follows: host_name: server name host_id: server ID public_ip: EIP private_ip: private IP address vpc_id: VPC ID cluster_id: cluster ID host_tags: server tag

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
host_name	CommonList object	Host name
host_id	CommonList object	Host ID.
public_ip	CommonList object	Public IP address
private_ip	CommonList object	Private IP address
vpc_id	CommonList object	vpc id
cluster_id	CommonList object	Cluster ID.
host_tags	HostTagInfoList object	Host resource tag

**Table 4** CommonList
Parameter	Type	Description
data_list	Array of strings	Prompt list.
total_num	Integer	Total number of messages

**Table 5** HostTagInfoList
Parameter	Type	Description
data_list	Array of HostTagValuesInfo objects	Resource tag list
total_num	Integer	Total number of resource tags

**Table 6** HostTagValuesInfo
Parameter	Type	Description
key	String	Resource tag key
values	Array of strings	Resource tag values

Example Requests

Query the first 10 messages.

GET https://{endpoint}/v5/{project_id}/common/tips?limit=10&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "host_name" : {
    "total_num" : null,
    "data_list" : [ ]
  },
  "host_id" : {
    "total_num" : null,
    "data_list" : [ ]
  },
  "public_ip" : {
    "total_num" : null,
    "data_list" : [ ]
  },
  "private_ip" : {
    "total_num" : null,
    "data_list" : [ ]
  },
  "vpc_id" : {
    "total_num" : null,
    "data_list" : [ ]
  },
  "host_tags" : {
    "data_list" : [ {
      "key" : "&",
      "values" : [ "1" ]
    } ],
    "total_num" : 1
  },
  "cluster_id" : {
    "data_list" : [ "cb5a8193-be3a-11f0-8f82-0255ac100b06" ],
    "total_num" : 6
  }
}