华为云用户手册

  • 将应用上架到模板中心 您需将应用先上架到应用中心,该应用才可上架到模板中心。 在“货架管理”页面选择“已上架”页签,单击操作列“上架模板中心”,弹出上架弹窗。 图2 将应用上架到模板中心 填写应用信息,如表1所示,单击“上架模板中心”。 系统提示“申请上架成功”,请您耐心等待,待审批通过后即可上架到模板中心。 表1 应用信息 字段 描述 应用名称 在页面显示的应用名称,限制20个字符。 应用图标 应用的图标,此处的图标是在轻应用构建平台申请上架应用时设置的图标,不支持修改。 应用简介 用于描述应用的用途。 提供单位 用于体现应用提供单位。 应用印象 内容显示在应用卡片的背景图片上,可用于体现应用的特性功能等。 分类 应用所属的分类,包含角色、场景、功能和行业四大类。在模板中心可通过分类筛选应用。 价格 设置应用交易价格,保留小数点后两位。 标签 显示在应用卡片下方,用于体现应用行业、分类、用途等。最多可添加3个标签。 背景图片 应用使用的背景图片。仅支持PNG、JPG、JPEG格式图片,大小在10M以内,建议比例16:9。 演示视频 用于展示应用使用方法的视频。支持MP4-H.264、WebM、Ogg格式文件,大小不超过2G。
  • 属性 字段标题:该字段在页面呈现给用户的名称,默认名称为该字段类型名称。 标题加粗:是否打开开关,默认关闭状态。 字段状态:指成员在访问表单时,对该字段的可见、可编辑权限。 只读:勾选后,页面上该字段可见、不可编辑。 隐藏:勾选后,页面上该字段不可见、不可编辑。 禁用:勾选后,页面上该字段仍可显示,但不可进行配置。 验证:对字段做一些限制。 必填:字段是否必填。勾选“必填”,页面展示会有提示必填。 设置选项列表:创建主类目和子类目,设置层级关系,最多创建5级节点。 支持通过导入excel模板设置选项列表。 支持导出已创建的选项列表到本地。 支持下载模板,在模板中编辑选项列表,导入选项列表模板。 下拉菜单样式:创建事件时,“级联选择”组件下拉菜单的展示形式,支持级联菜单和树形选择。 设置:选项列表设置,支持选择“必须选择到最后一级”和“选择结果显示层级路径”。 请选择:设置输入框中默认显示的值,字段没有配置值时,会取默认值。 宽度:字段配置框宽度占页面宽度的比例。
  • 添加应用模板 登录圆桌,在页面右上角单击“模板市场”,进入“模板市场”页面。 在“模板中心”页签,选择并订阅应用模板,具体订阅模板操作请参见订阅模板。 如果添加当前租户内构建的且已上架到模板中心的模板,无需订阅,跳过2,直接执行3。 在“应用中心”页签,添加应用模板到主题内,具体操作可参见将模板添加到主题。 上架中心:当前租户内的开发者在轻应用构建平台构建的且已上架到模板中心的应用模板。 订阅中心:当前租户在模板中心订阅的圆桌预置的和其他租户构建的应用模板。 模板添加成功后,您可以在圆桌对应主题内查看并使用该应用模板创建事件。
  • 响应示例 状态码: 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" }
  • 请求示例 导入CA证书,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificate-authorities/4c0e772e-a30c-4029-b929-b7acb04143f7/import { "certificate" : "-----BEGIN CERTIFICATE---******----END CERTIFICATE-----", "certificate_chain" : "-----BEGIN CERTIFICATE-----**********-----END CERTIFICATE-----" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,参见: IAM token获取方法。 表3 请求Body参数 参数 是否必选 参数类型 描述 certificate 是 String 证书内容。 最小长度:1 最大长度:32768 certificate_chain 否 String 证书链内容。 最小长度:0 最大长度:2097152
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表7 响应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" }
  • 响应示例 状态码: 200 请求已成功 { "total" : 2, "certificate_authorities" : [ { "signature_algorithm" : "SHA384", "issuer_id" : null, "issuer_name" : null, "not_after" : 1678159435000, "not_before" : 1646623375000, "status" : "ACTIVED", "freeze_flag" : 0, "gen_mode" : "GENERATE", "serial_number" : "202203070322544291829058", "distinguished_name" : { "country" : "cn", "state" : "shanghai", "locality" : "shanghai", "organization" : "shanghai", "organizational_unit" : "shanghai", "common_name" : " CS R_123" }, "key_algorithm" : "EC384", "create_time" : 1646623375000, "delete_time" : null, "ca_id" : "a6bbf0be-79f3-4f66-858a-0fdcb96dfcbe", "type" : "ROOT", "path_length" : 7, "crl_configuration" : { "enabled" : false, "obs_bucket_name" : null, "valid_days" : null, "crl_name" : null, "crl_dis_point" : null } }, { "signature_algorithm" : "SHA256", "issuer_id" : null, "issuer_name" : null, "not_after" : 1727492412000, "not_before" : 1632797952000, "status" : "ACTIVED", "freeze_flag" : 0, "gen_mode" : "GENERATE", "serial_number" : "202109280259122080649087", "distinguished_name" : { "country" : "CN", "state" : "Sichuan", "locality" : "Chengdu", "organization" : "Huawei", "organizational_unit" : "CloudBU", "common_name" : "pca-ca" }, "key_algorithm" : "RSA2048", "create_time" : 1632797953000, "delete_time" : null, "ca_id" : "fb7bd6a6-6a11-4a58-8710-a3c0a620aedc", "type" : "ROOT", "path_length" : 7, "crl_configuration" : { "enabled" : false, "obs_bucket_name" : null, "valid_days" : null, "crl_name" : null, "crl_dis_point" : null } } ] } 状态码: 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" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Integer CA证书总数。 certificate_authorities Array of CertificateAuthorities objects CA列表,详情请参见CertificateAuthorities字段数据结构说明。 表4 CertificateAuthorities 参数 参数类型 描述 ca_id String CA证书ID。 最小长度:36 最大长度:36 type String CA类型: ROOT: 根CA SUBORDINATE: 从属CA status String CA证书状态: PENDING : 待激活,此状态下,不可用于签发证书; ACTIVED : 已激活,此状态下,可用于签发证书; DISABLED : 已禁用,此状态下,不可用于签发证书; DELETED : 计划删除,此状态下,不可用于签发证书; EXPIRED : 已过期,此状态下,不可用于签发证书。 path_length Integer CA路径长度。 说明: 注:生成的根CA证书,其路径长度不做限制,但本字段在数据库中统一置为7。从属CA的路径长度在创建时由用户指定,缺省值为0。 最小值:0 最大值:6 issuer_id String 父CA证书ID,即签发此证书的CA证书ID。根CA中,此参数为null。 最小长度:36 最大长度:36 issuer_name String 父CA证书名称。根CA中,此参数为null。 最小长度:1 最大长度:64 key_algorithm String 密钥算法。 signature_algorithm String 签名哈希算法。 freeze_flag Integer 冻结标识: 0 : 非冻结状态; 其它值 : 冻结状态,当前预留。 gen_mode String 证书生成方式: GENERATE : PCA系统生成; IMPORT : 外部导入; CSR : 外部提供CSR,内部CA进行签发,即私钥不在PCA进行托管。 serial_number String 证书序列号。 最小长度:1 最大长度:64 create_time Long 证书创建时间,格式为时间戳(毫秒级)。 delete_time Long 证书删除时间,格式为时间戳(毫秒级)。 not_before Long 证书创建时间,格式为时间戳(毫秒级)。 not_after Long 证书到期时间,格式为时间戳(毫秒级)。 distinguished_name DistinguishedName object 证书名称配置,详情请参见DistinguishedName字段数据结构说明。 crl_configuration ListCrlConfiguration object 证书CRL配置,详情请参见ListCrlConfiguration字段数据结构说明。 enterprise_project_id String 企业项目ID,默认为“0”。 对于开通企业项目的用户,表示资源处于默认企业项目下。 对于未开通企业项目的用户,表示资源未处于企业项目下。 free_quota Integer 免费证书配额。 charging_mode Integer 计费模式: 0 : 包周期; 1 : 按需。 表5 DistinguishedName 参数 参数类型 描述 common_name String 证书通用名称(CN),名称只能由"-"、"_"、" "、"."、","、"*"、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 country String 国家编码,只能由英文组成,长度为2位字符。 最小长度:2 最大长度:2 state String 省市名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 最小长度:1 最大长度:128 locality String 地区名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 最小长度:1 最大长度:128 organization String 组织名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 organizational_unit String 组织单元名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 表6 ListCrlConfiguration 参数 参数类型 描述 enabled Boolean 是否启用CRL发布功能。 true false crl_name String 吊销列表文件名称。 说明: 若用户不指定,系统将默认采用当前证书的父CA ID。 obs_bucket_name String OBS桶名称。 valid_days Integer CRL更新周期,单位为"天"。当启用CRL发布功能,为必填项。 最小值:7 最大值:30 crl_dis_point String 吊销列表分发地址,即对应的OBS桶中的CRL文件地址。 说明: 本参数由程序根据crl_name、obs_bucket_name以及OBS地址进行拼接而成。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • URI GET /v1/private-certificate-authorities 表1 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定查询返回记录条数,默认值10。 最小值:0 最大值:1000 name 否 String CA证书名称(CN)过滤值,用于获取名称中带有特定值的CA证书集合。 最小长度:1 最大长度:64 offset 否 Integer 索引位置,从offset指定的下一条数据开始查询。默认值为0。 最小值:0 status 否 String CA证书状态,通过状态过滤证书集合: PENDING : 待激活,此状态下,不可用于签发证书; ACTIVED : 已激活,此状态下,可用于签发证书; DISABLED : 已禁用,此状态下,不可用于签发证书; DELETED : 计划删除,此状态下,不可用于签发证书; EXPIRED : 已过期,此状态下,不可用于签发证书。 type 否 String CA证书类型: ROOT : 根CA证书 SUBORDINATE : 从属CA证书 sort_key 否 String 排序属性,目前支持以下属性: create_time : 证书创建时间(默认) common_name : 证书名称 type : CA证书类型 not_after : 证书到期时间 sort_dir 否 String 排序方向,支持以下值: DESC : 降序(默认) ASC : 升序
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表7 响应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" }
  • 请求示例 吊销子CA,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificate-authorities/6434f74f-2d13-4e6a-89eb-93ee313f1a43/revoke { "reason" : "KEY_COMPROMISE" }
  • 响应示例 状态码: 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" }
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,参见:IAM token获取方法。 表3 请求Body参数 参数 是否必选 参数类型 描述 reason 否 String 吊销理由,支持以下选项: UNSPECIFIED : 吊销时未指定吊销原因,为默认值; KEY_COMPROMISE : 证书密钥材料泄露; CERTIFICATE_AUTHORITY_COMPROMISE : 颁发路径上,可能存在CA密钥材料泄露; AFFILIATION_CHANGED : 证书中的主体或其他信息已经被改变; SUPERSEDED : 此证书已被取代; CES SATION_OF_OPERATION : 此证书或颁发路径中的实体已停止运营; CERTIFICATE_HOLD : 该证书当前不应被视为有效,预计将来可能会生效; PRIVILEGE_WITHDRAWN : 此证书不再具备其声明的属性的权限; ATTRIBUTE_AUTHORITY_COMPROMISE : 担保此证书属性的机构可能已受到损害。 说明: 当不想填写吊销理由时,请求body体请置为"{}",否则将会报异常,默认值为UNSPECIFIED。
  • 响应示例 状态码: 200 请求已成功 { "csr" : "-----BEGIN CERTIFICATE REQUEST-----\r\nMIIBUDCB2AIBADBZMRAwDgYDVQQDDAdDU1IsMTIzMQswCQYDVQQGEwJjbjERMA8G\r\nA1UECAwIc2hhbmdoYWkxETAPBgNVBAcMCHNoYW5naGFpMRIwEAYDVQQKDAlzaGFu\r\nZyxoYWkwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQl9M7bK+vys5x9mnfG3783aPRh\r\nP/xqLPKVsRsqniC3vPZvIz9E7SasMfZLrXVK37QWhtAEtgNG7NrQnwiOye0/8VZL\r\nVX7ildM6CZY4SlJYSa6TBUsXyGjOs514fjxbuT6gADAKBggqhkjOPQQDAgNnADBk\r\nAjBlQiPXU7TDDDwxrh+JfZEYgmr61cIQdE5GMozPDYime30zcuMnVrb9i3o/2BW+\r\n0lECMG0QWbAYh0LoqnmAYqlgTKK8nKsxm0xFuTRyfxynWi8BpCvAGx803Qpa8EJV\r\nJTTjcw==\r\n-----END CERTIFICATE REQUEST-----" } 状态码: 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" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 csr String 证书签名请求内容,有以下两种情况: 通过API请求本接口,证书签名请求中换行符已使用"\r\n"代替; 通过console端导出证书签名请求,将得到标准的PEM格式的证书签名请求文件。 最小长度:1 最大长度:4096 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表8 响应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" }
  • 响应参数 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 order_id String 订单号。 最小长度:1 最大长度:64 ca_ids Array of strings 当前购买的CA证书ID列表。 最小长度:1 最大长度:64 状态码: 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
  • 响应示例 状态码: 200 请求已成功 { "order_id" : "CS1803192259ROA8U", "ca_ids" : [ "4284547e-68ef-4a94-adea-9df1e5d8ad65", "211c079c-bab8-41af-8948-c5e2531232c6" ] } 状态码: 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" }
  • 请求示例 创建CA订单,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificate-authorities/order { "cloud_service_type" : "hws.service.type.ccm", "period_type" : 2, "period_num" : 1, "charging_mode" : 0, "is_auto_renew" : 0, "is_auto_pay" : 0, "promotion_info" : "", "enterprise_project_id" : "0", "product_infos" : [ { "cloudServiceType" : "hws.service.type.ccm", "resourceType" : "hws.resource.type.pca.duration", "resourceSpecCode" : "ca.duration" } ], "subscription_num" : 1 }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,参见:IAM token获取方法。 表2 请求Body参数 参数 是否必选 参数类型 描述 cloud_service_type 是 String 云服务类型,固定为'hws.service.type.ccm' 最小长度:1 最大长度:64 charging_mode 是 Integer 计费模式 0包周期 period_type 是 Integer 订购周期 2月 3年 period_num 是 Integer 订购周期数 is_auto_renew 是 Integer 是否自动续费 1是 0否 promotion_info 否 String 折扣信息 最小长度:0 最大长度:2048 subscription_num 是 Integer 订购数量 is_auto_pay 否 Integer 是否自动支付 1是 0否 不填默认为0 enterprise_project_id 否 String 企业项目ID 最小长度:1 最大长度:64 product_infos 是 Array of ProductInfo objects 产品列表,详情请参见ProductInfo字段数据结构说明。 数组长度:0 - 10 表3 ProductInfo 参数 是否必选 参数类型 描述 cloud_service_type 是 String 云服务类型,固定为'hws.service.type.ccm' 最小长度:1 最大长度:64 resource_type 是 String 资源类型,CA为"hws.resource.type.pca.duration" 最小长度:1 最大长度:64 resource_spec_code 是 String 资源规格编码,CA为"ca.duration" 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Integer 私有证书总数。 最小值:0 最大值:1000000 certificates Array of Certificates objects 证书列表,详情请参见Certificates字段数据结构说明。 数组长度:0 - 1000 表4 Certificates 参数 参数类型 描述 certificate_id String 私有证书ID。 最小长度:36 最大长度:36 status String 证书状态: ISSUED : 已签发; EXPIRED : 已过期; REVOKED : 已吊销。 issuer_id String 父CA证书ID。 最小长度:36 最大长度:36 issuer_name String 父CA证书名称。 最小长度:1 最大长度:64 key_algorithm String 密钥算法。 signature_algorithm String 签名算法。 freeze_flag Integer 冻结标识: 0 : 非冻结状态; 其它值 : 冻结状态,当前预留。 gen_mode String 证书生成方式: GENERATE : PCA系统生成; IMPORT : 外部导入; CSR : 外部提供CSR,内部CA进行签发,即私钥不在PCA进行托管。 serial_number String 序列号。 最小长度:1 最大长度:64 create_time Long 证书创建时间,格式为时间戳(毫秒级)。 delete_time Long 证书删除时间,格式为时间戳(毫秒级)。 not_before Long 证书创建时间,格式为时间戳(毫秒级)。 not_after Long 证书到期时间,格式为时间戳(毫秒级)。 distinguished_name DistinguishedName object 证书名称配置,详情请参见DistinguishedName字段数据结构说明。 enc_cert_info EncCertInfo object 加密证书信息,详情请参见EncCertInfo字段数据结构说明。 enterprise_project_id String 企业项目ID,默认为“0”。 对于开通企业项目的用户,表示资源处于默认企业项目下。 对于未开通企业项目的用户,表示资源未处于企业项目下。 表5 DistinguishedName 参数 参数类型 描述 common_name String 证书通用名称(CN),名称只能由"-"、"_"、" "、"."、","、"*"、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 country String 国家编码,只能由英文组成,长度为2位字符。 最小长度:2 最大长度:2 state String 省市名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 最小长度:1 最大长度:128 locality String 地区名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 最小长度:1 最大长度:128 organization String 组织名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 organizational_unit String 组织单元名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 表6 EncCertInfo 参数 参数类型 描述 enc_serial_number String 加密证书序列号。 最小长度:1 最大长度:64 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码: 200 请求已成功 { "total" : 2, "certificates" : [ { "signature_algorithm" : "SHA256", "issuer_id" : "ef5d84d1-4f52-47d2-b1c8-a91a672487a0", "issuer_name" : "12", "not_after" : 1665539214000, "not_before" : 1634295475000, "status" : "ISSUED", "freeze_flag" : 0, "gen_mode" : "GENERATE", "serial_number" : "202110151057541266081861", "distinguished_name" : { "country" : "cn", "state" : "guizhou", "locality" : "guiyang", "organization" : "hw", "organizational_unit" : "IT", "common_name" : "test.huawei.com" }, "key_algorithm" : "RSA4096", "create_time" : 1634295475000, "delete_time" : null, "certificate_id" : "6434f74f-2d13-4e6a-89eb-93ee313f1a43", "enc_cert_info" : { "enc_serial_number" : "2ad6c3e393a95bf13f95" } }, { "signature_algorithm" : "SHA256", "issuer_id" : "ef5d84d1-4f52-47d2-b1c8-a91a672487a0", "issuer_name" : "12", "not_after" : 1665539214000, "not_before" : 1634110315000, "status" : "ISSUED", "freeze_flag" : 0, "gen_mode" : "GENERATE", "serial_number" : "202110130731541908887138", "distinguished_name" : { "country" : "cn", "state" : "sichuan", "locality" : "chengdu", "organization" : "hw", "organizational_unit" : "HR", "common_name" : "hr.huawei.com" }, "key_algorithm" : "RSA4096", "create_time" : 1634110316000, "delete_time" : null, "certificate_id" : "1cbb5a52-806b-469c-b182-7446e1851a1c", "enc_cert_info" : { "enc_serial_number" : "448ad305b90e0a266e9" } } ] } 状态码: 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" }
  • URI GET /v1/private-certificates 表1 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 指定查询返回记录条数,默认值10。 最小值:0 最大值:1000 name 否 String 私有证书名称,返回名称带有name字段的证书集合。 最小长度:1 最大长度:64 offset 否 Integer 索引位置,从offset指定的下一条数据开始查询。 最小值:0 status 否 String 私有证书状态,通过状态过滤证书集合。 ISSUED : 已签发; REVOKED : 已吊销; EXPIRED : 已过期。 sort_key 否 String 排序属性,目前支持以下属性: create_time : 证书创建时间(默认) common_name : 证书名称 issuer_name : 签发CA名称 not_after : 证书到期时间 sort_dir 否 String 排序方向,支持以下值: DESC : 降序(默认) ASC : 升序
  • 响应示例 状态码: 200 请求已成功 { "signature_algorithm" : "SHA384", "issuer_id" : "928bd666-e879-448a-ab54-82f6ae3d81e0", "issuer_name" : "Huawei IT Root CA", "not_after" : 1647567892000, "not_before" : 1645148632000, "status" : "ACTIVED", "freeze_flag" : 0, "gen_mode" : "CSR", "serial_number" : "202202180143522338893611", "distinguished_name" : { "country" : "CN", "state" : "guangdong", "locality" : "shenzhen", "organization" : "Huawei", "organizational_unit" : "IT", "common_name" : "Huawei IT Root CA" }, "key_algorithm" : "RSA", "create_time" : 1645148633000, "delete_time" : null, "ca_id" : "4c0e772e-a30c-4029-b929-b7acb04143f7", "type" : "SUBORDINATE", "path_length" : 0, "crl_configuration" : { "enabled" : false, "obs_bucket_name" : null, "valid_days" : null, "crl_name" : null, "crl_dis_point" : null } } 状态码: 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" }
共100000条