检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API数据源请求示例中的请求参数。详细内容请参考表2。 表2 请求参数的参数说明 参数名称 是否必填 说明 参数名称 是 API接口涉及参数的参数名称。 参数别名 否 API接口参数的别称。 参数位置 是 参数所处的位置,可以是Header、Body、Parameter。 参数类型 是 参数的类型。
API概览 本章节介绍了目前DataArts Insight所提供的API列表。 表1 DataArts Insight API列表 类型 说明 协同授权API 获取指定的数据源、数据集、仪表板、大屏的资源的详细信息。并对资源协同授权。 工作空间API 查询工作空间详情、创建工作
如何调用API 构造请求 认证鉴权 返回结果
API使用前必读 概述 调用说明 终端节点 基本概念
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度:0 最大长度:8192 X-Workspace-Id
工作空间ID,即控制台的项目ID。 最小长度:0 最大长度:128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度:0 最大长度:8192 响应参数 状态码:
接收方式选择钉钉群、飞书群时需要设置该参数。 webhookurl是一个特定的URL地址,它允许外部应用或服务在特定事件发生时通过HTTP POST请求向钉钉\飞书群发送消息 如何获取钉钉群、飞书群的webhookurl,请参见获取钉钉群的webhookurl、获取飞书群的webhookurl。
Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见构造请求。 DataArts Insight API中除特殊说明外,通常为同步操作,即响应消息中的“is_success”为请求是否执行成功。 父主题: API使用前必读
API导出资源包 功能介绍 API导出资源包。 URI POST /v1/{project_id}/resource-package/export 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 请求参数
API等,其本质都是通过DataArts Insight提供的REST API接口进行请求。 DataArts Insight的接口均需要通过认证鉴权才能访问,控制台发送的请求与调用API接口的请求均支持Token认证鉴权。 访问控制 您可以使用统一身份认证服务(Identity and Access Ma
com/v3/auth/tokens 请求消息头 附加请求消息头字段,如指定的URI和HTTP方法所要求的字段。例如,定义消息体类型的请求消息头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 参数 说明 是否必选 示例 Host 请求的服务器信息,从服
Insight服务进行精细的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM),如果华为云账号已经能满足您的要求,不需要创建独立的IAM用户,您可以跳过本章节,不影响您使用DataArts Insight服务的其他功能。
是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token
请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-Type”。
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。 响应参数
Endpoint}为IAM的终端节点,可以从地区和终端节点获取。 响应示例如下,例如DataArts Insight服务部署的区域为“cn-north-4”,应消息体中查找“name”为“cn-north-4”,其中projects下的“id”即为项目ID。 { "projects":
请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度:0 最大长度:8192 表3 请求Body参数
vpc_ep_server_name 否 String 终端节点服务名称。终端节点服务ID为空时必填。 最小长度:0 最大长度:200 vpc_ep_server_id 否 String 终端节点服务ID。终端节点服务名称为空时必填。 最小长度:0 最大长度:64 响应参数 状态码:
工作空间ID,即控制台的项目ID。 最小长度:0 最大长度:128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度:0 最大长度:8192 响应参数 状态码:200
工作空间ID,即控制台的项目ID。 最小长度:0 最大长度:128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度:0 最大长度:8192 响应参数 状态码: