华为云用户手册

  • 请求示例 修改主页 https://koomessage.myhuaweicloud.com/v1/aim-sa/portals/bcce7e60df6445a592c09ca95dfdcccc{ "change_reason" : "我想修改主页", "background_img" : "1d191b06da9a485895e10e48cbc5cccc", "summary" : "测试-欢迎来到酷玩影视", "tels" : [ { "tel" : "131****0000", "usage" : "加入我们" }, { "tel" : "131****0001", "usage" : "联系我们" } ], "fastapps" : [ { "name" : "酷玩", "description" : "这是一个快应用的描述", "deeplink" : "hap://app/122", "depend_engine_version" : "1", "logo_img" : "d2fe995119584f88be9e9ef53d2ccccc" } ]}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 change_reason 是 String 修改原因。 最小长度:5 最大长度:50 background_img 是 String 主页背景图片资源ID。 分辨率大于等于1440*810,支持jpg、jpeg、bmp、png。参数值为上传智能信息服务号图片资源API返回的resource_id。 最小长度:32 最大长度:32 summary 是 String 简介。 最小长度:1 最大长度:75 tels 否 Array of TelModel objects 热线号列表。 fastapps 否 Array of UpdatePortalFastappModel objects 快应用列表。 hw_pubs 否 Array of strings 华为服务号列表。 说明: 预留,暂未使用。 表4 TelModel 参数 是否必选 参数类型 描述 tel 是 String 电话号码(只能包含数字和“-”,且开头和结尾必须为数字)。 最小长度:1 最大长度:20 usage 是 String 号码用途。 说明: 号码用途长度范围为1-30个字符,中文占2个字符,英文占1个字符。 表5 UpdatePortalFastappModel 参数 是否必选 参数类型 描述 name 否 String 快应用名。 说明: 长度范围为1-30个字符,中文占2个字符,英文占1个字符。 logo_img 否 String 快应用 LOG O图片资源ID。 说明: 图片格式为jpg、bmp、jpeg,分辨率大于等于192*192,比例+-0.15,大小不超过5M。参数值为上传智能信息服务号图片资源API返回的resource_id。 最小长度:32 最大长度:32 description 否 String 快应用描述。 说明: 长度范围为1-38个字符,中文占2个字符,英文占1个字符。 deeplink 否 String 快应用跳转链接。 最小长度:1 最大长度:1000 depend_engine_version 否 String 快应用依赖引擎版本。 说明: 长度范围为1-50个字符,中文占2个字符,英文占1个字符。
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 data UpdatePortalRsp object 修改主页信息响应体。 表7 UpdatePortalRsp 参数 参数类型 描述 portal PortalModel object 主页信息。 表8 PortalModel 参数 参数类型 描述 portal_id String 主页ID。 company_id String 企业ID。 company_name String 企业名称。 pub_id String 服务号ID。 pub_name String 服务号名称。 background_img String 主页背景图片资源ID。 background_img_url String 背景图片URL。 summary String 简介。 tels String 热线号列表。 说明: 以JSON列表返回,格式: {"tel": "400-800-8800", "usage": "官方服务电话"}。 fastapps String 快应用列表。 说明: 以JSON列表返回,格式: {"name": "快应用名称","logo_img": "快应用LOGO图片资源ID", "logo_img_url": "快应用LOGO图片资源URL", "description": "快应用描述","deeplink": "hap://app/fastapp","depend_engine_version": "1040"}。 state Integer 主页状态。 1:未生效 2:已生效 3:已失效 4:服务号已冻结 approve_state Integer 审核状态。 1:待审核 2:通过 3:驳回 online_time String 上线时间。 creator String 创建人。 create_time String 创建时间。 change_reason String 修改原因。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。
  • 响应示例 状态码: 200 返回信息。 { "data" : { "portal" : { "portal_id" : "bcce7e60df6445a592c09ca95dfdcccc", "state" : 1, "approve_state" : 1, "company_id" : "cf2d298c555e44bf9fafdf5ada0ccccc", "company_name" : "南派餐饮", "creator" : "7139bc07d53240dca88722930485cccc", "create_time" : "2022-08-08T01:49:29Z", "change_reason" : "我想修改主页", "pub_id" : "961b0f7d32314b5cb287fc06fe09cccc", "pub_name" : "服务号名称", "background_img" : "1d191b06da9a485895e10e48cbc5cccc", "background_img_url" : "AimSauploadService/ad63cdaa3a044a589bbde7f6a4551111.png", "summary" : "测试-欢迎来到酷玩影视", "tels" : "[{\"usage\":\"加入我们\",\"tel\":\"131****0000\"},{\"usage\":\"联系我们\",\"tel\":\"131****0001\"}]", "fastapps" : "[{\"name\":\"酷玩\",\"logo_img\":\"d2fe995119584f88be9e9ef53d2ccccc\",\"logo_img_url\":\"AimSauploadService/ccccd328eba84b27ab215122aada398ftest22_192x192 (1).jpg\",\"description\":\"这是一个快应用的描述\",\"deeplink\":\"hap://app/122\",\"depend_engine_version\":\"1\"}]", "approve_time" : null, "online_time" : null } }}
  • 请求示例 上行消息回执 https://koomessage.myhuaweicloud.cnvms/reply-callback{ "seq_id" : "0a96a1ac07a34e80b0e70569595e2c03", "result" : [ { "task_id" : "0cad5a1c-f018-45a1-96ae-782804417e74", "mobile" : "131****0000", "rtime" : "2022-11-06 20:38:33", "content" : "Hello+everyone" }, { "task_id" : "0cad5a1c-f018-45a1-96ae-782804417e74", "mobile" : "131****0001", "rtime" : "2022-11-06 20:38:33", "content" : "It%2Cs+late" } ]}
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 seq_id 否 String 本次推送请求唯一标识。 result 否 Array of MsgReply objects 上行消息回执列表。 表3 MsgReply 参数 是否必选 参数类型 描述 task_id 否 String 智能信息基础版发送任务ID。 mobile 否 String 手机号,11位纯数字手机号码。样例:131****0000。 content 否 String 回复内容。 rtime 否 String 上行消息返回时间。格式:YYYY-MM-DD HH:MM:SS。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 tplid String 智能信息基础版模板ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。
  • 请求示例 新建模板 https://koomessage.myhuaweicloud.cn/v1/aim-basic/templates{ "tpl_name" : "测试-路由器推广", "title" : "测试主题", "reslist" : [ { "type" : "txt", "name" : "广告文本", "source" : "txt", "content" : "【华为云】测试-尊敬的#p_1#你好,最新路由器出来啦" }, { "type" : "jpg", "name" : "one.jpg", "source" : "file", "content" : "iVBORw0KGgoAAAANSUhEUgAAAKoAAABOCAYAAACwo40WAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAEXRFWHRTb2Z0d2Fy..." }, { "type" : "jpg", "name" : "two.jpg", "source" : "file", "content" : "iVBORw0KGgoAAAANSUhEUgAAAKoAAABOCAYAAACwo40WAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAEXRFWHRTb2Z0d2FyZQBTbmlwYXN0ZV0Xzt0AACAASURB..." }, { "type" : "png", "name" : "three.png", "source" : "url", "content" : "https://dss0.bdstatic.com/5aV1bjqh_Q23odCf/static/superman/img/topnav/tupian@2x-482fc011fc.png" } ], "remarks" : "请将此模板类型设置为绑定通道类型是三网合一通道", "expiration_time" : 1}
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型 描述 expiration_time 是 String 智能信息基础版模板有效期。单位:天,必须取整,最长9999天。 tpl_name 是 String 智能信息基础版模板名称。模板的别名,用来帮助记忆。最大不超过100个字,若使用中文需经过UTF-8编码。 title 是 String 智能信息基础版模板主题,最大不超过20个字,若使用中文需经过UTF-8 编码,主题不能包含“【】”,否则审核会不通过。 reslist 是 Array of ResourceInfo objects 模板资源列表,由按顺序排列的资源组成,资源类型支持文本、图片、音频、视频。 说明: 资源在JSON数组中的顺序将决定其在手机上的显示顺序,数组大小不能超过10。 remarks 否 String 智能信息基础版模板备注信息,用于填写对模板审核的期望或要求,最大不超过200个字。例如:希望这个模板绑定的通道类型是三网合一通道,默认优先绑定三网合一通道。 callbackurl 否 String 客户系统回调URL,可用于通知对端模板审核状态信息。 说明: 接口规格需参照定义智能信息基础版模板状态回执完成实现。 表3 ResourceInfo 参数 是否必选 参数类型 描述 index 否 String 智能信息基础版序号。 从1开始,例如: 1-1,表示第1帧第1个元素;1-2:表示第1帧第2个元素;2-1:表示第2帧第1个元素。 说明: 每帧支持最多2个元素,2个元素中必须包含有文本 如果未填该字段,则每个元素独占一帧并按数组顺序排序 最多支持8帧 最多2帧同时包含2个元素 index必须全部指定,或者全为空,不能重复 type 是 String 智能信息基础版资源类型。 类型为文字填:txt 类型为图片填:jpg/jpeg/png/gif 类型为音频填:mp3/wav 类型为视频填:mp4/3gp name 是 String 智能信息基础版资源名称。 source 是 String 智能信息基础版资源来源。 txt:表示资源内容是纯文字 file:表示资源内容来源于文件流 url:表示资源内容来源于URL外链 说明: 资源来自于文字/文件流/URL外链。 content 是 String 智能信息基础版资源信息内容。 当source=txt时,填写经过UTF-8编码的文字 当source=file时,填写经过Base64编码的文件流,不须带文件格式前缀,样例:"iVBORw0KGgoAAAANSUhEUgA...",样例过长,未显示全部 当source=url时,填写资源URL地址,URL长度不能超过1024个字节 说明: 文字中可以使用#p_n#参数变量占位,n为1~100内的数字,相同类型的资源同一参数占位符可复用。如:#p_1#已表示是文本参数占位符时,其它位置的文本类型资源可以包含该文本参数占位符。不能包含除模板签名外的“【】” 第一个文本帧,内容必须以:【签名】开始,“签名” 标识客户信息
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 supported_mobiles Array of strings 支持智能信息手机号码列表。 unsupported_mobiles Array of strings 不支持智能信息手机号码列表。 tpl_id String 智能信息模板ID,由9位数字组成。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message Object 结果详情。 说明: 该字段在以后可能会废弃,建议使用error_msg字段对接。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message Object 结果详情。 说明: 该字段在以后可能会废弃,建议使用error_msg字段对接。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 mobiles 是 Array of strings 待查询的手机号码,一次最多请求100个。 说明: 不加密时,参数可传入纯手机号或国家码加手机号,国家码不带“+”号,例如国内手机号“1310000”,参数可传入“1310000”、“861310000”、“00861310000”。使用SHA1加密,mobiles传入号码国家码与手机号码的SHA1算法后的摘要,国家码格式为纯数字,不带“+”,去掉前面的0,例如国内手机号“1310000”,使用“861310000”进行SHA1加密。 最小长度:1 最大长度:40 tpl_id 否 String 智能信息模板ID,由9位数字组成。 说明: 填写时,根据该模板所支持的厂商返回手机终端展示智能信息的能力状态 不填则返回手机终端在所有厂商展示智能信息的能力状态 最小长度:0 最大长度:32 encryption_alg 否 String 加密类型。 NONE:不加密 SHA1:使用SHA1加密算法加密 说明: 默认为NONE。
  • 请求示例 检查手机号智能信息解析能力-原始手机号 https://koomessage.myhuaweicloud.cn/v1/aim/mobile-capabilities/check{ "mobiles" : [ "131****0000", "131****0001" ], "encryption_alg" : "NONE", "tpl_id" : "600000001"} 检查手机号智能信息解析能力-SHA1加密 https://koomessage.myhuaweicloud.cn/v1/aim/mobile-capabilities/check{ "mobiles" : [ "de005a80a77f52080d7c67c65ba8663e5b0f0be1", "1837ec7308eb38494fda35da8a34038ab7533e6a" ], "encryption_alg" : "SHA1", "tpl_id" : "600000001"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 status String 请求状态,固定200。 message String 状态描述。 data Object 固定为null。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data DeletePortResponseBody object 通道号删除返回体。 表4 DeletePortResponseBody 参数 参数类型 描述 data data object 消息体。 表5 data 参数 参数类型 描述 port String 通道号。 port_type Integer 通道号类型。 1:普通 3:前缀号段 5:后缀号段 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。
  • Anti-DDoS错误码 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 200 Anti-DDoS.0 Succeeded 成功 无需处理 200 Anti-DDoS.10000000 The task has been received and is being handled 任务已接收,正在处理 无需处理 400 Anti-DDoS.10000001 Enter a valid request message 请求消息格式非法 检查参数 400 Anti-DDoS.10001008 An incorrect task ID is used 不正确的任务ID 检查参数 400 Anti-DDoS.10001010 Invalid time 时间非法 检查参数 401 Anti-DDoS.10000004 Public test service denied 公测服务被拒绝 申请公测 403 Anti-DDoS.10000002 Failed to authenticate the token in the request 请求所带的Token认证失败 重新申请Token 403 Anti-DDoS.10000009 The account is restricted 账户受限 申请权限 403 Anti-DDoS.10000010 The account is frozen 账户冻结 申请解冻 403 Anti-DDoS.10000012 Unknown user type 未知用户类型 申请权限 403 Anti-DDoS.10000016 VPC access failed or EIP is not exist 访问VPC平台异常或EIP不存在 联系管理员 403 Anti-DDoS.10000030 You have not been authenticated. Perform real-name authentication first. 您尚未认证,请先进行实名认证。 实名认证 403 Anti-DDoS.10001009 The operation permission is restricted 操作权限受限 申请权限 403 Anti-DDoS.11000001 Access to the database is rejected 数据库访问被拒绝 联系管理员 500 Anti-DDoS.11000000 Internal system exception. Contact technical support engineers 系统内部异常,请联系技术支持人员 联系管理员 父主题: 附录
  • 解决方案 针对需求1:当前华为云提供的企业管理服务(EPS)和 统一身份认证 服务(IAM),均可实现项目之间的资源隔离,但两种服务的实现逻辑及功能不同。 企业管理服务:在企业管理服务中创建企业项目,企业项目之间的资源是逻辑隔离,针对企业不同项目间的资源进行分组和管理,一个企业项目中可以包含多个区域的资源。企业项目内的资源可以动态的迁入和迁出,某些服务可以实现指定资源的迁入迁出,例如迁入迁出某一台E CS 服务器。 统一身份认证服务:在统一身份认证服务中创建IAM项目可以实现资源之间的物理隔离,针对同一个区域内的资源进行分组和隔离,一个IAM项目中只能包含一个区域中的资源。 综上,企业管理服务能够实现项目间跨区域的资源隔离,隔离逻辑更加灵活,因此,推荐A公司使用企业管理服务进行项目资源管理,以下需求将基于企业管理服务提出解决方案。如需了解更多统一身份认证和企业管理的区别,请参见:统一身份认证和企业管理的区别。 针对需求2:A公司需要配合使用企业管理服务和统一身份认证服务,在统一身份认证服务中创建用户组、为每个员工创建IAM用户并加入用户组,再将用户组添加至需求1创建的企业项目,并按照表1为各企业项目中的用户组授予相应的资源使用权限。 图1 A公司人员配置模型 表1 A公司各用户组权限配置模型 用户组 职责 所需权限 描述 财务组 负责管理项目费用的使用情况。 Enterprise Project BSS FullAccess 企业项目费用的管理权限。 开发组 负责使用资源进行项目开发。 ECS FullAccess 弹性云服务器(ECS)的所有执行权限。 OBS FullAccess 对象存储服务 (OBS)的所有执行权限。 ELB FullAccess 弹性负载均衡(ELB)的所有执行权限。 安全维护组 负责项目的安全运维。 ECS CommonOperations 弹性云服务器(ECS)的普通操作权限。 CAD Administrator DDoS高防服务 (AAD)的所有执行权限。 运营组 负责所有项目的总体运营。 EPS FullAccess 企业管理服务的所有执行权限,包括修改、启用、停用、查看企业项目。 如需了解华为云所有云服务的系统权限,请参见:系统权限。
  • 企业需求 需求1:A公司需要同时在“华北-北京四”和“华东-上海一”多地域购买多种资源,A公司希望将资源按需分配给两个项目团队,某些服务可实现指定资源的分配,例如某一台ECS服务器只分配给指定IAM用户使用,且两个项目中的资源相互隔离。 需求2:每个项目团队的成员只能访问其所在项目团队的资源,且仅拥有能够完成工作的资源使用最小权限。 需求3:A公司希望两个项目团队能够独立核算成本,项目费用一目了然。
  • 应用场景 假如您是一位开发者,开发了一个应用程序,这个应用程序运行在ECS实例上,应用程序的代码中涉及调用API访问华为云服务。此时,因为华为云服务要求访问请求方出示访问凭证,所以您的API调用将会面临提供访问凭证的问题。 访问凭证按照时效性可分为永久凭证和临时凭证,相较于永久性访问凭证,例如用户名和密码,临时访问密钥因为有效期短且刷新频率高,所以安全性更高。因此,您的应用程序若想要以更安全的方式访问云服务,需要获取临时访问凭证,而IAM的委托功能,则支持通过ECS委托获取临时访问密钥。 图1 应用程序获取临时访问密钥 如图1所示,以访问数据库服务举例。因为数据库服务要求访问请求方提供访问凭证,所以应用程序需要获得委托的临时访问密钥AK、SK。应用程序与ECS元数据服务通信,ECS元数据服务再与IAM通信,拿到临时AK、SK后返回给应用程序。然后,应用程序将临时AK、SK作为访问凭证出示给数据库服务,数据库服务收到请求后,先校验访问凭证是否合法,凭证通过校验后,ECS实例上的应用程序才能访问数据库服务。
  • 解决方案 针对以上应用场景,可使用IAM对ECS云服务的委托来获取临时访问密钥。在IAM上对ECS云服务授权,并对应用程序所在的ECS实例进行授权委托管理。ECS实例获得委托权限之后,应用程序可申请指定委托的临时访问密钥,从而以临时访问密钥为凭证安全访问华为云资源。详细方案如下: 创建ECS云服务委托。账号在IAM控制台创建委托,指定委托对象为ECS云服务。委托创建时,选择权限策略,选择可访问的资源范围,不同的委托对应不同的权限策略。 ECS实例配置委托。在ECS实例的配置项中选择上一步创建的委托,一个ECS实例只可以选择一个委托。 获取委托的临时凭证。ECS实例配置了委托参数后,就获得了委托权限。此时,ECS实例上运行的应用程序可获取委托的临时访问密钥AK、SK。拥有临时访问密钥的应用程序可与华为云服务进行交互,交互行为遵循账号授予的权限策略和资源使用范围。
  • 常用系统权限设置案例 请参考以下文档给IAM用户设置常见云服务的访问权限。 设置弹性云服务器(ECS)的权限 设置弹性负载均衡(ELB)的权限 设置关系型数据库(RDS)的权限 设置云硬盘(EVS)的权限 设置 云监控 CES )的权限 设置云容器引擎(CCE)的权限 设置对象存储服务(OBS)的权限 设置云备份(CBR)的权限 设置虚拟私有云(VPC)的权限 设置分布式缓存服务(DCS)的权限 设置文档数据库服务(DDS)的权限 设置费用中心的权限 设置提交工单的权限
  • v2接口的授权信息 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询证书列表 GET /v2/{project_id}/scm/certlist scm:cert:list - √ x 查询证书详情 GET /v2/{project_id}/scm/cert/{cert_id} scm:cert:get - √ x 查询证书产品类型 GET /v2/{project_id}/scm/cert/product scm:certType:get - √ x 查询证书产品详情 GET /v2/{project_id}/scm/product/{product_id} scm:certProduct:get - √ x 取消申请 POST /v2/{project_id}/scm/cert/{cert_id}/cancel-cert scm:cert:cancel - √ x 购买证书 POST /v2/{project_id}/scm/cert/purchase scm:cert:purchase - √ x 申请证书 POST /v2/{project_id}/scm/cert/{cert_id}/complete scm:cert:complete - √ x 保存申请证书填写的信息 POST /v2/{project_id}/scm/cert/{cert_id}/save scm:cert:complete - √ x 读取申请证书填写的信息 POST /v2/{project_id}/scm/cert/{cert_id}/read scm:cert:complete - √ x 修改证书 PUT /v2/{project_id}/scm/cert/{cert_id} scm:cert:edit - √ x 删除证书 DELETE /v2/{project_id}/scm/cert/{cert_id} scm:cert:delete - √ x 下载证书 GET /v2/{project_id}/scm/cert/{cert_id}/cert_file scm:cert:download - √ x 上传认证信息 POST /v2/{project_id}/scm/cert/{cert_id}/info/{type}/upload_authentication scm:cert:complete - √ x 吊销证书 POST /v2/{project_id}/scm/cert/{cert_id}/revoke scm:cert:revoke - √ x 推送证书 POST /v2/{project_id}/scm/cert/{cert_id}/push scm:cert:push 推送至CDN时,还需要添加如下授权项: cdn:configuration:queryHttpsConf √ x 查询推送记录 GET /v2/{project_id}/scm/cert/{cert_id}/push-history scm:pushHistory:list - √ x 上传证书 POST /v2/{project_id}/scm/cert/upload scm:cert:upload - √ x 校验CSR POST /v2/{project_id}/scm/check-csr scm:cert:complete - √ x 新增附加域名 POST /v2/{project_id}/scm/cert/{cert_id}/supplement scm:cert:supplement - √ x 取消隐私授权 DELETE /v2/{project_id}/scm/privacy-protection/{cert_id} scm:privacyProtection:delete - √ x
  • v3接口的授权信息 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询证书列表 GET /v3/scm/certificates scm:cert:list - √ x 获取证书详情 GET /v3/scm/certificates/{certificate_id} scm:cert:get - √ x 删除证书 DELETE /v3/scm/certificates/{certificate_id} scm:cert:delete - √ x 推送证书 POST /v3/scm/certificates/{certificate_id}/push scm:cert:push 推送至CDN时,还需要添加如下授权项: cdn:configuration:queryHttpsConf √ x 导入证书 POST /v3/scm/certificates/import scm:cert:upload - √ x 导出证书 POST /v3/scm/certificates/{certificate_id}/export scm:cert:download - √ x
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,参见:IAM token获取方法。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of ResourceTag objects 标签列表,key和value键值对的集合。 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value 是 String 标签值。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX"} 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX"} 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX"} 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX"} 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX"}
  • 请求示例 批量创建标签键为"key1",标签值为"value1"和标签键为"key2",标签值为"value2"的CA标签。请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificate-authorities/4c0e772e-a30c-4029-b929-b7acb04143f7/tags/create{ "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ]}
  • 请求示例 批量创建标签键为"key1",标签值为"value1"和标签键为"key2",标签值为"value2"的证书标签。请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificates/4c0e772e-a30c-4029-b929-b7acb04143f7/tags/create{ "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ]}
  • 响应示例 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX"} 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX"} 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX"} 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX"} 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,参见:IAM token获取方法。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of ResourceTag objects 标签列表,key和value键值对的集合。 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value 是 String 标签值。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255
  • 响应参数 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
共100000条