查询ASP采集结果
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/instances/{instance_id}/asp
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID,此参数是用户创建实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
X-Language |
否 |
String |
参数解释: 语言。 约束限制: 不涉及。 取值范围:
默认取值: en-us。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
integer |
参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制: 不涉及。 取值范围: [0,2^31-1] 默认取值: 默认为0(偏移0条数据,表示从第一条数据开始查询)。 |
limit |
否 |
integer |
参数解释: 查询记录数。 约束限制: 不涉及。 取值范围: [1,100] 默认取值: 默认为10。 |
start_time |
否 |
String |
参数解释: 查询开始时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始,Z指时区偏移量,时区中的+号需要进行URL编码,编码为%2B,时区中的-号无需编码。 例如北京时间偏移显示为+0800,start_time=2024-03-16T17:20:33+0800传参时编码为start_time=2024-03-16T17:20:33%2B0800。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
end_time |
否 |
String |
参数解释: 查询结束时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始,Z指时区偏移量,时区中的+号需要进行URL编码,编码为%2B,时区中的-号无需编码。 例如北京时间偏移显示为+0800,end_time=2024-03-16T17:20:33+0800传参时编码为end_time=2024-03-16T17:20:33%2B0800。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
job_id |
否 |
String |
参数解释: 采集任务ID。 下发ASP采集接口返回的job_id,可过滤查询对应采集任务的结果。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
asp |
Array of objects |
参数解释: ASP报告信息列表。详细内容请参见表5。 |
total_count |
Integer |
参数解释: 总记录数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
参数解释: 任务ID。 取值范围: 不涉及。 |
file_size |
Integer |
参数解释: 文件大小单位KB。 取值范围: 当status为SUCCESS时,该值不为空。 |
start_time |
String |
参数解释: 开始采集时间。 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 取值范围: 不涉及。 |
end_time |
String |
参数解释: 结束采集时间。 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 取值范围: 不涉及。 |
download_url |
String |
参数解释: 报告下载链接,有效时间为30分钟。 取值范围: 当status为SUCCESS时,该值不为空。 |
status |
String |
参数解释: 采集状态。 取值范围:
|
请求示例
GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/d04686c6baae4f65a742771186f47b7ain14/asp?limit=10&offset=0
响应示例
查询ASP采集结果列表。
{ "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", "file_path": "53dd8c573f784260915bf5d20d1c54c1_asp_download_c21f2dce295777be230578a8c06d0fea/", "file_name": "53dd8c573f784260915bf5d20d1c54c1_532eaf5becaa469c80c13a69b27ad088in14_20240319164211_20240319184211_metric_file_asp.tar.gz", "obs_bucket": { "name": "dbs-0-sa-fb-1-21a59c4449fd4ef4b20b7c13f5777f42-gaussdbaps", "type": "aps", "url": "obsv3.sa-fb-1.guiyang-x86-3.com", "port": 443, "domain_id": "d0409f2f635a4a0d99227d6a8b6fb795" } }], "total_count": 10 }
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。