CertificateAddOrganization - 创建信息模板--证书中心-火山引擎

文档中心

立即注册

导航

CertificateAddOrganization - 创建信息模板

最近更新时间：2025.01.10 11:56:44首次发布时间：2024.11.13 19:44:18

调用本接口创建一个信息模板。

注意事项

每个租户最多可以拥有200个信息模板（涵盖企业和个人类型的信息模板）。

请求说明

请求频率：同一个租户每秒最多允许请求20次。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	CertificateAddOrganization	要执行的操作，取值：CertificateAddOrganization。
Version	String	是	2024-10-01	API的版本，取值：2024-10-01。

Body

参数	类型	是否必填	示例值	描述
Type	String	是	Enterprise	要创建的信息模板的类型。该参数有以下取值： `Individual`：个人类型模板 `Enterprise`：企业类型模板
Tag	String	是	doc-test	设置信息模板的名称。
Name	String	否	测试企业	设置企业名称。当 Type 为 `Enterprise` 时，该参数必填。
Address	String	否	北京市海淀区某街道某号	设置企业地址。当 Type 为 `Enterprise` 时，该参数必填。
City	String	否	北京	设置企业所在城市。当 Type 为 `Enterprise` 时，该参数必填。
Province	String	否	北京	设置企业所在省份或州。当 Type 为 `Enterprise` 时，该参数必填。
Country	String	否	CN	设置企业所属国家的 ISO 3166-1 代码。当 Type 为 `Enterprise` 时，该参数必填。
PostalCode	String	否	100080	设置企业所在地的邮政编码。（仅适用于中国地区。）
Department	String	否	系统部	设置企业部门。
Email	String	否	doc-test@example.com	设置企业邮箱。
BusinessLicenseNo	String	否	11100000000000000R	设置企业统一社会信用代码。
Contact	Object	是		联系人信息
ProjectName	String	否	default	设置信息模板所属火山引擎项目。若未指定该参数，则信息模板将被添加到 `default`（默认项目）。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
OrganizationID	String	org-879f6502723b4e0f8762cf3528f4****	证书中心为您创建的信息模板生成的ID。

请求示例

POST /?Action=CertificateAddOrganization&Version=2024-10-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241030T094755Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241030/cn-beijing/certificate_service/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
    "Type": "Enterprise",
    "Tag": "doc-test",
    "Name": "测试企业",
    "Address": "北京市海淀区某街道某号",
    "City": "北京",
    "Province": "北京",
    "Country": "CN",
    "PostalCode": "100080",
    "Department": "系统部",
    "Email": "doc-test@example.com",
    "BusinessLicenseNo": "11100000000000000R",
    "Contact": {
        "FirstName": "三",
        "LastName": "张",
        "Email": "zhangsan@example.com",
        "Phone": "13111111111",
        "IdCardNo": "310000202010202020"
    },
    "ProjectName": "default"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241108164818CABBD7F73FC575046E0E",
        "Action": "CertificateAddOrganization",
        "Version": "2024-10-01",
        "Service": "certificate_service",
        "Region": "cn-beijing"
    },
    "Result": {
        "OrganizationID": "org-879f6502723b4e0f8762cf3528f4****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	指定的参数值无效。
400	MissingParameter	The required parameter %s is missing.	缺少必填参数。
400	QuotaExceeded	%s has exceeded the quota. example: The memory size of the specified disk has exceeded the quota.	资源超出配额限制。
404	NotFound.Project	The specified project is not found"	未找到指定的项目。
500	InternalError	The request has failed due to an unknown error.	未知错误。