域名管理
1.域名列表
接口功能介绍
无
接口约束
无
URI
GET /cgw/v1/domain/list
Accept: application/json
路径参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
instId | 是 | String | 实例Id | 7a2828074ef6e32e041a2ef124b19e63 | |
pageSize | 否 | Integer | 页码,默认为1 | ||
pageNum | 否 | Integer | 每页记录数,默认为10 |
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | 7a2828074ef6e32e041a2ef124b19e63 |
请求体body参数
响应参数
返回参数说明
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 接口状态码 | 2000 | |
code | String | 错误码,异常时非空 | CGW_1001 | |
returnObj | Object | 返回数据 | PageInfo«DomainVO» | |
message | String | 异常描述 | success |
表 PageInfo«DomainVO»
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
endRow | Long | |||
hasNextPage | Boolean | |||
hasPreviousPage | Boolean | |||
isFirstPage | Boolean | |||
isLastPage | Boolean | |||
list | Array of Objects | DomainVO | ||
navigateFirstPage | Integer | |||
navigateLastPage | Integer | |||
navigatePages | Integer | |||
navigatepageNums | Array of Integer | |||
nextPage | Integer | 下一页 | 2 | |
pageNum | Integer | 页码 | 1 | |
pageSize | Integer | 每页条目数 | 10 | |
pages | Integer | 页数 | 2 | |
prePage | Integer | 前一页 | 1 | |
size | Integer | 总数 | 12 | |
startRow | Long |
表 DomainVO
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
certName | String | 证书名称,协议为HTTPS时使用 | ||
certValidityEnd | String | 证书过期时间,协议为HTTPS时使用 | ||
certValidityStart | String | 证书生效时间,协议为HTTPS时使用 | ||
createTime | String | 创建时间 | 2023-10-10 10:10:10 | |
domainName | String | 域名 | test.com | |
id | String | 域名内部资源id | 123548074ef6e32e041a2ef124123456 | |
protocol | String | 协议 | http | |
sslId | String | 证书id | ||
status | Integer | 域名状态。1:已发布。0:未发布 | 0 | |
updateTime | String | 更新时间 | 2023-10-10 12:12:12 |
请求示例
请求url
https://127.0.0.1:8080/cgw/v1/domain/list?instId=String
请求头header
{
"regionId": "1234567890"
}
请求体body
响应示例
{
"statusCode": 2000,
"message": "success",
"returnObj": {
"total": 1,
"DomainVO": [
{
"id": "00000000000000000039",
"domainName": "[hello.com](http://hello.com)",
"protocol": "http",
"status": 1,
"createTime": "2023-05-10 12:44:11",
"updateTime": "2023-05-10 12:44:11"
}
],
"pageNum": 1,
"pageSize": 10,
"size": 1,
"startRow": 0,
"endRow": 1,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
}
}
状态码
请参考 状态码说明。
错误码
请参考 错误码说明。