华为云用户手册

  • 响应示例 状态码: 200 更新仪表板成功。 { "id" : "009b3d3e-xxxx-4cc3-xxxx-dc54cd42424d", "name" : "更新仪表板", "create_user_name" : "xxxx", "create_date" : 1706062051243, "update_user_name" : "xxxx", "update_date" : 1706062051243, "status" : 0 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 仪表板ID。 name String 仪表板名称。 create_user_name String 创建者。 create_date Long 创建时间戳。 update_user_name String 更新者。 update_date Long 更新时间戳。 status Integer 仪表板状态: 0:未发布。 1:已发布。 2:已下线。 枚举值: 0 1 2
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 仪表板ID。 name 是 String 仪表板名称。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 数据总条数。 page_data Array of 表7-9 objects 当前页的分页数据。 表5 TicketVo 参数 参数类型 描述 ticket String ticket。 embed_id String ticket绑定的嵌入分析id。 expire_time String ticket过期时间。 left_num String ticket剩余使用次数。 user_id String ticket绑定的用户id。 user_name String ticket绑定的用户的用户名。 user_type String ticket绑定的用户的用户类型。 group_ids Array of strings ticket绑定的用户组id。
  • URI GET /v1/{project_id}/tickets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 user_id 否 String 用户id。 user_name 否 String 用户名。 user_type 否 Integer 用户类型。 embed_id 否 String 嵌入分析id。 limit 否 Integer 返回条目数。不传该参数时,默认查询前10条信息。取值范围:[0,1000] 默认值:10。 offset 否 Integer 返回条目的起始offset。取值范围:[0,1000] 默认值:0。 sort_dir 否 String 是否降序。 sort_key 否 String 排序字段。
  • 响应示例 状态码: 200 获取ticket列表成功。 { "count": 2, "page_data": [ { "ticket": "848803f514dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "embed_id": "3577e712-xxxxxxxxxxxxxxxxxxxxxxxxxxxx", "expire_time": "2024-08-26 20:48:52 (GMT+08:00)", "left_num": 1000, "user_id": "aaa18eb1xxxxxxx", "user_name": "user_a", "user_type": "IAM", "group_ids": [] }, { "ticket": "22a01f2f8cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "embed_id": "3577e712xxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "expire_time": "2024-08-26 20:48:45 (GMT+08:00)", "left_num": 1000, "user_id": "16246eaxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "user_name": "user_b", "user_type": "IAM", "group_ids": [] } }
  • 响应示例 { "configs" : { "mode" : "0", "field_show_type" : "0", "only_admin_create_datasource" : "0", "works_authorized" : "0", "works_public" : "1", "works_view" : "0" } , "create_time" : 1676984980510, "create_user" : "xxxxxx", "description" : "Description workspace information", "domain_id" : "xxxxxxx", "eps_id" : "xxxxxxxxxx", "id" : "xxxxxxxxxxxxx", "instance_id" : "xxxx7d17c41c414dabaa08f47c7dxxxx", "is_default" : 1, "name" : "Example workspace name", "owner_name" : "xxxxxx", "project_id" : "xxxxxxxb4dac4055888643b3xxxxxx", "update_time" : 1687167926377, "update_user" : "xxxxxxxx" }
  • 请求示例 在项目下创建工作空间。 /v1/{project_id}/instances/{instance_id}/workspaces { "configs" : { "mode" : "0", "field_show_type" : "0", "only_admin_create_datasource" : "0", "works_authorized" : "0", "works_public" : "1", "works_view" : "0" }, "name" : "测试name", "description" : "这是一段测试描述", "eps_id" : "0" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 参数解释: 工作空间ID。获取方法请参见获取工作空间ID。 约束限制: 不涉及 取值范围: 只能使用中英文字符,字符长度32位。 默认取值: 不涉及 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token 认证鉴权 约束限制: 不涉及 取值范围: 非空 默认取值: 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 参数解释: 执行批量操作大屏ID列表。 约束限制: 不涉及 取值范围: 字符串列表,大小限制为1~1000。 默认取值: 不涉及
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 执行批量操作仪表板ID列表。
  • URI PUT /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 workspace_id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 project_id 是 String 项目ID。获取方法请参见获取项目ID。
  • 请求示例 修改项目下工作空间ID为xxxxaaa59ce841f8b4cc2c1305c1xxxx的信息。 /v1/{project_id}/instances/{instance_id}/workspaces/xxxxaaa59ce841f8b4cc2c1305c1xxxx { "configs" : { "mode" : "0", "field_show_type" : "0", "only_admin_create_datasource" : "0", "works_authorized" : "0", "works_public" : "1", "works_view" : "0" }, "name" : "测试name", "description" : "这是一段测试描述", "eps_id" : "0" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 大屏ID。 name String 大屏名称。 pages Array of ScreenPageOpenApiVO objects 大屏Page列表。 表5 ScreenPageOpenApiVO 参数 参数类型 描述 id String Page ID。 name String Page名称。 nodes Array of ScreenNodeOpenApiVO objects Page内组件列表。 表6 ScreenNodeOpenApiVO 参数 参数类型 描述 id String 组件ID。 name String 组件名称。 type String 组件类型。 hidden Boolean 组件是否隐藏。 target_nodes Array of target_nodes objects 交互事件关联组件。 表7 target_nodes 参数 参数类型 描述 id String 关联组件ID。 field_id String 关联组件字段ID。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 参数解释: 工作空间ID。获取方法请参见获取工作空间ID。 约束限制: 不涉及 取值范围: 只能使用中英文字符,字符长度32位。 默认取值: 不涉及 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token 认证鉴权。 约束限制: 不涉及 取值范围: 非空。 默认取值: 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 参数解释: 大屏名称。 约束限制: 不涉及 取值范围: 只允许输入长度为1到32位由数字、中文、英文、空格、下划线(_)或中划线(-)组成的字符,且开头和结尾不能有空格。 默认取值: 不涉及
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String description name 是 String name type 是 String 参数解释: 标签类型,分为用户标签及用户组标签。 约束限制: 不涉及 取值范围: 以下枚举值: user:用户类型标签; userGroup:用户组类型标签。 默认取值: 不涉及 default_value_type 是 String 默认标签值类型,默认为NULL。 NULL:为空; ALL:所有值; ENUM:枚举值,default_value必须有枚举值配置。
  • 请求示例 数据源更新。 PUT /v1/{project_id}/connections/{connection_id} 修改公网连接类型数据源 { "name": "dws02", "server_list": "xx.xx.x.xx:xxxx", "database_name": "gaussdb", "user_name": "xxxxx", "password": "xxxxxxx", "config": { "ssl": true }, "source": "public", "type": "DWS" } 修改DWS云数据源 { "name": "dws04_instance", "description": "测试新增", "source": "dws", "type": "DWS", "database_name": "xxxxx", "user_name": "xxxx", "password": "xxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxxxxxx" }, "config": { "ssl": false } } 修改RDS的MySQL云数据源 { "name": "mysql_instance", "description": "测试新增", "source": "rds", "type": "MySQL", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxxxxxx" }, "config": { "ssl": false } } 修改 GaussDB ForMySQL云数据源 { "name": "gaussdb_mysql_instance", "description": "测试新增", "source": "gaussdb", "type": "MySQL", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxx" }, "config": { "ssl": false } } 修改OpenGauss云数据源 { "name": "gaussdb_instance", "description": "测试新增", "source": "gaussdb", "type": "OpenGauss", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxx" }, "config": { "ssl": false } } 修改PostgreSQL云数据源 { "name": "postgre_instance", "description": "测试新增", "source": "rds", "type": "PostgreSQL", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxxx", "cluster": { "id": "xxxxxxxx" }, "config": { "ssl": false } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 执行批量操作仪表板id列表。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。
  • 响应示例 状态码: 200 OK。 { "create_date" : 1682576908274, "create_user" : "aoeusth", "create_user_name" : "xxxx", "update_date" : 1683343425273, "update_user" : "aeousth", "update_user_name" : "xxxx", "id" : "xxxxx1f0-dea2-472c-aa9c-25928f74xxxx", "resource_type" : "dataset", "resource_id" : "xxxx406b-8662-4adb-a028-a55cxxxx1166", "auth_switch_config" : { "edit" : false, "read" : true }, "owner" : "xxxxx4a863a94b0ba2887b80dcxxxx3", "project_id" : "9c3043axxxac4055888643b331a0bxxx", "workspace_id" : "66a2c96809ad4f62ba09e6b6eeaa2146" }
  • URI GET /v1/{project_id}/authorization/cooperate-authorization/properties 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 resource_id 是 String 资源ID。 resource_type 是 String 参数解释: 资源类型枚举值,用于指定授权对象的类型。 示例:datasource,指定授权对象类型为数据源。 约束限制: 不涉及 取值范围: 以下枚举值: datasource:数据源; dataset:数据集; metric:指标; dashboard:仪表板; screen:大屏; embedAnalysis:嵌入分析; portal:数据门户; subject:智能分析助手。 默认取值: 不涉及
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 user_id_list 是 Array of strings 用户id列表。 sys_role 是 Integer 用户角色: 0未激活; 1通用角色; 2只读用户。
  • URI GET /v1/{project_id}/quota-users/all 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 account_name 否 String 用户名(模糊查询)。 sys_role_list 否 Array 系统角色 0未激活; 1通用用户; 2只读用户。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of 表5 objects - 表5 UserQuotaVo 参数 参数类型 描述 user_id String 用户id。 account_name String 用户名称。 user_type String 用户类型:IAM、SELF-BUILT、DEFAULT sys_role Integer 用户角色: 0未激活; 1通用角色; 2只读用户。 effective_time Long 生效时间戳。
  • 请求示例 POST https://{endpoint}/v1/{project_id}/datasets/save { "id" : "string", "caption" : "id", "status" : "string", "description" : "string", "ds_id" : "string", "ds_name" : "string", "ds_type" : "string", "table_type" : "table|sql", "resource_code" : "string", "physical_schema" : { "tables" : [ { "database_name" : "db_test", "is_fact_table" : false, "schema_name" : "public", "sql_text" : "SELECT * FROM FACT_GDP", "table_name" : "t_test", "table_type" : "table" } ] }, "logical_schema" : { "field_schema" : { "columns" : [ { "caption" : "age", "origin_column_name" : "age", "schema_name" : "public", "table_name" : "modern_bi_0xxxx1c590b14d9xxxx35227166f7f02" } ] }, "variables" : [ { "default_values" : [ "aaa", "bbb" ], "format" : "yyyy-MM-dd", "name" : "limit", "type" : "STRING", "use_scope" : "dataset" } ], "relations" : [ { "source_database_name" : "string", "source_schema" : "string", "source_table_name" : "string", "target_database_name" : "string", "target_schema" : "string", "target_table_name" : "string", "join_type" : "string", "relation" : "string", "joins" : [ { "condition" : "equal-to", "source_key" : "city", "target_key" : "city" } ] } ] } }
  • 响应参数 状态码: 200 表12 响应Body参数 参数 参数类型 描述 caption String 数据集语义化名称。 domain_id String 租户ID。 ds_id String 数据源ID。 ds_type String 数据源类型。 id String 数据集ID。 logical_schema 表13 object 数据集逻辑schema。 physical_schema 表22 object 数据集物理schema。 project_id String 项目ID。 version String 数据集版本:默认为2.0,1.0|2.0。 workspace_id String 工作空间ID。 create_date Long 创建时间戳。 create_user String 创建者ID。 create_user_name String 创建者名称。 update_date Long 更新时间戳。 update_user String 更新者ID。 update_user_name String 更新者名称。 resource_code String 数据集资源标识。 表13 LogicalSchema 参数 参数类型 描述 field_schema 表14 object 字段schema。 relations Array of 表19 objects 物理表关系。 variables Array of 表21 objects SQL变量列表。 表14 DatasetFieldSchemaVO 参数 参数类型 描述 dimensions Array of 表15 objects 维度。 measures Array of 表18 objects 度量。 表15 DimensionVo 参数 参数类型 描述 caption String 维度语义化名。 cube_id String 维度所属物理表ID。 description String 维度描述。 id String 维度ID。 hierarchies Array of 表16 objects 维度层级。 表16 Hierarchy 参数 参数类型 描述 caption String 层级结构语义化名。 levels Array of 表17 objects 层级结构level。 表17 LevelVO 参数 参数类型 描述 caption String 语义化名。 column_formula String level表达式。 data_type String 字段类型,STRING|DATE|DATETIME。 枚举值: STRING|DATE|DATETIME expansion_type Integer 扩展字段类型:0-普通扩展字段;1-聚合扩展字段。 id String ID。 is_expansion Integer 是否为扩展字段:0-不是、1-是。 枚举值: 0 1 level_type String level类型。 origin_column_name String 原始字段名称。 origin_column_type String 原始字段类型。 origin_data_type String 转换前的数据类型,STRING|DATE|DATETIME。 枚举值: STRING|DATE|DATETIME 表18 MeasureVo 参数 参数类型 描述 caption String 度量语义化名。 column_formula String 度量字段表达式。 cube_id String 字段所属物理表id data_type String 数据类型,STRING|NUMBER|DATE|DATETIME。 枚举值: STRING|NUMBER|DATE|DATETIME expansion_type Integer 扩展字段类型,0-普通扩展字段 1-聚合扩展字段。 id String 度量ID。 is_expansion Integer 是否为扩展字段:0-不是,1-是。 origin_column_name String 原始字段名称。 origin_column_type String 原始字段类型。 origin_data_type String 转换前的数据类型,STRING|NUMBER|DATE|DATETIME。 枚举值: STRING|NUMBER|DATE|DATETIME 表19 DatasetRelationVO 参数 参数类型 描述 join_type String 关联类型,left join|right join|inner join。 joins Array of 表20 objects 关联键。 relation String 关系类型,one-to-one|one-to-many|many-to-one。 source String 源表ID。 target String 目标表ID。 表20 DatasetJoinVO 参数 参数类型 描述 condition String 关系,equal-to。 source_key String 源字段id。 source_type String 源字段类型:dimension|measure。 target_key String 目标字段ID。 target_type String 目标字段类型:dimension|measure。 表21 SqlVariable 参数 参数类型 描述 default_values Array of objects 变量默认值。 format String 变量格式,针对日期时间类型变量有效。 name String 变量名称。 type String 参数解释: 变量类型,目前支持文本、数值、日期、系统变量等类型。 约束限制: 不涉及 取值范围: 以下枚举值: STRING:普通文本类型,组装执行sql时“输入值”使用单引号包裹,如:'value'; NUMBER:整数或小数类型,组装执行sql时,直接拼接输入值; YEARREGION:日期-年类型; QUARTERREGION 日期-年季类型; MONTHREGION 日期-年月类型; DATEREGION 日期-年月日类型; YMDHMSREGION 日期-年月日时分秒类型; SYSTEM:系统变量,无法指定具体值,由系统后台填写,如:“访问用户名称”后台将当前访问用户名作为值组装执行sql。 默认取值: 不涉及 use_scope String 变量作用域,dataset|global。 表22 PhysicalSchema 参数 参数类型 描述 tables Array of 表23 objects 物理表信息。 数组长度:0-2147483647 表23 DatasetTableVO 参数 参数类型 描述 id String 表ID。 database_name String 数据库。 schema_name String schema名称。 table_name String 表名。 table_type String 数据集类型。 sql_text String 查询SQL。 is_fact_table Boolean 是否为端点表。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 数据集ID。 caption 是 String 数据集语义化名称。 status 否 String 数据集状态:0,1。 description 否 String 数据集描述。 ds_id 是 String 数据源ID。 ds_name 否 String 数据源名称。 ds_type 否 String 数据源类型。 table_type 是 String 数据集类型: table:不含自定义SQL表的数据集。 sql:含自定义SQL表的数据集。 resource_code 否 String 数据集资源标识。 physical_schema 是 表4 object 数据集物理schema。 logical_schema 是 表6 object 数据集逻辑schema。 表4 PhysicalOpenApiSchema 参数 是否必选 参数类型 描述 tables 是 Array of 表5 objects 物理表信息。 表5 DatasetTableOpenApiVO 参数 是否必选 参数类型 描述 database_name 是 String 数据库。 is_fact_table 是 Boolean 是否为端点表。 schema_name 否 String 模式。 sql_text 否 String 查询SQL。 table_name 是 String 表名。 table_type 是 String 表类型: table:物理表。 sql:自定义SQL表。 表6 LogicalSchemaOpenApiVO 参数 是否必选 参数类型 描述 filed_schema 否 表7 object 字段选择信息。 variables 否 Array of 表9 objects SQL变量列表。 relations 否 Array of 表10 objects 物理表关系。 表7 DatasetFieldSchemaOpenApiVO 参数 是否必选 参数类型 描述 columns 否 Array of 表8 objects 字段选择列表和字段名称赋值。 表8 ColumnOpenApiVO 参数 是否必选 参数类型 描述 caption 是 String 字段名称。 origin_column_name 是 String 字段物理名称,即表中名称。 schema_name 否 String 字段所属schema。 table_name 是 String 字段所属名 表9 SqlVariable 参数 是否必选 参数类型 描述 default_values 否 Array of objects 变量默认值。 format 否 String 变量格式,针对日期时间类型变量有效。 name 是 String 变量名称 type 是 String 参数解释: 变量类型,目前支持文本、数值、日期、系统变量等类型。 约束限制: 不涉及 取值范围: 以下枚举值: STRING:普通文本类型,组装执行sql时“输入值”使用单引号包裹,如:'value'; NUMBER:整数或小数类型,组装执行sql时,直接拼接输入值; YEARREGION:日期-年类型; QUARTERREGION 日期-年季类型; MONTHREGION 日期-年月类型; DATEREGION 日期-年月日类型; YMDHMSREGION 日期-年月日时分秒类型; SYSTEM:系统变量,无法指定具体值,由系统后台填写,如:“访问用户名称”后台将当前访问用户名作为值组装执行sql。 默认取值: 不涉及 use_scope 是 String 变量作用域,dataset|global。 表10 DatasetRelationOpenApiVO 参数 是否必选 参数类型 描述 source_database_name 是 String 源表所属数据库名称。 source_schema 否 String 源表所属schema名称。 source_table_name 是 String 源表名称。 target_database_name 是 String 目标表所属数据库名称。 target_schema 否 String 目标表所属schema名称。 target_table_name 是 String 目标表名称。 join_type 是 String 关联类型。 relation 是 String 关系类型。 joins 是 Array of 表11 objects 关联键 表11 DatasetJoinOpenApiVO 参数 是否必选 参数类型 描述 condition 是 String 关联关系,默认equal-to。 source_key 是 String 源表字段。 target_key 是 String 目标表字段。
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 page_data Array of objects 分页列表内容。详细参数类型请参考CooperateAuthorizationRuleVO 。 count Integer 总条数。 表5 CooperateAuthorizationRuleVO 参数 参数类型 描述 auth_id String 授权主体ID。 auth_level String 授权主体级别。 user:用户 group:用户组 auth_name String 授权主体名称。 authed Boolean 是否已授权。 authority String 权限点,枚举值。 edit、export:编辑和导出权限 edit:编辑权限 export:导出权限 read:查看权限 use:使用权限 说明: 权限之间有依赖关系, 授予edit权限,自动关联授予use、read权限; 授予了export权限,自动关联授予use、read权限。 export、edit二者之前无依赖关系。 create_date Long 创建时间。 create_user String 创建人ID。 create_user_name String 创建人姓名。 id String 授权记录的ID,无实际含义。 is_owner Boolean 是否是资源拥有者。 resource_id String 资源ID。 resource_type String 参数解释: 资源类型枚举值,用于指定授权对象的类型。 示例:datasource,指定授权对象类型为数据源。 约束限制: 不涉及 取值范围: 以下枚举值: datasource:数据源; dataset:数据集; metric:指标; dashboard:仪表板; screen:大屏; embedAnalysis:嵌入分析; portal:数据门户; subject:智能分析助手。 默认取值: 不涉及 sort Integer 排序字段,无实际含义。 update_date Long 修改时间。 update_user String 修改人ID。 update_user_name String 修改人姓名。
  • 请求示例 获取协同授权列表。 GET https://{endpoint}/v1/xxxx3ab4dac4055888643b331axxxx/authorization/cooperate-authorization/rules?resource_type=dataset&resource_id=f8e5406b-8662-4adb-a028-a55c76ae1166&auth_level=user&filer_authed=false&limit=20&offset=0&sort_dir=asc
  • 响应示例 状态码: 200 OK。 { "page_data" : [ { "create_date" : 1690593374608, "create_user" : "xxxxxf45cea249a2aa648a20e46xxxxx", "create_user_name" : "xxxxxx", "update_date" : 1690593374608, "update_user" : "558def45cea249a2aa648a20e46xxxxx", "update_user_name" : "xxxxx", "id" : "73281a3b-a828-494a-bb0d-e88c688a5e81", "resource_type" : "dashboard", "resource_id" : "e3158b30-30bc-495a-b0d8-59e66e1xxxxx", "auth_level" : "user", "auth_id" : "xxxxf45cea249a2aa648a20e46xxxx", "auth_name" : "xxxxxx", "is_owner" : true, "authed" : true, "sort" : 4, "authority" : "edit" }, { "create_date" : 1690593374608, "create_user" : "xxxxxf45cea249a2aa648a20e46xxxxx", "create_user_name" : "xxxxxx", "update_date" : 1690593374608, "update_user" : "558def45cea249a2aa648a20e46xxxxx", "update_user_name" : "xxxxx", "id" : "73281a3b-a828-494a-bb0d-e88c688a5e81", "resource_type" : "dashboard", "resource_id" : "e3158b30-30bc-495a-b0d8-59e66e1xxxxx", "auth_level" : "user", "auth_id" : "xxxxf45cea249a2aa648a20e46xxxx", "auth_name" : "xxxxxx", "is_owner" : true, "authed" : true, "sort" : 4, "authority" : "edit,export" } ], "count" : 2147483647 }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全