文档首页/ 数据可视化 DLV/ API参考/ 快速入门
更新时间：2021-03-18 GMT+08:00
查看PDF
分享

快速入门

本节通过调用API来创建大屏，流程如下：

1.调用Token认证获取用户的Token信息，在后续的请求中需要将Token放到请求消息头中作为认证。

2.调用接口创建大屏。

前提条件

操作步骤

假设已获取前提条件中的信息为如下值（实际操作中您需要根据实际情况替换）：

  • IAM的Endpoint：下面示例中以iam_endpoint代替。
  • DLV的Endpoint：下面示例中以dlv_endpoint代替。
  • 项目编号projectId：下面示例中以project_id代替。

则可以通过如下步骤创建一个大屏。

  1. 调用Token认证其他接口前，需要获取Token，并设置成环境变量。 

    curl -H "Content-Type:application/json" https://iam_endpoint/v3/auth/tokens -X POST -d '{ 
    "auth": { 
        "identity": { 
            "methods": [ 
                "password" 
            ], 
            "password": { 
                "user": { 
                    "name": "testname", 
                    "domain": { 
                        "name": "testname" 
                    }, 
                    "password": "Passw0rd" 
                } 
            } 
        }, 
        "scope": { 
            "project": { 
                "name": "cn-north-1"
            } 
        } 
    } 
}' -v -k

    响应Header中“X-Subject-Token”的值即为Token：

    X-Subject-Token:MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...

    使用如下命令将Token设置为环境变量，方便后续事项。其中，“X-Auth-Token”的值为上一步骤中获取到的Token值。

    export Token=MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...

  2. 调用新增大屏接口。 

    curl -X POST -H 'Content-Type:application/json;charset=utf-8' -H "X-Auth-Token:$Token" -d '{ 
    "name": "my_screen", 
    "alias": "first_screen", 
    "description": "my first screen", 
    "template_id": "453113551",
    "workspaceId":"86ce107974ce4f93b618acb232863027"
    } 
}' https://dlv_endpoint/v1/project_id/screens -v -k

    参数说明：

    • name：大屏的名称。
    • alias：大屏的别名。
    • description：大屏的描述信息。
    • template_id：用于创建大屏的模板ID。
    • workspaceId：工作空间ID。

    如果返回状态码为200，则说明创建大屏成功。如果失败，异常状态码请参见状态码。

相关文档