查询数据源列表

功能介绍

查询数据源列表

调试

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

URI

GET /v1/{project_id}/datasources

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	projectid 最小长度：1 最大长度：128

表2 Query参数
参数	是否必选	参数类型	描述
name	否	String	数据源名称最小长度：0 最大长度：128
type	否	String	数据源类型, 包括：IOTDA、API、DIS 最小长度：0 最大长度：256
limit	否	Integer	每次查询返回元素的上限最小值：1 最大值：100 缺省值：100
offset	否	Integer	页码，从0开始，0表示第1页最小值：0 最大值：65535 缺省值：0

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	租户Token 最小长度：1 最大长度：65535

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
count	Integer	总数最小值：0 最大值：65535
datasources	Array of DatasourceRestDTO objects	数据源列表

表5 DatasourceRestDTO
参数	参数类型	描述
id	String	数据源id 最小长度：1 最大长度：256
name	String	数据源名称最大长度：128
type	String	数据源类型, 包括：IOTDA、API、DIS。数据源不支持修改类型。
content	ContentDetailRsp object	数据源详细配置内容
created_time	String	创建时间，格式为：yyyy-MM-dd'T'HH:mm:ss'Z' 最小长度：1 最大长度：64
modified_time	String	修改时间，格式为：yyyy-MM-dd'T'HH:mm:ss'Z' 最小长度：1 最大长度：64

表6 ContentDetailRsp
参数	参数类型	描述
iotda_content	IotdaContentRsp object	IoTDA数据源详细配置内容
dis_content	DisContentRsp object	DIS数据源详细配置内容
api_content	ApiContentRsp object	API数据源配置

表7 IotdaContentRsp
参数	参数类型	描述
iotda_instance_id	String	IoTDA实例Id 最小长度：1 最大长度：256
rules	Array of IotdaContentRuleRsp objects	在IoTDA实例中要配置的转发规则，包含推送数据的资源空间和产品列表

表8 IotdaContentRuleRsp
参数	参数类型	描述
app_id	String	IoTDA中的资源空间Id 最小长度：1 最大长度：256
products	Array of strings	IoTDA中某资源空间Id下的产品列表
rule_actions	Array of IotdaRuleAction objects	IoTDA中rule_id和action_id列表

表9 IotdaRuleAction
参数	参数类型	描述
rule_id	String	IoTDA中的规则Id 最小长度：1 最大长度：256
action_id	String	IoTDA中推送数据动作ID 最小长度：1 最大长度：256

**表10** DisContentRsp
参数	参数类型	描述
streamName	String	通道名称最小长度：1 最大长度：256
ak	String	租户的AK 最小长度：1 最大长度：256
sk	String	租户的SK 最小长度：1 最大长度：256
projectId	String	项目id 最小长度：1 最大长度：128

**表11** ApiContentRsp
参数	参数类型	描述
name	String	数据源名称最小长度：1 最大长度：128
url	String	数据上报url 最小长度：1 最大长度：512

请求示例

无

响应示例

状态码： 200

search results

{
  "count" : 1,
  "datasources" : [ {
    "id" : "125606569c5cf5fx7qk2",
    "name" : "test05",
    "type" : "API",
    "content" : {
      "api_content" : {
        "name" : "test05",
        "url" : "https://ip:port/v1/yourProjectId/datasources/yourDatasourceId/dev-data"
      }
    },
    "created_time" : "2021-09-02T00:00:00Z",
    "modified_time" : "2021-09-02T00:00:00Z"
  } ]
}