承载协议	HTTPS POST
接口方向	服务商服务器 -> 华为服务器
接口URL	https://connect-api.cloud.huawei.com/api/tpp/v1/domain-manage/domain
数据格式	请求：Content-Type: application/json 响应：Content-Type: application/json

请求参数

Header

展开

参数	必选(M)/可选(O)	类型	说明
client_id	M	String	API客户端ID。创建第三方平台成功后系统自动分配的客户端ID，可在第三方管理平台“开发配置 > 开发资料设置”页面中获取，详情请参见获取平台访问凭据。
Authorization	M	String	认证信息。格式为“Authorization: Bearer ${access_token}”。其中，${access_token}为获取平台级Token中获取的access_token。

参数

必选(M)/可选(O)

类型

说明

client_id

String

API客户端ID。

创建第三方平台成功后系统自动分配的客户端ID，可在第三方管理平台“开发配置 > 开发资料设置”页面中获取，详情请参见获取平台访问凭据。

Authorization

String

认证信息。

格式为“Authorization: Bearer ${access_token}”。

其中，${access_token}为获取平台级Token中获取的access_token。

Query

展开

参数名称	必选(M)/可选(O)	类型	参数说明
category	M	String(32)	域名分类。取值范围： server：服务器域名 business：业务域名

参数名称

必选(M)/可选(O)

类型

参数说明

Body

请求Body中使用JSON格式携带测试群组信息，参数如下表所示。

展开

参数名称	必选(M)/可选(O)	类型	参数说明
domains	M	List<UpdateDomainInfo>	域名全量数据。集合长度最大3000。

参数名称

必选(M)/可选(O)

类型

参数说明

domains

List<UpdateDomainInfo>

域名全量数据。

集合长度最大3000。

UpdateDomainInfo

展开

参数名称

必选(M)/可选(O)

类型

参数说明

type

String(32)

域名类型。

取值范围：

httpRequest：httpRequest服务器域名
upload：upload服务器域名
download：download服务器域名
webSocket：webSocket服务器域名
webView：webView业务域名

value

String(128)

域名。

请输入完整的域名，例如https://baidu.com:8080。

请求示例

收起
自动换行
深色代码主题
复制
 POST /api/tpp/v1/domain-manage/domain?category=server HTTP/1.1
 Host: connect-api.cloud.huawei.com 
 client_id: 4141******68 
 Content-Type: application/json 
 Authorization: Bearer ******* 
  {
  "domains": [
    {
      "type": "httpRequest",
      "value": "https://xxx.xxx.com"
    }
  ]
}

响应参数

展开

参数名称	必选(M)/可选(O)	类型	参数说明
ret	M	CodeAndMsg	包含返回码及描述信息。返回码详情请参见错误码。
invalidDomains	O	List<DomainInfo>	不合法的域名列表。当ret不为成功的时候存在，供前台按需展示。

参数名称

必选(M)/可选(O)

类型

参数说明

ret

CodeAndMsg

包含返回码及描述信息。

返回码详情请参见错误码。

invalidDomains

List<DomainInfo>

不合法的域名列表。

当ret不为成功的时候存在，供前台按需展示。

CodeAndMsg

展开

参数	必选(M)/可选(O)	类型	说明
code	M	Integer	返回码。
msg	M	String	返回码描述信息。

DomainInfo

展开

参数名称	必选(M)/可选(O)	类型	参数说明
type	M	String(32)	域名类型。取值范围： httpRequest：httpRequest服务器域名 upload：upload服务器域名 download：download服务器域名 webSocket：webSocket服务器域名 webView：webView业务域名
value	M	String(128)	域名。请输入完整的域名，例如https://baidu.com:8080。
errorCode	O	Integer(32)	非法原因错误码。新增、修改域名时如果域名不合法，返回失败原因，调用接口新增修改域名配置时无需传入。
errorMsg	O	String(128)	非法原因错误描述。新增、修改域名时如果域名不合法，返回失败原因，调用接口新增修改域名配置时无需传入。

响应示例

收起
自动换行
深色代码主题
复制
{
  "ret": {
    "code": 0,
    "msg": "success"
  },
  "invalidDomains": [
    {
      "type": "httpRequest",
      "value": "https://xxx.xxx.com",
      "errorCode": 0,
      "errorMsg": "******"
    }
  ]
}