接口功能介绍
查看前缀列表关联的资源。
接口约束
无
URI
GET /v4/prefixlist/get_associations
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
regionID | 是 | String | 区域 id | |
prefixListID | 是 | String | 前缀列表的ID | |
pageNumber | 否 | Integer | 列表的页码,默认值为 1。 | 1 |
pageNo | 否 | Integer | 列表的页码,默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 |
pageSize | 否 | Integer | 分页查询时每页的行数,最大值为 50,默认值为 10。 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | |
description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | |
errorCode | String | statusCode为900时为业务细分错误码,三段式:product.module.code; statusCode为800时为SUCCESS | SUCCESS | |
returnObj | Array of Objects | 接口业务数据 | 见下表 | returnObj |
totalCount | Integer | 总条数 | 40 | |
totalPage | Integer | 总页数 | 4 | |
currentCount | Integer | 当前页总数 | 10 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
resourceID | String | 资源ID | sg-xggokhki1e | |
resourceName | String | 资源名称 | sgs-184f | |
resourceType | String | 资源类型 | sg |
请求示例
请求url
GET /openapi/v4/prefixlist/get_associations?regionID=81f7728662dd11ec810800155d307d5b&prefixListID=xxxx
请求头header
无
请求体body
无
响应示例
{
"currentCount": 1,
"totalPage": 1,
"traceid": "f2ba232f0579f8f1a9980d9bcba80cbf",
"description": "成功",
"returnObj": [
{
"resourceType": "sg",
"resourceID": "sg-9znfwe6l9i",
"resourceName": "Default-Security-Group"
}
],
"errorCode": "SUCCESS",
"totalCount": 1,
"message": "success",
"statusCode": 800
}
状态码
请参考状态码说明。
错误码
请参考错误码说明。