功能介绍

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

• 开通成功后，可以获取SIP服务器地址以及端口，用于设备的注册。
• 开通成功后，可以获取设备，凭证以及视频流的配额信息，详见quota参数说明。

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

  POST /v1/{project_id}/subscription

• 参数说明

  参数	是否必选	类型	说明
  project_id	是	String	项目ID，获取方法请参见获取项目ID。

请求消息

• 请求样例

  POST https://{endpoint}/v1/{project_id}/subscription

响应消息

• 响应样例

  {
      "user_id": "422b1f6045184a8194e021113e87d898",
      "sip_ip": "10.95.144.196",
      "sip_port": "5080",
      "quota": {
             "consecutive_access_time": {
                    "total": 120,
                    "used": 120
             },
             "password": {
                    "total": 10,
                    "used": 2
             },
             "random_access_time": {
                    "total": 240,
                    "used": 240
             },
             "stream": {
                    "total": 100000,
                    "used": 8
             },
             "active_stream": {
                    "total": 200,
                    "used": 4
             },
             "device": {
                    "total": 100000,
                    "used": 0
             },
             "aksk": {
                    "total": 10,
                    "used": 6
             }
      },
      "created_at": "2018-10-25T03:06:10Z",
      "is_subscribed": true
  }

• 参数说明

  参数	类型	说明
  user_id	String	用户ID。
  sip_ip	String	SIP服务器地址，VIS对外提供的设备注册地址。
  sip_port	String	SIP服务器端口，VIS对外提供的设备注册端口，固定为5080。
  quota	Object	用户的配额信息，详见quota参数说明。
  created_at	String	创建时间，格式为：YYYY-MM-DDTHH:MM:SSZ（UTC时间）。
  is_subscribed	Boolean	用户是否开通服务。 true：表示开通。 false：表示未开通。

• quota参数说明

  参数	类型	说明
  password	Object	GB28181凭证的配额信息，分为： total：总配额个数。 used：已创建个数。
  consecutive_access_time	Object	GB28181设备连续接入时长的配额信息。 total：总时长。 used：已使用的时长。 单位：分钟。
  random_access_time	Object	GB28181设备随机接入时长的配额信息。 total：总时长。 used：已使用的时长。 单位：分钟。
  stream	Object	视频流配额信息，分为： total：总配额数。 used：已创建的数量。
  active_stream	Object	激活视频流配额信息，分为： total：可激活的视频流总数。 used：已激活的视频流数量。
  device	Object	设备配额信息，分为： total：设备总配额数。 used：已创建的数量。
  aksk	Object	AKSK凭证配额信息，分为： total：总配额数。 used：已创建的数量。

返回值

• 正常

  200

• 异常

  返回值	说明
  400 Bad Request	请求错误。具体返回错误码请参考错误码说明。
  401 Unauthorized	鉴权失败。
  403 Forbidden	没有操作权限。
  404 Not Found	找不到资源或没有开通服务。
  500 Internal Server Error	服务内部错误。
  503 Service Unavailable	服务不可用。