You need to enable JavaScript to run this app.
导航
添加域名
最近更新时间:2022.08.19 18:14:03首次发布时间:2022.08.19 18:14:03

在指定空间内添加自定义域名。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考「公共参数」。

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称AddSpaceDomain
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01
SpaceIDQueryString空间 ID可通过调用 ListSpaces 接口获取

Body 参数

字段
类型
必填
说明
DomainString域名(指定的域名必须在中国大陆地区完成 ICP 备案)

Type

String

域名类型,可选枚举值包括:

  • pull(拉流域名)
  • push(推流域名)

返回结果

返回参数说明

通用返回参数,请参考 ResponseMetadata 结构体说明

Result 字段包含以下参数:

字段
类型
说明
IDString域名添加成功,返回空间 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=AddSpaceDomain
&Version=2021-01-01
&SpaceID=a2d6ca94-334b-4f81-b89c-02d381xxxxxx
&<公共请求参数>
{
    "Domain": "domain-name.push.example.com",
    "Type": "push"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022072717340801021214803704146B3F",
        "Action": "AddSpaceDomain",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "a2d6ca94-334b-4f81-b89c-02d381xxxxxx"
    }
}