调用DescribeStream查询流详情_视图计算(VECS)-阿里云帮助中心

查询流信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vs:DescribeStream	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Id	string	是	流 ID。	323*****997-cn-qingdao

返回参数

名称	类型	描述	示例值
	object
Status	string	流状态。取值： on（在线） off（离线）	on
PlayDomain	string	流所属播流域名。	example.aliyundoc.com
Protocol	string	流协议。	gb28181
DeviceId	string	流所属的设备 ID。	348*****380-cn-qingdao
Height	integer	视频流分辨率高度。	720
RequestId	string	请求 ID。	BEA5625F-8FCF-48F4-851B-CA63946DA664
GroupId	string	流所属的空间 ID。	348*****174-cn-qingdao
Width	integer	视频流分辨率宽度。	1280
App	string	流所属应用。	live
Enabled	boolean	流是否启用。	true
Name	string	流名称。	31000000*****0000002
PushDomain	string	流所属推流域名。	demo.aliyundoc.com
CreatedTime	string	流创建时间。	2019-02-28T17:00:17Z
Id	string	流 ID。	323*****997-cn-qingdao

示例

正常返回示例

JSON格式

{
  "Status": "on",
  "PlayDomain": "example.aliyundoc.com",
  "Protocol": "gb28181",
  "DeviceId": "348*****380-cn-qingdao",
  "Height": 720,
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "GroupId": "348*****174-cn-qingdao",
  "Width": 1280,
  "App": "live",
  "Enabled": true,
  "Name": "31000000*****0000002",
  "PushDomain": "demo.aliyundoc.com",
  "CreatedTime": "2019-02-28T17:00:17Z",
  "Id": "323*****997-cn-qingdao"
}

JSON格式

{
  "Status": "on",
  "PlayDomain": "example.aliyundoc.com",
  "Protocol": "gb28181",
  "DeviceId": "348*****380-cn-qingdao",
  "Height": 720,
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "GroupId": "348*****174-cn-qingdao",
  "Width": 1280,
  "App": "live",
  "Enabled": true,
  "Name": "31000000*****0000002",
  "PushDomain": "demo.aliyundoc.com",
  "CreatedTime": "2019-02-28T17:00:17Z",
  "Id": "323*****997-cn-qingdao"
}

错误码

访问错误中心查看更多错误码。