华为云用户手册

  • 响应示例 { "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" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 工作空间名称。 最小长度:0 最大长度:1024 description 否 String 工作空间描述。 最小长度:0 最大长度:10240 eps_id 是 String 工作空间所属企业项目ID。 最小长度:0 最大长度:128
  • 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。 在我的凭证下,您可以查看项目ID。 图1 项目隔离模型
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 1 2 3 4 5 6 7 8 9 10 11 12 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 1 2 3 4 5 6 7 8 { "error":{ "code":401, "message": "The username or password is wrong.", "title": "Unauthorized" } } 其中,code表示错误码,message表示错误描述信息。
  • 请求示例 修改项目下工作空间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" }
  • URI PUT /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 workspace_id 是 String 工作空间ID,即控制台的项目ID。 可以通过查询工作空间获取工作空间ID。 project_id 是 String 项目id。获取方法请参考获取项目ID。
  • 响应参数 表3 响应Body参数 参数 参数类型 描述 id String 任务ID。 最小长度:0 最大长度:128 name String 导入名称。 最小长度:0 最大长度:256 domain_id String domainID。 最小长度:0 最大长度:128 project_id String 项目ID。 最小长度:0 最大长度:64 workspace_id String 工作空间id。 最小长度:0 最大长度:128 import_param String 导入参数清单。 最小长度:0 最大长度:512 obs_bucket String obs桶名称。 最小长度:0 最大长度:128 obs_object_key String obs对象路径。 最小长度:0 最大长度:1024 import_detail String 导入明细。 最小长度:0 最大长度:4000 status Integer 结果状态:-1:未激活 0:待处理 1:成功;2:失败;3:部分成功 4:处理中。 枚举值: -1 0 1 2 3 4 error_msg String 任务失败原因。 最小长度:0 最大长度:512 import_type String import:资源包导入;crossSpaceImport:跨空间一键导入。 最小长度:0 最大长度:128 create_user String 创建者ID。 最小长度:0 最大长度:64 create_user_name String 创建者名称。 最小长度:0 最大长度:256 create_date Long 创建时间戳。 最小值:0 最大值:9223372036854775807 update_date Long 更新时间戳。 最小值:0 最大值:9223372036854775807
  • 响应示例 导入任务详情。 { "id" : "2406a337-xxxx-a5b2-b01a61d2043b", "name" : "string", "domain_id" : "ad9e2f08-xxxx-87eb-1f9619b6c313", "project_id" : "string", "workspace_id" : "12913c92-xxxx-b8fd-a72af3945b61", "import_param" : "", "obs_bucket" : "test", "obs_object_key" : "test.zip", "import_detail" : "导入成功【 导出资源清单 】 数据源: 1 ;【 导入参数清单 】: 目标工作空间: 示例工作空间 ; 是否替换: false ;是否携带权限信息:false", "status" : 1, "error_msg" : "string", "import_type" : "import|crossSpaceImport", "create_user" : "string", "create_user_name" : "string", "create_date" : 9223372036854776000, "update_date" : 9223372036854776000 }
  • 请求示例 数据源更新。 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 } }
  • URI DELETE /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 workspace_id 是 String 工作空间ID,即控制台的项目ID。 可以通过查询工作空间获取工作空间ID。 project_id 是 String 项目ID。获取方法请参考获取项目ID。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID,即控制台的项目ID。 可以通过查询工作空间获取工作空间ID。 最小长度:0 最大长度:128 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。 最小长度:0 最大长度:8192
  • 响应示例 状态码: 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。 最小长度:0 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 resource_id 是 String 资源ID。 最小长度:0 最大长度:128 resource_type 是 String 资源类型。 支持的资源类型:Datasource,Dataset,Dashboard,Screen,Subject。 最小长度:0 最大长度:128
  • 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 例如,对于IAM获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,例如cn-north-1,可以从地区和终端节点中获取。 scope参数定义了Token的作用域,下面示例中IAM获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见IAM获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于IAM获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求消息头 附加请求消息头字段,如指定的URI和HTTP方法所要求的字段。例如,定义消息体类型的请求消息头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 参数 说明 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型(格式),默认取值为“application/json”,有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度,单位为Byte。 POST/PUT请求必填。 GET不能包含。 3495 X-Project-ID project id,项目编号。在多项目场景中使用,用于不同项目获取token。 否 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 IAM用户Token也就是调用“获取用户Token”接口的响应值,该接口是唯一不需要认证的接口。 使用Token方式认证时必选 注:以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ Authorization 签名认证信息。该值来源于请求签名结果。 使用AK/SK认证时必选。 - X-Sdk-Date 请求的发生时间,格式为(YYYYMMDD'T'HHMMSS'Z')。 取值为当前系统的GMT时间。 使用AK/SK认证时必选。 20150907T101459Z X-Language 请求语言。 否 en-us API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 例如,对于IAM获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP。 不同服务不同区域的Endpoint不同,您可以从地区和终端节点中查询所有服务的终端节点。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 例如,您需要获取IAM在“华北-北京一”区域的Token,则需使用“华北-北京一”区域的Endpoint(iam.cn-north-1.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也是相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),可告知服务正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID,即控制台的项目ID。 最小长度:0 最大长度:128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度:0 最大长度:8192
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID,即控制台的项目ID。 最小长度:0 最大长度:128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度:0 最大长度:8192
  • 响应示例 状态码: 200 数据源详情。 { "id" : "xxxxxxx3796649a185b012a96xxxxxxx", "name" : "xxx_gaussdbtest", "host" : "xxx.xx.x.xx", "port" : 8000, "server_list" : "xxx.xx.x.xx:xxxx", "database_name" : "gaussdb", "user_name" : "modernbi", "test_url" : "jdbc:gaussdb://xxx.xx.xx.xx:xxxx/gaussdb?socketTimeout=120&loginTimeout=5&ssl=true", "project_id" : "xxxxxxxb4dac4055888643b33xxxxxxx", "domain_id" : "xxxxxxxf3c90428fb22606b64xxxxxxx", "work_space_id" : "xxxxxxxea0764ffa850664804xxxxxxx", "extra" : "[{\"ip\": \"xxx.xx.x.xx\", \"port\": xxxx, \"channelType\": \"eip\"}]", "config" : { "ssl" : true }, "type" : "DWS", "source" : "dws", "mode" : "multi-node", "default_schema" : "public", "creation_user" : "xxxxxa863a94b0ba2887b80dxxxxx", "creation_date" : 1700114987113, "creation_user_name" : "test_name", "update_user" : "xxxxxxxa863a94b0ba2887b80dcxxxxxxx", "update_user_name" : "test_name", "update_date" : 1701071948929 }
  • 请求示例 获取协同授权列表。 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 }
  • URI GET /v1/{project_id}/authorization/cooperate-authorization/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 最小长度:0 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 auth_level 否 String 授权主体级别。 user:用户 group:用户组 最小长度:0 最大长度:128 filter_authed 否 Boolean 是否过滤已经授权的实体,默认true,仅显示授权用户和用户组信息。 预留字段。 最小长度:0 最大长度:128 resource_id 是 String 资源ID。 最小长度:0 最大长度:128 resource_type 是 String 资源类型: Datasource:数据源。 Dataset:数据集。 Dashboard:仪表板。 Screen:大屏。 Subject:智能分析助手。 最小长度:0 最大长度:128 auth_name 否 String 授权主体名称。 最小长度:0 最大长度:128 limit 否 Integer 分页大小。 最小值:1 最大值:1000 offset 否 Integer 偏移量。 最小值:0 最大值:1000 sort_dir 否 String asc: 升序, desc: 降序。 最小长度:0 最大长度:128
  • 响应参数 状态码:200 表4 响应Body参数 参数 参数类型 描述 page_data Array of objects 分页列表内容。详细参数类型请参考CooperateAuthorizationRuleVO 。 数组长度:0 -1000000 count Integer 总条数。 最小值:0 最大值:2147483647 表5 CooperateAuthorizationRuleVO 参数 参数类型 描述 auth_id String 授权主体ID。 auth_level String 授权主体级别。 user:用户 group:用户组 最小长度:0 最大长度:128 auth_name String 授权主体名称。 最小长度:0 最大长度:128 authed Boolean 是否已授权。 authority String 权限点,枚举值。 edit、export:编辑和导出权限 edit:编辑权限 export:导出权限 read:查看权限 use:使用权限 说明: 权限之间有依赖关系, 授予edit权限,自动关联授予use、read权限; 授予了export权限,自动关联授予use、read权限。 export、edit二者之前无依赖关系。 最小长度:0 最大长度:128 create_date Long 创建时间。 最小值:0 最大值:9007199254740991 create_user String 创建人ID。 最小长度:0 最大长度:128 create_user_name String 创建人姓名。 最小长度:0 最大长度:128 id String 授权记录的ID,无实际含义。 最小长度:0 最大长度:128 is_owner Boolean 是否是资源拥有者。 最小长度:0 最大长度:128 resource_id String 资源ID。 最小长度:0 最大长度:128 resource_type String 资源类型。 Datasource:数据源。 Dataset:数据集。 Dashboard:仪表板。 Screen:大屏 Subject:智能分析助手。 sort Integer 排序字段,无实际含义。 最小值:0 最大值:2147483647 update_date Long 修改时间。 最小值:0 最大值:9007199254740991 update_user String 修改人ID。 最小长度:0 最大长度:128 update_user_name String 修改人姓名。 最小长度:0 最大长度:128
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID,即控制台的项目ID。 可以通过查询工作空间获取工作空间ID。 最小长度:0 最大长度:128 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。 最小长度:0 最大长度:8192
  • URI GET /v1/{project_id}/connections 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参考获取项目ID。 最小长度:0 最大长度:128 表2 Query参数 参数 是否必选 参数类型 描述 all 否 Boolean 是否返回全部数据源列表。 limit 否 Integer 返回最大条数。 最小值:0 最大值:2147483647 缺省值:10 offset 否 Integer 偏移量。 最小值:0 最大值:2147483647 缺省值:0 name 否 String 数据源搜索值(按名称模糊匹配)。 最小长度:0 最大长度:512 type 否 String 数据源类型:MySQL、PostgreSQL、DWS、OpenGauss、 DLI 、ClickHouse、API、Doris。 枚举值: MySQL PostgreSQL DWS OpenGauss DLI ClickHouse API Doris sort_key 否 String 排序字段:支持name、creation_date、update_date。 最小长度:0 最大长度:32 sort_dir 否 String 排序类型:ASC、DESC。 最小长度:0 最大长度:64 枚举值: ASC DESC
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID,即控制台的项目ID。 最小长度:0 最大长度:128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度:0 最大长度:8192
  • 响应示例 状态码: 200 数据源列表详情。 { "count" : 100, "page_data" : [ { "id" : "xxxxxxx796649a185b012a96xxxxxxx", "name" : "test_name", "host" : "xxx.xx.x.xx", "port" : 80, "server_list" : "xxx.xx.x.xx:xxxx", "database_name" : "db_name", "user_name" : "test_name", "test_url" : "jdbc:gaussdb://xxx.xx.x.xx:xxxx/gaussdb?socketTimeout=120&loginTimeout=5&ssl=true", "project_id" : "xxxxxxxb4dac4055888643b331axxxxxxx", "domain_id" : "xxxxxxxcf3c90428fb22606b64dxxxxxxx", "work_space_id" : "xxxxxxxa5ea0764ffa850664804b9xxxxxxx", "extra" : "[{\"ip\": \"xxx.xx.x.xx\", \"port\": xxxx, \"channelType\": \"eip\"}]", "config" : { "ssl" : true }, "type" : "DWS", "source" : "dws", "mode" : "multi-node", "default_schema" : "public", "creation_user" : "xxxxxxx63a94b0ba2887b8xxxxxxx", "creation_date" : 1700114987113, "creation_user_name" : "ei_dlv_l00456193_01", "update_user" : "xxxxxxxa863a94b0ba2887b80dxxxxxxx", "update_user_name" : "name1", "update_date" : 1701071948929 } ] }
  • URI GET /v1/{project_id}/datasets/{dataset_id}/permissions 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 permission_type 是 String 权限类别: ROW:行级权限;COLUMN:列级权限。 offset 是 Integer 偏移值。分页的偏移值,0代表不偏移,也就是第一页,1代表偏移1,指的第二页。 limit 是 Integer 返回列表数量。 sort_key 否 String 排序字段 isOpen,是否开启行列权限。 sort_dir 否 String 排序类别:desc、asc。desc代表减序,asc代表升序。
  • 响应示例 { "count" : 3, "page_data" : [ { "id" : "xxxxfdff-xxxb-xxxx-8f52-e15e35axxxxx", "name" : "COLUMN", "dataset_id" : "xxxxd682-e129-xxxx-ad8e-673f02xxxxxx", "is_open" : true, "permission_type" : "COLUMN", "rule_type" : "MASK", "rule_scope" : "ALL", "project_id" : "xxxx703a500dxxxxfb3c00f9fxxxxx", "workspace_Id" : "xxxx6703a50xxxxx2fb3c00f9fxxxxxx", "rule_user" : { "users" : [ ], "user_groups" : [ ] }, "rule_content" : { "last" : 1, "first" : 1, "mask_type" : "RETAIN_FIRST_N_LAST_M", "column_ids" : [ "xxxxe9d6-6xxx-4126-bxxx-36fcxxxxce54.amount" ], "special_words" : [ "xxx" ] }, "display_fields" : { "user_map" : { }, "group_map" : { }, "field_map" : { "xxxxe9d6-xxxe-4126-bd51-36fc0ee3ce54.amount" : "amount" } } }, { "id" : "xxxxda33-dace-xxxx-8xxx-c6dfaxxxxxf1", "name" : "USER_TAG", "dataset_id" : "xxxxxd13-cxxx-4xxx-b657-829axxxxx20e", "is_open" : true, "permission_type" : "ROW", "rule_type" : "BY_TAG", "rule_scope" : "ALL", "rule_user" : { "users" : [ ], "user_groups" : [ ] }, "rule_content" : { "condition_node" : null, "logic_operator" : "AND", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "xxxx3355-xxxx-4340-9b5d-0bd856xxxxxx" ], "value_type" : "TAG_USER_GROUP", "value_names" : [ "userGroup2" ] }, "column_id" : "xxxxx722-b74c-4xxx-9630-43ca65xxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "" }, "logic_operator" : null }, { "condition_node" : { "value" : { "values" : [ "xxxxx355-4ffa-xxxx-9b5d-0bd856xxxxx" ], "value_type" : "TAG_USER_GROUP", "value_names" : [ "userGroup2" ] }, "column_id" : "xxxxx22-b74c-4752-xxx0-xxxx65d0d12c.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "" }, "logic_operator" : null } ] }, "display_fields" : null }, { "id" : " xxx14b04-ef3d-4ebc-a9ee-c651f563d67c", "name" : "测试", "dataset_id" : "xxxx4d13-c2a3-426f-b657-829addaxxxxx", "is_open" : true, "permission_type" : "ROW", "rule_type" : "BY_CONDITION", "rule_scope" : "SPECIFIED", "rule_user" : { "users" : [ "xxxxxxxed1b94534xxxxx3de304axxxx", "xxxx987b3dc4xxxx68b8dff1e7xxxxx", "774d5axxxxxb4950aabc8651308xxxxx" ], "user_groups" : [ ] }, "rule_content" : { "condition_node" : null, "logic_operator" : "AND", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "123" ], "value_type" : "CONDITION" }, "column_id" : "xxxx6722-b74c-4752-9xxx-43ca65d0d12xxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "CONTAIN" }, "logic_operator" : null }, { "condition_node" : null, "logic_operator" : "OR", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "qwe" ], "value_type" : "CONDITION" }, "column_id" : "xxxx722-b74c-4752-xxxx-43ca65dxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "CONTAIN" }, "logic_operator" : null } ] } ] }, "display_fields" : { "user_map" : { "xxxx987b3dc4xxxxxxb8dff1e73xxxx" : "auth_test", "xxxxxac55eeb4950axxxx6513080xxxx" : "chenxiantao", "xxxxx57ed1b9453xxxx943de304xxxxx" : "abac_test" }, "group_map" : { }, "field_map" : null } } ] }
共100000条