You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /
  • 视频点播

停用域名

最近更新时间：2024.02.05 18:02:29

首次发布时间：2023.11.07 18:16:37

我的收藏

此接口用于停用域名。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

  • 请求方式：GET
  • 请求地址：https://vod.volcengineapi.com?Action=StopDomain&Version=2023-07-01

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数类型是否必选示例值描述
ActionString是StopDomain接口名称。当前 API 的名称为 StopDomain。
VersionString是2023-07-01接口版本。当前 API 的版本为 2023-07-01。

SpaceName

String

是

test

点播空间名。您可通过以下方式获取空间名称：

  • 在视频点播控制台空间管理页面查看当前账号下所有空间的名称。
  • 调用 ListSpace 接口获取当前账号下所有空间的名称。

DomainType

String

是

play

域名类型。取值如下：

  • play：播放域名。
  • image：封面域名。

Domain

String

是

example.vod.com

域名。您可通过 ListDomain 接口获取当前空间账号下的所有域名列表。域名规则如下：

  • 支持精确域名。
  • 不支持添加泛域名，如 *.vod.com。
  • 不支持大写。
  • 不支持重复域名。

SourceStationType

Integer

是

1

源站类型。取值如下：

  • 1：点播源站。
  • 2：自定义源站。

返回参数

本接口无特有的返回参数。具体请见公共返回参数。

请求示例

GET https://vod.volcengineapi.com?Action=StopDomain&Version=2023-07-01&SpaceName=test&DomainType=play&Domain=example.vod.com&SourceStationType=1

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420***00232280022D31",
    "Action": "StopDomain",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：