华为云用户手册

  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 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值为“ABCDEFG....”,则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可,如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Auth-Token: ABCDEFG....
  • 错误码 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 SCM.0003 Tenant has no privilege. 租户无法操作不属于自己的证书 请操作自己的证书 400 SCM.0005 Incorrect request parameter. 请求参数错误 请填写正确的请求参数 400 SCM.0006 The uploaded certificate failed to be resolved. Ensure that the uploaded certificate has been issued. 上传证书解析不正确 请上传已签发的证书 400 SCM.0008 Abnormal certificate ID 证书编号异常 请填写正确的证书编号 400 SCM.0009 Failed to upload the certificate because no domain name is bound to the certificate. 证书未绑定 域名 ,上传失败 请传递已绑定域名的证书 400 SCM.0010 This operation is not allowed by the current certificate type or status. 证书类型或当前状态不支持此操作 请传递证书的证书类型或者选择证书状态的证书进行此操作 400 SCM.0011 The max number of free certificates for the current user has been reached, and you cannot continue to purchase free certificates. 当前用户证书数量已经达到最大值,不能继续添加 请不要继续添加证书 400 SCM.0012 The uploaded private key failed to be resolved. Ensure that the certificate has been issued. 上传私钥解析不正确,请确保填写已签发证书 请填写正确的证书私钥 400 SCM.0014 The uploaded certificate does not match the private key. 上传证书和私钥不匹配 请传递正确的证书和私钥 400 SCM.0015 The number or format of domain names entered does not meet the requirements of the your certificate. 填写域名数量或格式与所购买证书要求不一致 请上传单域名和泛域名证书 400 SCM.0016 Failed to order. 订单异常 请联系技术支持 400 SCM.0020 Incorrect certificate ID. 证书ID错误 请传递正确的证书编号 400 SCM.0023 Modify key format error. 修改键错误 请输入不为空的键 400 SCM.0024 Modify value format error. 修改内容错误 请输入不为空的值 400 SCM.0025 Exceed the limit 超出限额 证书超出重签时效 400 SCM.0026 Revoke cert error 证书吊销异常 请联系技术支持 400 SCM.0027 Have no revoke reason 吊销原因未填写 请输入吊销原因 400 SCM.0028 Push cert error 证书推送异常 请联系技术支持 400 SCM.0030 Certificates cannot be pushed to this service. 暂不支持的推送服务类型 请填写正确的推送服务 400 SCM.0031 Certificate parsing error. 证书解析异常 请上传正确的证书 400 SCM.0032 Incorrect certificate name. 证书名称错误 请填写正确的证书名称 400 SCM.0033 Csr not bind domain. CS R未绑定域名 请输入包含域名的csr 400 SCM.0034 Csr parse error. CSR解析异常 请输入合法的csr 400 SCM.0035 Csr domain not match input domain. CSR域名与输入域名不匹配 请保持域名一致 400 SCM.0036 Domain number not match product. 域名数量与产品不匹配 请输入正确数量的域名 400 SCM.0039 The updated quota value must be greater than the currently used quota. 更新的配额数值必须大于当前已使用的配额数量 请输入正确的配额数值 400 SCM.0042 Cert has expired. 证书已过期 请不要上传已过期的证书 400 SCM.0044 Permission denied,please obtain {0} permission. 权限不足,请先获取{0}权限 请先获取权限 400 SCM.0049 Cert brand error. 证书品牌异常 请输入证书品牌 400 SCM.0050 Cert type error. 证书类型异常 请输入正确的证书类型 400 SCM.0051 Domain type error. 域名类型异常 请输入正确的域名类型 400 SCM.0052 Cert effective time error. 证书有效期异常 请输入正确的证书 400 SCM.0059 The certificate private key is empty. 证书私钥为空 请联系客服处理 400 SCM.0060 Order number error. 订单数量异常 请输入正确的订单数量 400 SCM.0061 Region parameter error. region参数异常 请输入正确的region 400 SCM.0063 Duplicate domain error. 域名重复 请输入不重复的域名 400 SCM.0064 The order is executing. 订单正在处理中 请不要重复下单 400 SCM.0065 File size exceeds limit. 文件大小超过限制 请输入正确大小的文件 400 SCM.0066 Current domain type not allowed to operate. 证书域名类型不支持当前操作 请联系客服处理 400 SCM.0067 Sans changed. 已有附加域名被修改 请输入正确的附加域名 400 SCM.0068 Unsupported region. 暂不支持推送到该Region 请联系技术支持 400 SCM.0070 Incorrect format of the domain bound to the certificate to be uploaded. 上传证书域名格式错误 请传递正确证书 400 SCM.0072 SCM does not support this status. SCM暂不支持的操作类型 请联系技术支持 400 SCM.0073 Help content format error. 求助内容错误 请输入正确的邮件内容 400 SCM.0074 Cert is not renewal paid. 证书不是已续费状态 请联系技术支持 400 SCM.0075 Invalid region id. 无效的region id 请输入合法的region id 400 SCM.0076 DIGICERT DV basic not support to renew. DIGICERT DV basic证书不支持续费 请联系客服处理 400 SCM.0079 Subject of CaCert not match issuer of Cert CaCert的主题与证书的签发者不匹配 请联系技术支持 400 SCM.0080 Required param cert_info is null or empty. 必填请求参数cert_info为空 请输入非空的证书信息 400 SCM.0081 Required param cert_info is null or empty. 必填请求参数cert_info为空 请输入非空的证书信息 400 SCM.0082 Invalid validity_period, should be 12. 无效参数validity_period,必须为12 请输入合法的属性 400 SCM.0083 Required param first_name is null or empty. 必填请求参数first_name为空 请输入不为空的属性 400 SCM.0085 Required param phone is null or empty. 必填请求参数phone为空 请输入不为空的属性 400 SCM.0086 Required param email is null or empty. 必填请求参数email为空 请输入不为空的属性 400 SCM.0095 Run RmsApiController failed. 请求有误,调用接口时报 请联系技术支持 400 SCM.0101 The cert not support to auto deploy. 该证书不支持资源到期自动替换 请联系客服处理 400 SCM.0102 This resource has been open to auto deploy. 资源已开启到期自动替换 请不要重复操作 400 SCM.0103 This resource is not exist. 资源不存在 请不要操作不存在的资源 400 SCM.0104 This region is not support. 不支持的region 请不要操作不支持的region 400 SCM.0105 The cert has associated the auto deployed resources. 证书关联到开启到期自动替换资源,请先关闭所有到期自动替换资源 请联系客服处理 400 SCM.0106 The resource domain is not equals the cert. 资源域名与证书域名不匹配 请输入正确的域名 400 SCM.0108 Domain format is invalid. 域名格式非法 请输入正确的域名 400 SCM.0109 Cert chain length must be more than 1. 证书链长度必须大于1 请联系技术支持 400 SCM.0201 Failed to push to ELB. 推送失败,ELB error message: 请联系客服处理 400 SCM.0202 Insufficient ELB permissions ELB权限不足 请配置ELB权限 400 SCM.0204 ELB does not support this region. ELB暂不支持此region 请选择其他支持的region 400 SCM.0211 Failed to push to CDN. 推送失败,CDN error message: 请联系客服处理 400 SCM.0212 Insufficient CDN permissions CDN权限不足 请配置CND权限 400 SCM.0221 Failed to push to WAF. 推送失败,WAF error message: 请联系客服处理 400 SCM.0222 Insufficient WAF permissions WAF权限不足 请配置WAF权限 400 SCM.0224 WAF does not support this region. WAF暂不支持此region 请选择其他支持的region 400 SCM.0225 Insufficient WAF quota. WAF配额不足 请联系客服处理 400 SCM.0301 Tag is not found. 标签未找到 请联系客服处理 400 SCM.0302 Tag quota is upper limit. 标签配额达到上限 请不要添加标签 400 SCM.0303 Match tag invalid. 标签匹配错误 请添加合法标签 400 SCM.0304 Field action is error. action字段有误 请联系客服处理 400 SCM.0305 Tag value is invalid. 标签值非法 请输入合法的标签值 400 SCM.0306 Tag key is invalid. 标签键非法 请输入合法的标签键 400 SCM.0309 Tag value length is invalid. 标签值长度非法 请输入长度合法的标签值 400 SCM.0310 Tag key length is invalid. 标签键长度非法 请输入长度合法的标签键 400 SCM.0311 Tag key list is invalid. 标签键列表非法 请输入合法的标签键列表 400 SCM.0312 Tag value list is invalid. 标签值列表非法 请输入合法的标签值列表 400 SCM.0313 Tag list is invalid. 标签列表非法 请输入合法的标签列表 400 SCM.0314 Match resourceId invalid. 匹配错误 请联系客服处理 400 SCM.0318 Tag limit invalid. 标签查询limit参数非法 请输入合法的参数 400 SCM.0319 Tag offset invalid. 标签查询offset参数非法 请输入合法的参数 400 SCM.0321 Invalid param sys_tags. 参数sys_tags错误 请输入合法的参数 400 SCM.0323 Invalid tag parameter. 不合法的标签参数 请输入合法的参数 400 SCM.0401 Gm cert is not support to be pushed. 不支持推送国密证书 请联系技术支持 400 SCM.0501 The parameter cannot be null or the parameter is wrong. Currently only supports: 参数不可为空或者参数错误,目前仅支持: 目前仅支持WAF/CDN/ELB 400 SCM.0502 The certificate ID list cannot be empty. 证书ID列表不可为空 请输入不为空的证书id列表 400 SCM.0505 Parameter error, parameter is null or its list size is out of range, additional info:{0} 参数错误,参数为null或其列表大小超出范围 请输入长度大于0小于51的列表参数 400 SCM.0506 There is no corresponding certificate ID under the tenant, and the set of certificate IDs that cannot be found:{0} 该租户下不存在对应证书ID 请联系技术支持 400 SCM.0507 The list parameter cannot have duplicate elements 该列表参数不可存在重复元素 请输入不重复的参数 400 SCM.0508 Parameter error, the following certificates do not support querying deployed resources:{0} 参数错误,以下证书不支持查询已部署资源 请输入合法的证书 401 SCM.0092 Decrypt jwt token failed. 解密JWT token失败 请联系技术支持 401 SCM.1000 The token of the request fails to be authenticated 请求所带的Token没有经过认证或者认证失败 请填写正确token 401 SCM.1004 Failed to apply for OBT. 用户未申请服务公测,请先申请公测 请申请公测 401 SCM.1009 Your account is restricted. 账户受限 请联系管理员解冻 401 SCM.1010 Your account is frozen. 账户冻结 请联系管理员解冻 401 SCM.4002 You do not have permission to perform this operation. 您的权限不足。缺少策略 请联系管理员添加策略 403 SCM.0001 Service is not open. 服务未开放 请联系技术支持 403 SCM.0002 Incorrect tenant ID. 租户ID错误 请传递正确与X-Auth-Token匹配的projectId 403 SCM.0040 The max number of free certificates for the current user has been reached, and you cannot continue to purchase free certificates. 当前用户免费证书数量已经达到最大值,不能继续购买免费证书 请停止购买免费证书 403 SCM.0322 Invalid user token, user role don't contain op_service. 用户token非法,未包含op_service角色 请联系客服处理 403 SCM.1019 The user role has no permission to access the interface 用户角色无权限访问该接口 请联系技术支持 404 SCM.0069 No projects found. 项目不存在 请选择存在的项目 404 SCM.0094 Resource not found. 未找到资源 请联系技术支持 500 SCM.0004 Fail to get ca response. 请求ca接口出现错误 请联系技术支持 500 SCM.0007 Failed to download the certificate. 证书下载失败 请联系客服处理 500 SCM.0013 The uploaded certificate chain failed to be resolved. Ensure that the certificate has been issued. 上传证书链解析不正确,请确保填写已签发证书 请填写正确的证书链 500 SCM.0017 product wrong. 产品错误 请联系技术支持 500 SCM.0019 CSB response error. CSB连接失败 请联系技术支持 500 SCM.0037 Failed to encrypt the certificate. 证书加密失败 请联系客服处理 500 SCM.0038 Cert decrypt fail. 证书解密失败 请联系技术支持 500 SCM.0062 DNS query fail. DNS查询失败 请联系技术支持 500 SCM.0071 SCM does not support this resourceType. SCM不支持的资源类型 请联系技术支持 500 SCM.0087 Request cert failed. 申请证书失败 请联系技术支持 500 SCM.0091 Connect jwt server failed. 连接到JWT服务器失败 请联系技术支持 500 SCM.0093 Invalid jwt token. 无效的JWT token 请联系技术支持 500 SCM.0097 Encode next token failed. 加密next token失败 请联系技术支持 500 SCM.0098 Decode next token failed. 解密next token失败 请联系技术支持 500 SCM.0099 Invalid domain id. 无效的domain id 请输入合法的domain id 500 SCM.0100 UnKnown error. 未知错误 请联系技术支持 500 SCM.0203 Failed to push to ELB. ELB推送失败 请联系客服处理 500 SCM.0213 Failed to push to CDN. CDN推送失败 请联系客服处理 500 SCM.0223 Failed to push to WAF. WAF推送失败 请联系客服处理 500 SCM.0324 Calculate digest failure. 计算签名失败 请联系技术支持 500 SCM.0402 Encrypt cert content or private key is null. 加密证书内容或私钥为空 请联系技术支持 500 SCM.0504 Service internal error, please contact technical support. 服务内部错误,请联系技术支持 请联系技术支持 500 SCM.4001 An error occurred when accessing the PDP API. 获取细粒度授权结果失败 请联系客服处理 父主题: 错误码
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证。 AK/SK既可以使用永久访问密钥中的AK/SK,也可以使用临时访问密钥中的AK/SK,但使用临时访问密钥的AK/SK时需要额外携带“X-Security-Token”字段,字段值为临时访问密钥的security_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离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 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值为“ABCDEFG....”,则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可,如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333。
  • 私有CA相关接口的授权信息 权限 对应API接口 授权项(Action) 企业项目 (Enterprise Project) 创建CA POST /v1/private-certificate-authorities pca:ca:create x 取消计划删除CA POST /v1/private-certificate-authorities/{ca_id}/restore pca:ca:restore x 查询私有CA详情 GET /v1/private-certificate-authorities/{ca_id} pca:ca:get x 查询私有CA CSR GET /v1/private-certificate-authorities/{ca_id}/csr pca:ca:getCsr x 查询私有CA配额 GET /v1/private-certificate-authorities/quotas pca:ca:quota x 导出私有CA POST /v1/private-certificate-authorities/{ca_id}/export pca:ca:export x 删除私有CA DELETE /v1/private-certificate-authorities/{ca_id} pca:ca:delete x 禁用私有CA POST /v1/private-certificate-authorities/{ca_id}/disable pca:ca:disable x 启用私有CA POST /v1/private-certificate-authorities/{ca_id}/enable pca:ca:enable x 激活私有CA POST /v1/private-certificate-authorities/{ca_id}/activate pca:ca:active x 导入 CA POST /v1/private-certificate-authorities/{ca_id}/import pca:ca:import x 查询私有CA列表 GET /v1/private-certificate-authorities pca:ca:list √
  • 私有证书相关接口的授权信息 权限 对应API接口 授权项(Action) 企业项目 (Enterprise Project) 查询私有证书详情 GET /v1/private-certificates/{certificate_id} pca:cert:get x 解析私有证书CSR POST /v1/private-certificates/csr/parse pca:cert:parseCsr x 导出私有证书 POST /v1/private-certificates/{certificate_id}/export pca:cert:export x 查询私有证书配额 GET /v1/private-certificates/quotas pca:cert:quota x 创建私有证书 POST /v1/private-certificates pca:ca:issueCert x 删除私有证书 DELETE /v1/private-certificates/{certificate_id} pca:ca:delete x 吊销私有证书 POST /v1/private-certificates/{certificate_id}/revoke pca:cert:revoke x 使用CSR创建私有证书 POST /v1/private-certificates/csr pca:ca:issueCertThroughCSR x 查询私有证书列表 GET /v1/private-certificates pca:cert:list √
  • 操作步骤 查询证书列表。 接口相关信息 URI格式:GET /v3/scm/certificates 详情请参见查询证书列表。 请求示例 GET: https://{endpoint}/v3/scm/certificates {endpoint}信息请从地区和终端节点获取。 Body: { "limit": "2", "offset": "0" } 响应示例 { "certificates" : [ { "id" : "scs1554192131150", "name" : "test", "domain" : "www.zx.com", "type" : "OV_SSL_CERT", "brand" : "GEOTRUST", "expire_time" : "2021-05-27 16:46:25.0", "domain_type" : "MULTI_DOMAIN", "validity_period" : 12, "status" : "ISSUED", "domain_count" : 2, "wildcard_count" : 0, "description" : null } ], "total_count" : 1 } 推送SSL证书。 接口相关信息 URI格式:POST /v3/scm/certificates/{certificate_id}/push 详情请参见推送证书。 请求示例 POST: https://{endpoint}/v3/scm/certificates/scs1554192131150/push {endpoint}信息请从地区和终端节点获取。 响应示例 { } 或 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 操作步骤 导入证书。 接口相关信息 URI格式:POST /v3/scm/certificates/import 详情请参见导入证书。 请求示例 POST: https://{endpoint}/v3/scm/certificates/import {endpoint}信息请从地区和终端节点获取。 响应示例 { "certificate_id" : "scs1554192131150" } 查询证书列表。 接口相关信息 URI格式:GET /v3/scm/certificates 详情请参见查询证书列表。 请求示例 GET: https://{endpoint}/v3/scm/certificates {endpoint}信息请从地区和终端节点获取。 Body: { "limit": "2", "offset": "0" } 响应示例 { "certificates" : [ { "id" : "scs1554192131150", "name" : "test", "domain" : "www.zx.com", "type" : "OV_SSL_CERT", "brand" : "GEOTRUST", "expire_time" : "2021-05-27 16:46:25.0", "domain_type" : "MULTI_DOMAIN", "validity_period" : 12, "status" : "ISSUED", "domain_count" : 2, "wildcard_count" : 0, "description" : null } ], "total_count" : 1 } 推送证书。 接口相关信息 URI格式:POST /v3/scm/certificates/{certificate_id}/push 详情请参见推送证书。 请求示例 POST: https://{endpoint}/v3/scm/certificates/scs1554192131150/push {endpoint}信息请从地区和终端节点获取。 响应示例 { } 或 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 操作步骤 查询证书列表。 接口相关信息 URI格式:GET /v3/scm/certificates 详情请参见查询证书列表。 请求示例 GET: https://{endpoint}/v3/scm/certificates {endpoint}信息请从地区和终端节点获取。 Body: { "limit": "2", "offset": "0" } 响应示例 { "certificates" : [ { "id" : "scs1554192131150", "name" : "test", "domain" : "www.zx.com", "type" : "OV_SSL_CERT", "brand" : "GEOTRUST", "expire_time" : "2021-05-27 16:46:25.0", "domain_type" : "MULTI_DOMAIN", "validity_period" : 12, "status" : "ISSUED", "domain_count" : 2, "wildcard_count" : 0, "description" : null } ], "total_count" : 1 } 删除证书。 接口相关信息 URI格式:DELETE /v3/scm/certificates/{certificate_id} 详情请参见删除证书。 请求示例 DELETE: https://{endpoint}/v3/scm/certificates/scs1554192131150 {endpoint}信息请从地区和终端节点获取。 Body: { certificate_id:scs1554192131150 } 响应示例 { } 或 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 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
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 “√”表示支持,“x”表示暂不支持。 云证书管理服务 (CCM)支持的自定义策略授权项如下所示: SSL证书管理 私有证书管理
  • 调用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": "xxxxxxxx", "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" } }
  • 私有证书管理状态码 状态码 编码 状态说明 200 OK 请求已成功。 201 Created 创建类的请求完全成功。 204 NO Content 执行成功,无响应消息体。 400 Bad Request 请求参数有误。 401 Unauthorized 服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 服务器已经理解请求,但是拒绝执行它。 404 Not Found 资源不存在,资源未找到。 500 Internal Server Error 服务内部错误。
  • SSL证书管理状态码 状态码 编码 状态说明 200 OK 请求已成功。 202 Accept 任务提交成功,当前系统繁忙,下发的任务会延迟处理。 204 No Content 请求已成功,无内容返回。 300 multiple choices 被请求的资源存在多个可供选择的响应。 400 Bad Request 请求参数有误。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 服务器已经理解请求,但是拒绝执行它。 404 Not Found 资源不存在,资源未找到。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证,这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突,请求无法被完成。 500 Internal Server Error 服务内部错误。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。
  • 请求消息 请求参数 参数 是否必选 参数类型 描述 ori_sans 是 String 多域名证书中已经绑定的附加域名。 当显示有多个域名时,请以“;”隔开。 示例:example.domain.com;example.domain1.com add_sans 否 String 多域名证书需要增加的附加域名。 当需要输入多个域名时,请以“;”隔开。 示例:example.domain2.com;example.domain3.com email 否 String 联系人邮箱地址。
  • 示例 如下以新增1个附加域名“example.domain.com”为例。 请求样例 { "ori_sans": "abc.com;xyz.com", "add_sans": "example.domain.com", "email": "example@xx.com" } 响应样例 { "request_info":"success" } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
  • 示例 请求样例 无。 响应样例 { "push_history_list": [ { "push_time": "1556257820000", "push_remote_project": null, "push_service": "CDN" }, { "push_time": "1556257447000", "push_remote_project": "cn-north-7_test", "push_service": "WAF" } ] } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
  • 响应消息 响应参数 参数 是否必选 参数类型 描述 push_history_list 是 Array of push_history_list objects 推送记录列表,详情请参见表1。 表1 push_history_list 参数 是否必选 参数类型 描述 push_time 是 String 推送时间,毫秒级时间戳。 push_remote_project 是 String 推送项目。 push_service 是 String 推送的服务类型。 WAF:证书推送到了 Web应用防火墙 中。 CDN:证书推送到了内容分发网络中。 ELB:证书推送到了弹性负载均衡(经典型)中。 Enhance_ELB:证书推送到了弹性负载均衡(独享型和共享型)中。
  • 示例 如下以推送证书到“WAF”,推送区域为“cn-north-7”为例。 请求样例 { "service_type":"WAF", "remote_project":"cn-north-7" } 响应样例 { "message":"success" } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
  • 示例 如下以上传名称test的证书为例。 请求样例 { "cert_name":"test", "cert":"-----BEGIN CERTIFICATE----- *** -----END CERTIFICATE-----", "private_key": "-----BEGIN RSA PRIVATE KEY----- *** -----END RSA PRIVATEKEY-----" } 响应样例 { "cert_id": " scs1481110651012" } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
  • 示例 请求样例 无。 响应样例 { "domain_name": "www.domain.com", "sans": "", "CSR": null, "country": "CN", "company_unit": "人力部", "company_name": "A公司成都分公司", "company_province": "四川", "company_city": "成都", "applicant_name": "A公司", "applicant_phone": "13****28932", "applicant_email": "10****2346@qq.com", "contact_name": "环境", "contact_phone": "13****56325", "contact_email": "jk@jk.ff", "bl": "0", "tl": "1" } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
  • 响应消息 响应参数 参数 是否必选 参数类型 描述 domain_name 是 String 证书绑定的域名。 示例:www.domain.com sans 是 String 多域名证书的附加域名,多个域名以“;”隔开。 如果申请的是单域名或泛域名类型的证书,该值则显示为空。 CSR 是 String 证书请求文件。 country 是 String 国家代码。示例如下: CN:中国 US:美国 company_name 是 String 公司名称。 company_unit 是 String 部门名称。 company_province 是 String 公司所在省份。 示例:四川 company_city 是 String 公司所在市。 示例:成都 applicant_name 是 String 申请人姓名。 示例:张三 applicant_phone 是 String 申请人电话。 示例:13****28932 applicant_email 是 String 申请人邮箱。 示例:example.huawei.com contact_name 是 String 技术联系人姓名。 contact_phone 是 String 技术联系人电话。 contact_email 是 String 技术联系人邮箱。 bl 是 String 银行开户许可照片是否已上传。 0:未上传。 1:已上传。 tl 是 String 公司营业执照是否已上传。 0:未上传。 1:已上传。
  • 示例 如下以保存某张证书已补全的信息为例。 请求样例 { "domain":"www.xzz.com", "company_name":"华为成都分公司", "company_province":"四川", "company_city":"成都", "applicant_name":"华卫", "applicant_phone":"13212345678", "applicant_email":"9997342346@qq.com", "csr":"", "sans":"", "country":"CN", "company_unit":"人力部", "contact_name":"环境", "contact_phone":"13512345678", "contact_email":"jk@jk.ff", "agree_privacy_protection":true } 响应样例 { "request_info":"success" } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
  • 请求消息 请求参数 参数 是否必选 参数类型 描述 domain 是 String 证书绑定的域名。 sans 否 String 多域名证书附加域名,多个域名以“;”隔开。 csr 否 String 证书csr串,与域名必须匹配。 company_name 是 String 公司名称,OV和EV型证书用户必填。 字符长度为0~63位。 company_unit 否 String 部门名称,OV和EV型证书用户非必填。 字符长度为0~63位。 company_province 是 String 公司所在省份,OV和EV型证书用户必填。 字符长度为0~63位。 company_city 是 String 公司所在市区,OV和EV型证书用户必填。 字符长度为0~63位。 country 是 String 国家代码。 applicant_name 是 String 申请人姓名。 字符长度为0~63位。 applicant_phone 是 String 申请人电话号码。 示例:13212345678 applicant_email 是 String 申请人邮箱。 示例:example.huawei.com contact_name 否 String 技术联系人姓名。 字符长度为0~63位。 contact_phone 否 String 技术联系人电话号码。 示例:13212345678 contact_email 否 String 技术联系人邮箱。 示例:example.huawei.com agree_privacy_protection 是 Boolean 是否同意授权隐私协议。 true:同意授权隐私协议。 false:不同意授权隐私协议。 此处仅能设置为true才能保存证书信息。
  • 示例 如下以校验某个CSR为例。 请求样例 { "csr":"-----BEGIN NEW CERTIFICATE REQUEST-----******-----END NEW CERTIFICATE REQUEST-----" } 响应样例 { "domain": "a.example1.com" } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
  • 示例 如下以补全某张证书的信息为例。 请求样例 { "domain":"www.xzz.com", "company_name":"A公司成都分公司", "company_province":"四川", "company_city":"成都", "applicant_name":"A公司", "applicant_phone":"132****5678", "applicant_email":"999****346@qq.com", "csr":"", "sans":"", "country":"CN", "company_unit":"人力部", "contact_name":"环境", "contact_phone":"135****5678", "contact_email":"jk@jk.ff", "auto_dns_auth":false, "agree_privacy_protection":true } 响应样例 { "request_info":"success" } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
  • 请求消息 请求参数 参数 是否必选 参数类型 描述 domain 是 String 该证书绑定的域名。 当购买的证书为“单域名”或“泛域名”类型的证书时,请直接填写单域名或泛域名即可。 当购买的证书为“多域名”类型的证书时,需要选择1个域名作为主域名。 示例:www.example.com sans 否 String 绑定多域名类型证书的附加域名。 当购买的证书为“多域名”类型的证书,且有可增加附加域名的额度时,才需要设置该值。 多个域名需要以“;”隔开。 示例:www.example.com;www.example1.com;www.example2.com csr 否 String 证书CSR串,与域名必须匹配。 company_name 是 String 公司名称,OV和EV型证书必填。 字符长度为0~63位。 company_unit 否 String 部门名称,OV和EV型证书非必填。 字符长度为0~63位。 company_province 是 String 公司所在省份,OV和EV型证书必填。 字符长度为0~63位。 company_city 是 String 公司所在市区,OV和EV型证书必填。 字符长度为0~63位。 country 是 String 国家代码。 CN:中国 US:美国 applicant_name 是 String 申请人的姓名。 字符长度为0~63位。 applicant_phone 是 String 申请人的电话号码。 示例:13212345678 applicant_email 是 String 申请人的邮箱。 示例:example@huawei.com contact_name 否 String 技术联系人的姓名。 字符长度为0~63位。 contact_phone 否 String 技术联系人的电话号码。 示例:13212345678 contact_email 否 String 技术联系人的邮箱。 示例:example@huawei.com auto_dns_auth 否 Boolean 是否将DNS验证信息推送到华为云解析服务。 true:推送。 false:不推送。 agree_privacy_protection 是 Boolean 是否同意授权隐私协议。 true:同意隐私协议。 false:不同意隐私协议。 此处仅能设置为true才能成功申请证书。 domain_method 是 String 域名验证方式。 dns:DV、OV、EV域名证书可选。 file:仅IP证书可选。 email:OV、EV域名证书可选。
  • 响应消息 响应参数 参数 是否必选 参数类型 描述 cert_type 是 String 证书类型。 OV_SSL_CERT:企业型SSL证书。 EV_SSL_CERT:增强型SSL证书。 cert_brand 是 String 证书品牌。 GLOBALSIGN:Globalsign品牌。 domain_type 是 String 域名类型。 SINGLE_DOMAIN:单域名类型。 MULTI_DOMAIN:多域名类型。 WILDCARD:泛域名类型。 effective_time 是 Integer 证书有效期(年)。 1:证书有效期为1年。 2:证书有效期为2年。
  • 示例 请求样例 无。 响应样例 { "type_list": [{ "cert_type": "OV_SSL_CERT", "cert_brand":"GLOBALSIGN", "domain_type":"SINGLE_DOMAIN", "product_id":"00301-106005-0--0", "effective_time":1, "product_name ":"globalsign.single.ov.2" }] } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全