云服务器内容精选

  • 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,Dataset,Dashboard,Screen,Subject。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID,即控制台的项目ID。 可以通过查询工作空间获取工作空间ID。 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。
  • 响应示例 { "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" }
  • 响应示例 状态码: 200 OK。 { "auth_switch_config" : "{"read": true, "edit": true, "export": true}", "create_date" : 1688022840899, "create_user" : "de9cb4xxxxa94b0ba2887b80xxxxxxxx", "create_user_name" : "***_01", "id" : "78215911-xxxx-478b-xxxx-9cb7f0407598", "owner" : "dxxxxa863a94xxxa2887b80xxxxxxxx", "project_id" : "xxx3ab4dac40558886xxxxx1a0b227", "resource_id" : "d0xxx19c-4e87-46xx-bxx2-da82bfxxxx4e", "resource_type" : "dashboard", "update_date" : 1688023886860, "update_user" : "de9cb4a863a94b0ba2887b80xxxxxxxx", "update_user_name" : "ei_dlv_***_01", "workspace_id" : "6xxxx96809adxxxxxa09e6bxxxx2146" }
  • 请求示例 保存或修改资源分享协作属性值。 POST https://{endpoint}/v1/xxxxx3ab4dac4055888643b331xxxxx/authorization/cooperate-authorization/properties { "auth_switch_config" : "{"read": true, "edit": true, "export": true}", "resource_id" : "d0d7919c-xxxx-462e-xxxx-da82bf8be44e", "resource_type" : "dashboard" }
  • 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中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。
  • 请求方法 HTTP请求方法(也称为操作或动词),可告知服务正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • 请求消息头 附加请求消息头字段,如指定的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在同一个区域也是相同,所以简洁起见将这两部分省略。
  • 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。 响应示例如下,例如DataArts Insight服务部署的区域为“cn-north-4”,应消息体中查找“name”为“cn-north-4”,其中projects下的“id”即为项目ID。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID,即控制台的项目ID。 可以通过查询工作空间获取工作空间ID。 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 BatchSaveAuthRequestBody 是 Array of objects authorizedList,详细参数类型参考CooperateAuthorizationRuleDto。 表4 CooperateAuthorizationRuleDto 参数 是否必选 参数类型 描述 auth_id 否 String 授权主体的用户或用户组ID。 auth_level 否 String 授权主体级别。 user:用户 group:用户组 authority 否 String 权限点开关,即协同授权配置项。取值为true或者false,用于区分对应开关是否打开。默认值为false。 edit:编辑权限 export:导出权限 read:查看权限 use:使用权限 说明: 权限之间有依赖关系,授予edit权限,自动关联授予read和export或者use权限;授予了export权限,自动关联授予read权限。 对仪表板和大屏来说,权限点有三个, edit,export,read。 例如{"edit":false,"read": true,"export": true}, 表示打开了查看和导出的权限。 对于数据源、数据集、智能分析助手来说,权限点有两个,edit,use,对应编辑和使用权限。 例如{"use":true,"edit": false} ,表示仅打开使用权限。 resource_id 否 String 资源ID。 resource_type 否 String 资源类型: Datasource:数据源 Dataset:数据集 Dashboard:仪表板 Screen:大屏 Subject:智能分析助手 表5 请求体参数 参数 是否必选 参数类型 描述 auth_level 否 String 授权主体级别。 user:用户 group:用户组 filter_authed 否 Boolean 是否过滤已经授权的实体,默认true,仅显示授权用户和用户组信息。 预留字段。 resource_id 否 String 资源ID。 resource_type 否 String 资源类型: Datasource:数据源 Dataset:数据集 Dashboard:仪表板 Screen:大屏 Subject:问答领域
  • 请求示例 批量保存、修改、删除项目ID为xxxx3ab4dac4055888643b331axxxxx的协同授权。 /v1/xxxx3ab4dac4055888643b331axxxx/authorization/cooperate-authorization/rules/batch-save [ { "auth_id" : "de9cb4a863a94b0ba2887b80xxxxxxxx", "auth_level" : "user", "authority" : "edit", "resource_id" : "d0d7919c-xxxx-bb32-da82bf8be44e", "resource_type" : "dashboard" } ]
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝对指定资源在特定条件下进行某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。 关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 “√”表示支持,“x”表示暂不支持。 DataArts Insight支持自定义策略授权项如下表所示。 表1 API授权项列表 权限 对应API接口 授权项 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 保存或修改资源属性值。 POST /v1/{project_id}/authorization/cooperate-authorization/properties dataartsinsight:resource:auth - √ × 获取资源属性值 GET /v1/{project_id}/authorization/cooperate-authorization/properties dataartsinsight:resource:auth - √ × 获取协同授权规则列表 GET /v1/{project_id}/authorization/cooperate-authorization/rules dataartsinsight:resource:auth - √ × 批量保存、修改、删除指定自研的协同授权规则。 POST /v1/{project_id}/authorization/cooperate-authorization/rules/batch-save dataartsinsight:resource:auth - √ × 创建工作空间 POST /v1/{project_id}/instances/{instance_id}/workspaces dataartsinsight:workspace:create - √ × 删除工作空间 DELETE /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} dataartsinsight:workspace:delete - √ × 修改工作空间。 PUT /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} dataartsinsight:workspace:update - √ ×
  • 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不同,使用时请注意。
  • 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....”加到请求消息头即可,如下所示。 1 2 3 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....