华为云用户手册

  • 查看服务列表 在统一工作台首页,选择左上角的,单击“管理中心”。 选择“授权管理”,进入授权管理页面,查看服务授权列表。 您可以在此查看服务的名称、版本、服务提供方、应用状态、用户数等信息。 选择任一服务,单击操作列下的“查看详情”,查看服务中的授权人员信息及申请授权信息。 已授权列表:查看授权成员的账号名称、工号、组织、使用状态等信息,可在页面中进行成员授权、授权续期、授权移交或取消授权。 待授权列表:查看申请信息如申请人、业务模块、授权状态、申请时间、申请理由、授权时间,可在操作列中同意授权、同意延期或驳回申请。
  • 操作步骤 您可以通过以下方式查看文档详情页: 在系统首页“我创建的对象”中,找到已创建的文档,单击文档编码查看文档详情页面。 在系统首页,通过快速搜索或高级搜索筛选文档,单击文档编码查看文档详情页。 图1 文档详情页 文档详情页包含以下内容: 主要文件:创建文档时上传的主要附件,通过浏览器下载。该区域可见上传附件格式、文件大小以及上次更新时间。 次要文件:除主要文件外,其他附件都可以添加此处。 基本信息:展示该文档的基本信息,包括编码、标题、名称、状态、所有者、状态、密级、版本等信息。 产品信息:展示所属产品线、文档类型等信息。 其他信息:展示文档所处产品阶段、功能领域、语言、所属部门、生命周期等信息。
  • 操作步骤 您可以通过以下方式查看部件详情页: 在系统首页“我创建的对象”中,找到已创建的部件,单击部件编码查看部件详情页面。 在系统首页,通过快速搜索或高级搜索筛选部件,单击部件编码查看部件详情页。 图1 部件详情页 部件详情页包含以下内容: 基本属性:部件所属产品线、部件编码、名称等部件基本信息。 创建修改信息:了解创建人与修改人相关记录。 流程状态信息:当前部件的流程状态、生命周期状态等信息。 管理属性:包含产品的小类名称、小类代码、Part类型、内外型号等产品信息。 规格属性:指产品功能,配置、款式、颜色等规格属性信息。 此外,您不仅可以通过详情页查看到部件相关联的BOM清单、关联文档、相关厂家型号、流程记录、替代关系,还可以单击详情页左侧菜单栏功能,检出、更新、检入、另存为、修订部件。
  • 前提条件 “检出”“检出并更新”可见需同时满足以下条件: 部件已检入。 部件是最新版本。 当前页面为非工作副本页面。 不在个人文件夹下。 当前用户有修改权限,或部件符合Item分层分级规则可以检出。 如果生产编码已发放或试制编码试制发放,且当前用户为“Administrators”“BOMMaintainer”或“BusinessAdministrators”群组成员时可以检出。 “检入”“保存并检入”可见需同时满足以下条件: 当前用户是检出者。 当前用户有更新权限。 当前页面不是工作副本页面。
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 messageRequestList 是 Array of MessageRequest 入参参数 表2 MessageRequest 参数 是否必选 参数类型 描述 fromSysId 否 String 来源系统id(与fromSys二选一) fromSys 否 String 来源系统名称(与fromSysId二选一) fromSysMessageId 是 String 来源系统消息标识(来源系统内唯一) fromUserAccountId 是 String 申请人账号id sendTime 是 String 申请时间(yyyy-MM-dd HH:mm:ss) messageType 是 String 消息类型: CHANGE_NOTIFICATION变更通知 SPECIAL_NOTICE特别公告 SERVICE_CASES服务案例 SERVICE_NOTIFICATION服务通知 messageSubject 否 String 消息主题 messageTemplateName 否 String 消息模板名称 messageData 否 String 消息数据(模板内容填充) messageContent 否 String 消息内容(和消息模板二选一) messageRedirectUrl 否 String 消息跳转地址 deliveryType 是 String 消息投递类型: ALL全体消息 USER指定用户消息 receiver 否 Array of String 消息接收者(MessageDeliveryType为USER时需要传user id)
  • 请求示例 [ { "fromSysId": "0", "fromSysMessageId": "basic2234567415966011", "fromUserAccountId": "1008600000015687941", "sendTime": "2023-10-17 11:03:26", "messageType": "SERVICE_NOTIFICATION", "messageSubject": "消息主题06", "messageContent": "消息内容06", "messageRedirectUrl": "http://w3.huawei.com/next/indexa.html?locale=zh#path=home", "deliveryType": "USER", "receiver": "1008600000055320663" } ]
  • 操作步骤 获取接口相关信息: URL格式:/knowledge/public/api/v1/messages 发送“https://ipdcenter.cn-north-4.huaweicloud.com/xxxxx/knowledge/public/api/v1/messages”。 其中,请求参数如下: 表1 入参 参数 是否必选 参数类型 描述 fromSysId 否 String 来源系统id(与fromSys二选一) fromSys 否 String 来源系统名称(与fromSysId二选一) fromSysMessageId 是 String 来源系统消息标识(来源系统内唯一) fromUserAccountId 是 String 申请人账号id sendTime 是 String 申请时间(yyyy-MM-dd HH:mm:ss) messageType 是 String 消息类型: CHANGE_NOTIFICATION变更通知 SPECIAL_NOTICE特别公告 SERVICE_CASES服务案例 SERVICE_NOTIFICATION服务通知 messageSubject 否 String 消息主题 messageTemplateName 否 String 消息模板名称 messageData 否 String 消息数据(模板内容填充) messageContent 否 String 消息内容(和消息模板二选一) messageRedirectUrl 否 String 消息跳转地址 deliveryType 是 String 消息投递类型: ALL全体消息 USER指定用户消息 receiver 否 Array of String 消息接收者(MessageDeliveryType为USER时需要传user id) 请求示例(JSON参数) [ { "fromSysId": "0", "fromSysMessageId": "basic2234567415966011", "fromUserAccountId": "1008600000015687941", "sendTime": "2023-10-17 11:03:26", "messageType": "SERVICE_NOTIFICATION", "messageSubject": "消息主题06", "messageContent": "消息内容06", "messageRedirectUrl": "http://w3.huawei.com/next/indexa.html?locale=zh#path=home", "deliveryType": "USER", "receiver": "1008600000055320663" } ] 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时,响应参数如下: { "errorCode": "0000", "errorMsg": "success" }
  • 终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,您可以从地区和终端节点中查询服务的终端节点。 CraftArts IPDCenter的终端节点如下表所示,请您根据业务需要选择对应区域的终端节点。 表1 CraftArts IPDCenter的终端节点 区域名称 区域 终端节点(Endpoint) 华北-北京四 cn-north-4 ipdcenter.cn-north-4.myhuaweicloud.com 父主题: 使用前必读
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data Array of TeamVO objects 团队所关联的角色和成员信息 result String 返回码 表4 TeamVO 参数 参数类型 描述 name String 团队名称 roles Array of RoleVO objects 团队角色 表5 RoleVO 参数 参数类型 描述 code String 角色编码 name String 角色名称 members Array of MembersVO objects 成员 表6 MembersVO 参数 参数类型 描述 type String 成员类型 name String 成员名称 id String 群组和用户ID w3ucn String 用户长工号
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 input 否 TeamInputVO object 输入 表2 TeamInputVO 参数 是否必选 参数类型 描述 id 否 String 团队ID name 否 String 团队名称 roles 否 Array of strings 角色编码 type 否 String 团队类型 filterInvalidAccounts 否 String 过滤无效账号
  • 操作步骤 获取接口相关信息: URL格式:/pdmpublicservice/services/openapi/team/v2/getRoleAndMembers 发送“https://pbm.ipd.huawei.com/pdmcore/pdmmvpgw/pdmcore/pdmpublicservice/services/openapi/team/v2/getRoleAndMembers”。 其中,请求参数如下: 表1 入参 序号 名称 参数位置 数据类型 1 oid Body BigInteger 2 otype Body String 在Request Header中增加“X-Auth-Token”“X-Csrf-Token”。 查看请求响应结果。 请求成功时,响应参数如下: 表2 出参 序号 属性 描述 参数位置 数据类型 示例值 备注 1 success 执行结果 Body String SUC CES S API返回的是角色名称,项目管理需要返回的值关联关系的oid和otype 2 code 响应码 Body String 200 - 3 message 错误信息 Body String - - 4 data 响应数据 Body JsonArray - - 5 oid 关联oid Body String 421357028389224450 - 6 aotype 关联a类型 Body String ty.inteplm.org.CTyGroup - 7 boid 关联boid Body String - - 8 botype 关联b类型 Body String ty.inteplm.org.CTyGroup - 9 createstamp 创建时间 Body Date 2023-04-27 13:47:47 - 10 creatoroid 创建关联的oid Body String - - 11 creatorotype 创建关联的类型 Body String - - 12 markfordelete - Body Integer - - 13 name 中文名 Body String 产品管理者/经理 - 14 aoid 关联aoid Body String - - 15 otype 关联类型 Body String ty.inteplm.org.CTyMemberLink - 16 updatecount 更新数量 Body Integer 1 - 17 updatestamp 更新时间 Body Date 2023-04-27 13:47:47 - 18 modifystamp 修改时间 Body Date 2023-04-27 13:47:47 - 19 bname 展示的树中名称 Body String PRODUCT MANAGER - 20 hasChildren 是否有子的标识 Body boolean true - 正常响应示例 { "result": "SUCCESS", "success": true, "messageBoxIcon": "INFO", "data": [ { "aoid": "421357028368252929", "aotype": "ty.inteplm.org.CTyGroup", "bname": "PRODUCT MANAGER", "boid": "421357028364058625", "botype": "ty.inteplm.org.CTyGroup", "createstamp": "2023-04-27 13:47:47", "creatorotype": "ty.inteplm.org.CTyUser", "hasChildren": true, "modifystamp": "2023-04-27 13:47:47", "name": "产品管理者/经理", "oid": "421357028389224450", "otype": "ty.inteplm.org.CTyMemberLink", "updatestamp": "2023-04-27 13:47:47" }], "time": "2023-05-30 17:57:42" }
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝在特定条件下对制定资源进行某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM 项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。
  • 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
  • 从控制台获取项目ID 从控制台获取项目ID(project_id)和名称(project name)的步骤如下: 登录管理控制台。 鼠标移动到页面右上角账号名,然后在下拉列表中单击“我的凭证”,进入“我的凭证”页面。 如果登录的是华为云官网,而非管理控制台。在单击用户名后,选择下拉列表中的“账号中心”,然后单击“管理我的凭证”进入“我的凭证”页面。 在“API凭证”页面的项目列表中查看项目ID和名称(即“项目”)。 图1 查看项目ID
  • 操作步骤 获取接口相关信息: URL格式:/plmworkpublicservice/services/openapi/common/product/queryProductLibrary 发送“https://pbm.ipd.huawei.com/pdmcore/pdmmvpgw/pdmcore/plmworkpublicservice/services/openapi/common/product/queryProductLibrary”。 其中,请求参数如下: 表1 入参 序号 名称 描述 参数位置 数据类型 是否必填 示例值 备注 1 tenantId 租户Id Body String 否 - - 2 params 业务参数 Body JsonObject 是 - - 3 name 配置文件名称 Body String 是 CAD Author - 4 description 配置文件描述 Body String 是 Provides visibility to the Project, Product, Library, and Change Tabs and CAD data management functionality. - 5 disabled 启用停用 Body int 是 0 0 - 启用 1 - 停用 6 containerId 容器ID Body String 是 3064154914584 - 7 containerType 容器类型 Body String 是 ty.inteplm.domain.CTyOrgContainer - 请求示例(JSON参数) { "params": { "name": "CAD Author", "containerId": "3021025151015", "containerType": "ty.inteplm.domain.CTyOrgContainer", "description": "Provides visibility to the Project, Product, Library, and Change Tabs and CAD data management functionality.", "disabled": 0 } } 在Request Header中增加“X-Auth-Token”“X-Csrf-Token”。 查看请求响应结果。 请求成功时,响应参数如下: 表2 出参 序号 属性 描述 参数位置 数据类型 示例值 备注 1 success 执行结果 Body String SUCCESS - 2 code 响应码 Body String 200 - 3 message 错误信息 Body String - - 4 data 响应数据 Body String 3064154914584 配置文件的主键 正常响应示例 { "success": "SUCCESS", "code": "200", "data": "3064154914584" }
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 orderID 否 String 批次号,跟踪日志使用 clientID 否 String 接口调用方系统简称 userID 否 String 用户账号 curPage 否 String 当前查询页码,默认为1 pageSize 否 String 每页记录数,最大100 sessionID 否 String 第一次为0 input 否 PartInput object 输入 表2 PartInput 参数 是否必选 参数类型 描述 partVersionID 否 String 部件版本oid number 否 String 部件编码 name 否 String 部件中文名称(master级属性) descriptionCn 否 String 部件中文描述(verison级属性) description 否 String 部件英文名称(verison级属性) version 否 String 部件小版本(A.4)||部件最新版本(Latest) workflowState 否 String 流程状态 creator 否 String 创建者 source 否 String 来源 createBeginDate 否 String 创建开始时间 createEndDate 否 String 创建结束时间 updateBeginDate 否 String 更新开始时间 updateEndDate 否 String 更新结束时间 productID 否 String PBI产品ID organization 否 String 华为组织 template 否 String 模板 partView 否 String 视图 categoryCode 否 String 小类代码 partStatus 否 String 部件状态 restrictedStatus 否 String 受限状态 itemRevision 否 String 物件版本 ranking 否 String 集团级优先等级 drawingVersion 否 String 图纸版本 isReturnPartAtts 否 String 是否返回IBA属性 isReturnRefAtts 否 String 是否返回状态属性 isReturnMasterAtts 否 String 是否返回master级属性 isReturnTwoDimensionalAtts 否 String 是否返回二维表属性
  • 操作步骤 获取接口相关信息: URL格式:/rest/v1/commonTeam/checkUserInManageGroup 发送“https://pbm.ipd.huawei.com/pdmcore/pdmmvpgw/pdmcore/pdmpublicservice/services/openapi/team//rest/v1/commonTeam/checkUserInManageGroup”。 其中,请求参数如下: 表1 入参 序号 名称 描述 参数位置 数据类型 1 entity 实体 Body JsonObject 2 oid 对象ID Body BigInteger 3 otype 对象类型 Body String 4 principal 参与者 Body JsonObject 5 oid 参与者ID Body BigInteger 6 otype 参与者类型 Body String 7 disabled 是否停用 Body Long 请求示例(JSON参数) { "entity": { "oid": "426088622400225280", "otype": "ty.inteplm.product.CTyPDMLinkProduct" }, "principal": { "oid": "416665563431993344", "otype": "ty.inteplm.org.CTyUser", "disabled": 0 } } 在Request Header中增加“X-Auth-Token”“X-Csrf-Token”。 查看请求响应结果。 请求成功时,响应参数如下: 表2 出参 序号 属性 描述 参数位置 数据类型 示例值 1 success 执行结果 Body String SUCCESS 2 code 响应码 Body String 200 3 message 错误信息 Body String - 4 data 响应数据 Body boolean - 正常响应示例 { "result": "SUCCESS", "success": true, "messageBoxIcon": "INFO", "data": false, "time": "2023-06-08 11:11:17" }
  • 基本概念 账号 用户注册华为云时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域(Region) 指云资源所在的物理位置,同一区域内可用区间内网互通,不同区域间内网不互通。通过在不同地区创建云资源,可以将应用程序设计的更接近特定客户的要求,或满足不同地区的法律或其他要求。 可用区(AZ,Availability Zone) 可用区是同一服务区内,电力和网络互相独立的地理区域,一般是一个独立的物理机房,这样可以保证可用区的独立性。一个区域内有多个可用区,一个可用区发生故障后不会影响同一区域内下的其它可用区。可用区间通过内网访问。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中购买资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中资源,使得资源的权限控制更加精确。同样在我的凭证下,您可以查看项目ID。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理服务用户指南》。 父主题: 使用前必读
  • 请求消息体(可选) 请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxx为project的名称,如“cn-north-4”,您可以从地区和终端节点中获取。 scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户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。 否 3495 X-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头(Headers)中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权“AK/SK认证”。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 POST https://iam.cn-north-4.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-4.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP请求方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 input 是 Array of GetPermissionVo objects 入参body类型 isIgnore 是 Boolean 是否忽略无效用户 表2 GetPermissionVo 参数 是否必选 参数类型 描述 type 否 String 对象类型 number 否 String 数据对象编码 version 否 String 大版本 iteration 否 String 小版本 view 否 String 部件视图 userID 否 String 用户账号 groupName 否 String 群组名称 access 否 Array of strings 移除权限类型 accessOwner 否 String 合成权限类型+流程任务ID信息
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内,12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中“auth.scope”的取值需要选择“project”,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": "********", //IAM用户密码 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 GET https://iam.cn-north-4.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以: 通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333。 参考华为云IAM认证服务了解如何获取IAM用户token。
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 orderID 否 String 批次号,调用系统跟踪日志使用,唯一即可 clientID 否 String 接口调用方系统简称 userID 否 String 用户ID,用户账号 input 否 SearchDocNameReqVO object 查询文档名称请求入参 表2 SearchDocNameReqVO 参数 是否必选 参数类型 描述 name 是 String 文档名称
  • 操作步骤 获取接口相关信息: URL格式:/pdmpublicservice/services/external/mda/v2/folder/create 发送“https://pbm.ipd.huawei.com/pdmcore/pdmmvpgw/pdmcore/pdmpublicservice/services/external/mda/v2/folder/create”。 其中,请求参数如下: 表1 入参 序号 名称 描述 参数位置 数据类型 备注 1 parentOid 父对象oid Body String folderId 2 parentOtype 父对象otype Body String - 3 name 名称 Body String - 4 domainOid domain oid Body String domainId 5 domainOtype domain otype Body String - 6 isInheritedParent 是否继承父域1为是,0为否,继承父域时domainId无效 Body String - 7 description 文件夹描述 创建文件夹接口添加 Body String folderDescription 8 otype 对象otype Body String - 在Request Header中增加“X-Auth-Token”“X-Csrf-Token”。 查看请求响应结果。 请求成功时,响应参数如下: { "result": "SUCCESS", "success": true, "messageBoxIcon": "INFO", "data": { "isLeaf": true, "oid": "433359818011541504", "cabinetoid": "411211136990461952", "cabinetotype": "ty.inteplm.folder.CTyCabinet", "parentnodeoid": "0", "parentnodeotype": "ty.inteplm.folder.CTySubFolder", "description": "test", "nodeindex": 0, "createstamp": "2023-05-30 16:42:35", "updatestamp": "2023-05-30 16:42:35", "updatecount": "0", "markfordelete": "0", "otype": "ty.inteplm.folder.CTySubFolder", "modifystamp": "2023-05-30 16:42:35", "containeroid": "-1", "containerotype": "ty.inteplm.library.CTyLibrary", "domainotype": "ty.inteplm.domain.CTyDomain", "creatoroid": "419211831442194432", "creatorotype": "ty.inteplm.org.CTyUser", "name": "test(0)", "owneroid": "419211831442194432", "ownerotype": "ty.inteplm.org.CTyUser", "updatoroid": "419211831442194432", "updatorotype": "ty.inteplm.org.CTyUser" }, "time": "2023-05-30 16:42:35" }
  • 创建组织 登录CraftArts IPDCenter控制台。 在左侧菜单栏选择“服务管理”,进入“服务管理”页面。 单击“创建组织”,输入组织名称,单击“下一步”。 组织名称由1-60个中文、英文、数字及合法字符组成。 图1 创建组织 在“设置组织的域名”页面,设置组织的域名。 没有域名,输入域名,单击“下一步”。 已有域名,单击“使用自有域名”,输入自有域名,如example.com,单击“下一步”。 图2 设置域名 阅读“管理式华为账号”相关声明,单击“同意”创建组织。
  • 支持审计的关键操作列表 表1 云审计 服务支持的CraftArts IPDCenter服务操作列表 操作名称 资源类型 事件名称 资源查询 ipdcOperation resourceinstances 修改当前region租户配额信息 ipdcQuota modifyTenantQuotas 开通云服务回调前校验 ipdcOperation subscribeCallbackVerify 环境绑定orgID ipdcOperation registerApp 订单变更 cbcResource orderChange 资源查询(租户使用) ipdcOperation resourceInstances 资源查询(租户使用) ipdcOperation tenantResourceInstances 更新云服务metadata信息 ipdcOperation updateMetadata 订购 ipdcOperation subscribeRuntime 开通服务回调 ipdcOperation cbcCallbackSubscribe 变更服务回调 ipdcEnvironment cbcCallbackChange 云服务加锁 ipdcOperation lock 云服务解锁 ipdcOperation unlock 更新云服务实例状态 ipdcEnvironment updateInstancesStatus 创建资源标签 ipdcEnvironment resourceTagBatchCreate 删除资源标签 ipdcEnvironment resourceTagBatchDelete
  • 开通CraftArts IPDCenter CraftArts IPDCenter服务需完成购买才能开通,请参见购买服务。 开通服务后,管理员需创建组织并绑定,才可为用户添加权限,请参见创建组织并绑定。 创建组织后,管理员可为组织添加成员,为其分配用户权限,请参见添加成员。若管理员需要用户权限,请确保自己在组织内。 完成组织内的成员添加后,被添加到组织的成员即可访问CraftArts IPDCenter,请参见访问CraftArts IPDCenter。
共100000条