华为云用户手册

URI DELETE /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 workspace_id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 project_id 是 String 项目ID。获取方法请参见获取项目ID。

URI GET /v1/{project_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 偏移值。分页的偏移值，0代表不偏移，也就是第一页，1代表偏移1，指的第二页。 limit 是 Integer 返回列表数量。 sort_key 否 String 排序字段isOpen，是否开启行列权限。 sort_dir 否 String 排序类别：desc、asc。desc代表减序，asc代表升序。

响应参数 表4 响应Body参数 参数 参数类型 描述 instances Array of objects 实例信息。具体请参考表5。 count Integer 数据数量。 page_data Array of objects 当前页的数据。 表5 instances 参数 参数类型 描述 project_id String 项目ID。 region_id String RegionId。 order_id String 订单ID。 instance_id String 产品实例ID。 instance_name String 产品实例名称。 resource_spec_code String 产品规格。 order_type String 订单类型： ON_DEMAND：按需。 PERIOD：包周期。 status Integer 实例状态，有以下几种状态。 1：未生效； 2：生效中； 3：已删除=退订； 4：保留期=冻结； 5：宽限期。 domain_id String 账号ID。 eps_id String 所属企业项目ID。

响应示例 获取已开通实例列表成功 。 { "count": 1, "page_data": [ { "project_id": "9c3043ab4xxxx055888643b331a0xxxx", "region_id": "xxx", "order_id": "4xxxxd9517314ebbbe17258a9640xxxx", "instance_id": "4e7xxxx517314exxxx17258a9640c05f", "instance_name": "xxxx-4e7a0d9517314exxxx17258a9640c05f", "instance_spec_code": "DataArtsInsight.unit.enterprise.user", "order_type": "ON_DEMAND", "status": 2, "create_user": "***", "create_date": 169xxxx2604761, "domain_id": "d22f8acfxxxx428fb22606b64dc7xxxx", "eps_id": "0" } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 user_id 是 String userId value 否 Array of strings value value_type 否 String 默认标签值类型，默认为NULL。 DEFAULT：默认值，采用默认标签值； NULL：为空； ALL：所有值； ENUM：枚举值，default_value必须有枚举值配置。

响应示例 状态码： 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 } ]}

响应示例 状态码： 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}

响应示例 状态码：200 获取数据集详情成功。 { "create_date" : 1705458279173, "create_user" : "cfcxxxx4501811aedcxxxxbbfe8", "create_user_name" : "xxxxxxx", "update_date" : 1705458279173, "update_user" : "cfcc77xxxx364501811aedcxxxxbbfe8", "update_user_name" : "xxxxxxx", "project_id" : "34ba64e53axxxb68cd7xxxxa8cc17bd", "workspace_id" : "d39157xxxx5f43c2bdxxxx74792b2d5e", "id" : "b745d57b-xxxx-4f2a-xxxx-3c0ff5fcf92f", "caption" : "api测试数据集10", "version" : "2.0", "ds_id" : "2eaa208dxxxxxxx9496914134fae2d4", "ds_type" : "DWS", "domain_id" : "10ae45e7xxxxxxbe954a211426d003", "physical_schema" : { "tables" : [ { "id" : "a25173cb-xxxx-42ec-xxxxx-67483f6cdaab", "database_name" : "modernbi_demo", "schema_name" : "autotest", "table_name" : "order_info", "table_type" : "table", "sql_text" : "", "is_fact_table" : false }, { "id" : "b745d57b-xxxx-4f2a-xxxx-3c0ff5fcf92f", "database_name" : "modernbi_demo", "schema_name" : "autotest", "table_name" : "sql_order_info", "table_type" : "sql", "sql_text" : "select * from autotest.order_info", "is_fact_table" : true } ] }, "logical_schema" : { "field_schema" : { "measures" : [ { "id" : "2d83ad17-32bb-xxxx-9c55-xxxxxxx", "caption" : "cs_bill_customer_sk", "is_expansion" : 0, "expansion_type" : 0, "column_formula" : "cs_xxxxx_customer_sk", "origin_column_name" : "cs_xxxx_customer_sk", "origin_column_type" : "int8", "data_type" : "NUMBER", "origin_data_type" : "NUMBER", "cube_id" : "2d83ad17-xxxxxxxxx-9c55-2a47415bdaf6" } ], "dimensions" : [ { "id" : "a25173cb-e229-xxxxxxx-67483f6cdaab.id", "caption" : "id1", "dimension_type" : "StandardDimension", "hierarchies" : [ { "caption" : "id1", "levels" : [ { "id" : "a25173cb-xxxxxxxxc-a4b4-67483f6cdaab.id", "caption" : "id1", "data_type" : "STRING", "origin_data_type" : "STRING", "origin_column_name" : "id", "origin_column_type" : "varchar(255)", "column_formula" : "id", "level_type" : null, "is_expansion" : 0, "expansion_type" : 0 } ] } ], "cube_id" : "a25173cb-xxxxxxxc-a4b4-67483f6cdaab" } ] }, "variables" : null, "relations" : [ { "source" : "b745d57b-axxxxx8ee4-3c0ff5fcf92f", "target" : "a25173cb-xxxxxx-a4b4-67483f6cdaab", "join_type" : "left join", "relation" : "many-to-one", "joins" : [ { "source_key" : "product_id", "source_type" : "dimension", "target_key" : "product_id", "target_type" : "dimension", "condition" : "equal-to" } ] } ] } }

请求消息头 附加请求消息头字段，如指定的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/tokensContent-Type: application/json

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中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 91011121314151617181920212223242526 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-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 请求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

响应示例 { "count" : 17, "page_data" : [ { "configs" : { "mode": "0", "worksAuthorized": "0", "worksPublic": "1", "onlyAdminCreateDatasource": "0", "isPin": "1", "fieldShowType": "0", "worksView": "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" } ]}

URI GET /v1/{project_id}/instances/{instance_id}/workspaces 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 工作空间名称。支持模糊查询。 取值范围：[0,100] offset 否 Integer 返回条目的起始offset。 取值范围：[0,2147483647] 默认值：0 limit 否 Integer 返回条目数。不传该参数时，默认查询前10条信息。 取值范围：[0,2147483647] 默认值：10

Token认证 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } }} 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 123 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projectsContent-Type: application/jsonX-Auth-Token: ABCDEFJ....

AK/SK认证 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK/SK签名认证方式仅支持消息体大小为12M以内的请求，12M以上的请求请使用Token认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的私有访问密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。 详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 col_permission_config 否 object 列级权限配置。具体请参考表4。 row_permission_config 否 object 行级权限配置。具体请参考表5。 表4 ColPermissionConfig 参数 是否必选 参数类型 描述 is_open 否 Boolean 是否开启列权限。 表5 RowPermissionConfig 参数 是否必选 参数类型 描述 is_open 否 Boolean 是否开启行权限。 is_open_by_condition 否 Boolean 是否开启条件组合授权。 is_open_by_tag 否 Boolean 行列权限额外配置，是否开启行级条件组合授权。 others_has_permission_by_condition 否 Boolean 其他用户（未在行级条件组合授权中指定）的权限。

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 1 2 3 4 5 6 7 8 9101112 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01",...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 12345678 {"error":{"code":401,"message": "The username or password is wrong.","title": "Unauthorized"}} 其中，code表示错误码，message表示错误描述信息。

响应示例 导入任务详情。 { "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}

响应示例 { "row_permission_config" : { "is_open" : true, "is_open_by_condition" : true, "others_has_permission_by_condition" : false, "is_open_by_tag" : true }, "col_permission_config" : { "is_open" : true }}

响应参数 表3 响应Body参数 参数 参数类型 描述 row_permission_config object 行级权限配置。具体请参考表4。 col_permission_config object 列级权限配置。具体请参考表5。 表4 row_permission_config 参数 参数类型 描述 is_open Boolean 是否开启行权限。 is_open_by_condition Boolean 是否开启条件组合授权。 others_has_permission_by_condition Boolean 其他用户（未在行级条件组合授权中指定）的权限。 is_open_by_tag Boolean 行列权限额外配置，如是否开启行级条件组合授权。 表5 col_permission_config 参数 参数类型 描述 is_open Boolean 是否开启列权限。

响应示例 状态码： 200 大屏组件列表。 { "id" : "b7401134-xxxx-4973-xxxx-2b6c1ac3f2f1", "name" : "test_screen", "pages" : [ { "id" : "ae613423-xxxx-475d-xxxx-be6fc28c3d30", "name" : null, "nodes" : [ { "id" : "d1e4b677-xxxx-475d-xxxx-dbd9a4bf2f20", "name" : "单选下拉1", "type" : "select", "hidden" : false, "target_nodes" : [ { "id" : "9f7ff361-xxxx-475d-xxxx-57dd19bda14e", "field_id" : "cca5cb5e-xxxx-475d-xxxx-8a4f90447ae0.field" } ] } ] } ]}

终端节点 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。 智能数据洞察的终端节点如下表所示，请您根据业务需要选择对应区域的终端节点。 表1 终端节点 区域名称 区域 终端节点（Endpoint） 华北-北京四 cn-north-4 dataartsinsight.cn-north-4.myhuaweicloud.com 华北-乌兰察布一 cn-north-9 dataartsinsight.cn-north-9.myhuaweicloud.com 华东-上海一 cn-east-3 dataartsinsight.cn-east-3.myhuaweicloud.com 华南-广州 cn-south-1 dataartsinsight.cn-south-1.myhuaweicloud.com 西南-贵阳一 cn-southwest-2 dataartsinsight.cn-southwest-2.myhuaweicloud.com

响应示例 状态码： 200 查询智能分析助手列表成功。 { "count" : 1, "page_data" : [ { "name" : "xxxxxxxxx", "subject_id" : "xxxxxxxxxxxxx", "comments" : "", "status" : 3, "permission_list" : [ "edit", "use" ], "workspace_id" : "xx4xxaxxxxac8x51xxx30", "project_id" : "xxb4dxx4xxx886xx33xx27", "create_user" : "xxxb4xxx4b0baxxxxx0dc18xxx3", "create_user_name" : "xxv_l00xxxx", "create_date" : 1702046652513, "update_user" : "xxxxxxx4b0xxxb8xxxx27x", "update_user_name" : "xxv_l00xxxx", "update_date" : 1710496061316, "datasets" : [ { "dataset_id" : "xxxxxxxxxxxxx", "name" : "xxxxxxxxxx" } ], "recommended_questions" : "xxxxxxxxxxxxx" } ]}

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。 响应示例如下，例如DataArts Insight服务部署的区域为“cn-north-4”，应消息体中查找“name”为“cn-north-4”，其中projects下的“id”即为项目ID。

URI DELETE /v1/{project_id}/datasets/{dataset_id}/permissions/{permission_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 dataset_id 是 String 数据集ID。 permission_id 是 String permission_id。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192

请求示例 POST https://{endpoint}/v1/{project_id}/datasets/{dataset_id}/permissions{ " dataset_permissions " : [ { "id" : "xxxxfdff-xxxx-43cb-8f52-e15e35axxxxx", "name" : "COLUMN", "dataset_id" : "1e27d682-xxxx-4589-ad8e-673f02d395f4", "is_open" : true, "permission_type" : "COLUMN", "rule_type" : "MASK", "rule_scope" : "ALL", "project_id" : "xxxx6703a500xxxx2fb3c00f9fxxxxxx", "workspace_Id" : "xxxx6703a50xxxxx2fb3c00f9fxxxxxx", "rule_user" : { "users" : [ ], "user_groups" : [ ] }, "rule_content" : { "last" : 1, "first" : 1, "mask_type" : "RETAIN_FIRST_N_LAST_M", "column_ids" : [ "xxxxx9d6-6dae-xxxx-bd51-36fc0exxxxxx.amount" ], "special_words" : [ "xxx" ] }, "display_fields" : { "user_map" : { }, "group_map" : { }, "field_map" : { "xxxxx9d6-6dae-4126-xxxx-36fc0exxxxxx.amount" : "amount" } } }, { "id" : "xxxxxa33-dace-xxxx-8ddf-c6dfa48xxxxx", "name" : "USER_TAG", "dataset_id" : "xxxx4d13-c2a3-xxxx-b657-829addaxxxxx", "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-4ffa-xxxx-9b5d-0bd85668xxxx" ], "value_type" : "TAG_USER_GROUP", "value_names" : [ "userGroup2" ] }, "column_id" : "xxxx6722-b74c-xxxx-9630-43ca65xxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "" }, "logic_operator" : null }, { "condition_node" : { "value" : { "values" : [ "xxxxx355-4ffa-4340-9b5d-0bd856xxxxx" ], "value_type" : "TAG_USER_GROUP", "value_names" : [ "userGroup2" ] }, "column_id" : "xxxxx722-b74c-4752-xxxx-43ca65dxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "" }, "logic_operator" : null } ] }, "display_fields" : null }, { "id" : "xxxxxb04-ef3d-4ebc-a9ee-c651f5xxxxxx", "name" : "测试", "dataset_id" : "xxxxxd13-c2a3-426f-xxxx-xxxxxdaba20e", "is_open" : true, "permission_type" : "ROW", "rule_type" : "BY_CONDITION", "rule_scope" : "SPECIFIED", "rule_user" : { "users" : [ "xxxxx57ed1b9453xxxxx43de304xxxxx", "xxxxx987b3dcxxxxb68b8dff1e7xxxxx", "xxxxxac55eeb4950aabc86513080f9ba" ], "user_groups" : [ ] }, "rule_content" : { "condition_node" : null, "logic_operator" : "AND", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "123" ], "value_type" : "CONDITION" }, "column_id" : "xxxx6722-b74c-xxxx-9630-43ca65dxxxxx.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" : "xxxxx722-b74c-xxxx-9630-43ca65dxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "CONTAIN" }, "logic_operator" : null } ] } ] }, "display_fields" : { "user_map" : { "xxxxx987b3dc4xxxx68b8dff1exxxxxx" : "auth_test", "xxxxxac55eeb4xxxxabc865130xxxxxx" : "chenxiantao", "xxxxx57ed1b94xxxx6c943de30xxxxxx" : "abac_test" }, "group_map" : { }, "field_map" : null } } ]}

请求参数 表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。 Content-Type 是 String 固定值，指定请求体类型和字符集。 表3 请求Body参数 参数 是否必选 参数类型 描述 service_type 是 String 服务类型。 obs_endpoint 是 String OBS终端节点。 obs_bucket_name 是 String OBS桶名。 max_storage_days 是 Integer 导出文件在OBS的最大存储时间。 obs_path_prefix 是 String OBS前缀路径。