目录

查询第三方平台的平台级域名信息

功能介绍

此接口用于获取第三方平台中平台级的域名配置信息。

接口原型

承载协议

HTTPS GET

接口方向

服务商服务器 -> 华为服务器

接口URL

https://connect-api.cloud.huawei.com/api/tpp/v1/domain-manage/domain

数据格式

响应消息：Content-Type: application/json

请求参数

[h2]Header

参数

必选(M)/可选(O)

类型

说明

client_id

M

String

API客户端ID。

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

Authorization

M

String

认证信息。

格式为“Authorization: Bearer ${access_token}”。access_token为获取平台级Token中获取的access_token。

[h2]Query

参数名称

必选(M)/可选(O)

类型

参数说明

category

M

String(32)

域名分类。

取值范围：

  • server：服务器域名
  • business：业务域名

请求示例

 GET /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 *******

响应参数

参数

必选(M)/可选(O)

类型

说明

ret

M

CodeAndMsg

包含返回码及描述信息。

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

domains

M

List<DomainInfo>

域名列表信息。

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"
  },
  "domains": [
    {
      "type": "httpRequest",
      "value": "https://xxx.xxx.com",
      "errorCode": 0,
      "errorMsg": "******"
    }
  ]
}