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

文档中心

立即注册

导航

创建企业信息模板

最近更新时间：2024.07.04 17:00:42首次发布时间：2024.07.04 17:00:42

调用本接口创建一个企业类型的信息模板。

注意事项

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

使用限制

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

请求说明

接口名称：CertificateAddOrganization
请求方式：POST
请求地址：open.volcengineapi.com

调试

暂不支持。

请求参数

下方表格中的参数包含在请求头（header）中。

参数	类型	是否必选	描述	示例值
Region	string	是	服务地区。该参数的取值是`cn-north-1`。	`cn-north-1`
ServiceName	string	是	服务名称。该参数的取值是`certificate_service`。	`certificate_service`

Query

下方表格中的参数包含在查询字符串（query string）中。

参数	类型	是否必选	描述	示例值
Action	string	是	API名称。该参数的取值是`CertificateAddOrganization`。	`CertificateAddOrganization`
Version	string	是	API版本。该参数的取值是`2021-06-01`。	`2021-06-01`

Body

下方表格中的参数包含在请求体（request body）中。

参数	类型	是否必选	描述	示例值
tag	String	是	设置模板名称。	`doc-test`
name	String	是	企业名称。	`火山引擎`
address	String	是	企业地址。	`某某路某号`
city	String	是	企业所在城市。	`上海`
province	String	是	企业所在省份或州。	`上海`
country	String	是	企业所在国家。	`中国`
department	String	否	企业部门。	`IT`
postal_code	String	否	企业所在地的邮编。	`200000`
business_license_no	String	否	企业的社会统一信用码。
project	String	否	指定信息模板所属火山引擎项目。若未指定该参数，则该信息模板将被添加到 default（默认项目）。	`default`
contact	Object	是	联系人信息。

返回参数

参数	类型	描述	示例值
Result	string	信息模板ID。	`org-ebb5e757922d4afe9226859cc08ea42a`

请求示例

POST https://open.volcengineapi.com/?Action=CertificateAddOrganization&Version=2021-06-01&<其他公共请求参数>

{
  "contact": {
    "email": "zhangsan@example.com",
    "phone": "13111111111",
    "last_name": "zhang",
    "first_name": "san"
  },
  "project": "default",
  "country": "中国",
  "tag": "doc-test",
  "name": "火山引擎",
  "province": "上海",
  "city": "上海",
  "address": "某某路某号"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240703152059D635C41CCAB02761886F",
        "Action": "CertificateAddOrganization",
        "Version": "2021-06-01",
        "Service": "certificate_service",
        "Region": "cn-north-1"
    },
    "Result": "org-ebb5e757922d4afe9226859cc08ea42a"
}

错误码

如果响应正文的ResponseMetadata字段中包含Error字段，则表示API请求失败。您可访问公共错误码，获取更多错误码信息。

证书中心