文档首页/ 视频接入服务 VIS/ API参考/ 服务开通管理/ 开通服务
更新时间：2024-07-03 GMT+08:00
查看PDF
分享

开通服务

功能介绍

此接口用于用户申请开通视频接入服务。

接口约束

目前"华北-北京一"和"华东-上海二"区域不支持新用户开通。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/subscription

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

普通租户的token。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

X-Project-Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息。

响应参数

状态码： 201

表3 响应Body参数

参数

参数类型

描述

user_id

String

用户ID。

sip_ip

String

SIP服务器地址，VIS对外提供的设备注册地址。

sip_port

String

SIP服务器端口，VIS对外提供的设备注册端口，固定为5080。

quota

quotaInfo object

开通服务返回的quota体。

created_at

String

创建时间，格式为：YYYY-MM-DDTHH:MM:SSZ（UTC时间）。

is_subscribed

Boolean

用户是否开通服务。

  • true：表示开通。
  • false：表示未开通。
表4 quotaInfo

参数

参数类型

描述

password

PassWordInfo object

GB/T28181凭证配额信息。

consecutive_access_time

Consecutive_Access_TimeInfo object

GB/T28181设备连续接入时长的配额信息。

random_access_time

Random_Access_TimeInfo object

GB/T28181设备随机接入时长的配额信息。

stream

StreamInfo object

视频流配额信息。

active_stream

Active_StreamInfo object

激活视频流配额信息。

device

DeviceInfo object

设备配额信息。

aksk

AKSKInfo object

AKSK凭证配额信息。

http_num

HttpInfo object

http_flv配额信息。

http_active_num

HttpActiveInfo object

http_flv激活配额信息。

rtmp_num

RtmpInfo object

rtmp配额信息。
表5 PassWordInfo

参数

参数类型

描述

total

Integer

GB/T28181凭证总配额量。

used

Integer

GB/T28181凭证已创建量。
表6 Consecutive_Access_TimeInfo

参数

参数类型

描述

total

Integer

设备连续接入的总时长。

used

Integer

设备已使用的时长。
表7 Random_Access_TimeInfo

参数

参数类型

描述

total

Integer

GB/T28181设备随机接入的总时长。

used

Integer

GB/T28181设备随机已接入的时长。
表8 StreamInfo

参数

参数类型

描述

total

Integer

视频流总配额量。

used

Integer

视频流已创建量。
表9 Active_StreamInfo

参数

参数类型

描述

total

Integer

可激活视频流总配额量。

used

Integer

视频流已激活量。
表10 DeviceInfo

参数

参数类型

描述

total

Integer

设备总配额量。

used

Integer

设备已创建量。
表11 AKSKInfo

参数

参数类型

描述

total

Integer

AKSK凭证总配额量。

used

Integer

AKSK凭证已创建量。
表12 HttpInfo

参数

参数类型

描述

total

Integer

http_flv总配额数量。

used

Integer

http_flv已创建数量。
表13 HttpActiveInfo

参数

参数类型

描述

total

Integer

http_flv激活总配额数量。

used

Integer

http_flv已激活数量。
表14 RtmpInfo

参数

参数类型

描述

total

Integer

rtmp总配额数量。

used

Integer

rtmp已创建数量。

请求示例

POST /v1/3266392d188c47d09948b1**********/subscription

响应示例

状态码： 201

正常

{
  "user_id" : "******6045184a8194e021113e******",
  "sip_ip" : "10.95.144.***",
  "sip_port" : "5080",
  "quota" : {
    "consecutive_access_time" : {
      "total" : 120,
      "used" : 0
    },
    "password" : {
      "total" : 10,
      "used" : 0
    },
    "random_access_time" : {
      "total" : 240,
      "used" : 0
    },
    "stream" : {
      "total" : 50,
      "used" : 0
    },
    "active_stream" : {
      "total" : 10,
      "used" : 0
    },
    "device" : {
      "total" : 50,
      "used" : 0
    },
    "aksk" : {
      "total" : 10,
      "used" : 0
    },
    "http_num" : {
      "total" : 10,
      "used" : 0
    },
    "http_active_num" : {
      "total" : 5,
      "used" : 0
    },
    "rtmp_num" : {
      "total" : 0,
      "used" : 0
    }
  },
  "created_at" : "2018-10-25T03:06:10Z",
  "is_subscribed" : true
}

状态码： 400

请求错误。具体返回错误码请参考错误码说明。

{
  "error_msg" : "You have already subscribed to VIS.",
  "error_code" : "VIS.0018"
}

状态码

状态码

描述

201

正常。

400

请求错误。具体返回错误码请参考错误码说明。
父主题： 服务开通管理

相关文档