接口功能介绍
检查CNAME记录集合法性
接口约束
URI
POST /v4/private-zone-record/check-cname
请求参数
请求体Body参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
cnameRecords | Array of String | 是 | 待检查的 cname 数组,数组长度最大支持 10 | ["a.b.c"] |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
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 | Object | 检查结果 | 见下表 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
results | Array of Object | 检查结果 | 见下表 |
表 results
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
cname | String | 被检查的 cname | a.b.c |
valid | Boolean | 是否合法 | true |
message | String | 提示信息 |
请求示例
POST /openapi/v4/private-zone-record/check-cname
请求体Body
{
"cnameRecords": ["a.b.c"]
}
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": {
"results": [{
"cname": "a.b.c",
"valid": true,
"message": ""
}]
}
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。