Querying ASP Collection Results

Function

This API is used to query ASP collection results. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/{project_id}/instances/{instance_id}/asp

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

**Table 3** Request query parameters
Parameter	Mandatory	Type	Description
offset	No	integer	Definition Index offset. The query starts from the next piece of data indexed by this parameter. Constraints N/A Range [0,2^31-1] Default Value 0: The query starts from the first data record.
limit	No	integer	Definition Number of records returned by a query. Constraints N/A Range [1,100] Default Value 10
start_time	No	String	Definition Query start time. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. The plus sign (+) in the time zone must be URL-encoded to %2B, and the minus sign (-) in the time zone does not need to be encoded. For example, in the Beijing time zone, the time zone offset is shown as +0800 and the value (2024-03-16T17:20:33+0800) of start_time needs to be encoded as 2024-03-16T17:20:33%2B0800. Constraints N/A Range N/A Default Value N/A
end_time	No	String	Definition Query end time. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. The plus sign (+) in the time zone must be URL-encoded to %2B, and the minus sign (-) in the time zone does not need to be encoded. For example, in the Beijing time zone, the time zone offset is shown as +0800 and the value (2024-03-16T17:20:33+0800) of end_time needs to be encoded as 2024-03-16T17:20:33%2B0800. Constraints N/A Range N/A Default Value N/A
job_id	No	String	Definition Collection job ID. It is the job ID returned by the ASP collection interface and can be used to filter and query the results of the corresponding collection job. Constraints N/A Range N/A Default Value N/A

Response Parameters

**Table 4** Response body parameters
Parameter	Type	Description
asp	Array of objects	Definition ASP report information. For details, see Table 5.
total_count	Integer	Definition Total number of records. Range N/A

**Table 5** ListAspResult
Parameter	Type	Description
job_id	String	Definition Job ID. Range N/A
file_size	Integer	Definition File size, in KB. Range When the value of status is SUCCESS, the value of this parameter cannot be left blank.
start_time	String	Definition Collection start time. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800. Range N/A
end_time	String	Definition Collection end time. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800. Range N/A
download_url	String	Definition Link for downloading reports. The validity period is 30 minutes. Range When the value of status is SUCCESS, the value of this parameter cannot be left blank.
status	String	Definition Collection status. Range SUCCESS: Reports are collected. FAILED: Reports fail to be collected. EXPORTING: Reports are being collected.

Example Request

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/asp?limit=10&offset=0

Example Response

ASP collection results queried.

{
     "asp": [{
       "job_id": "56c196275a9a59f6c4c047414d64a5a7",
       "file_size": 1024,
       "start_time": "2023-07-24T18:38:10+0800",
       "end_time": "2023-08-01T15:32:11+0800",
       "download_url": "https://dbs-0-sa-fb-1-21a59c4449fd4ef4b20b7c13f5777f42-gaussdbaps.obsv3.xxxx-xx.com:443/53dd8c573f784260915bf5d20d1c54c1_asp_download_c21f2dce295777be230578a8c06d0fea/53dd8c573f784260915bf5d20d1c54c1_532eaf5becaa469c80c13a69b27ad088in14_20240319164211_20240319184211_metric_file_asp.tar.gz?AccessKeyId=72GNY2ZJPZAQW2NHAJU6&Expires=1710846660&Signature=ZkIsI88tDO2DspCD9AGEemrdumc%3D",
       "status": "SUCCESS"
      }],
    "total_count": 10
}