CertificateGetOrganization - 查询信息模板--证书中心-火山引擎

文档中心

立即注册

导航

CertificateGetOrganization - 查询信息模板

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

调用本接口查询指定信息模板的内容。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
OrganizationId	String	是	org-879f6502723b4e0f8762cf3528f4****	要查询的信息模板的ID。您可以调用CertificateGetOrganizationList接口获取所有信息模板的ID。
ProjectName	String	否	default	要查询的信息模板所属火山引擎项目。

返回参数

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

参数	类型	示例值	描述
CreatedTime	String	2025-01-06 19:11:43	信息模板的创建时间。
OrganizationId	String	org-879f6502723b4e0f8762cf3528f4****	信息模板的ID。
Account	String	210000XXXX	火山引擎账号ID。
Tag	String	doc-test-updated	信息模板名称。
Name	String	测试企业	企业名称。
Department	String	系统部	企业部门。
PostalCode	String	100080	企业所在地的邮政编码。（仅适用于中国地区。）
Address	String	北京市海淀区某街道某号	企业地址。
City	String	北京	企业所在城市。
Province	String	北京	企业所在省份或州。
Country	String	CN	企业所属国家的 ISO 3166-1 代码。
Email	String	doc-test@example.com	企业邮箱。
BusinessLicenseNo	String	11100000000000000R	企业统一社会信用码。
Contact	Object		联系人信息。
ProjectName	String	default	信息模板所属火山引擎项目。
Tags	Array of Object		信息模板已绑定的标签信息。

请求示例

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

{
    "OrganizationId": "org-879f6502723b4e0f8762cf3528f4****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241108171724C7B066ECAA7D42054AE0",
        "Action": "CertificateGetOrganization",
        "Version": "2024-10-01",
        "Service": "certificate_service",
        "Region": "cn-beijing"
    },
    "Result": {
        "OrganizationID": "org-879f6502723b4e0f8762cf3528f4****",
        "Account": "210000XXXX",
        "Tag": "doc-test-updated",
        "Type": "Enterprise",
        "Name": "测试企业",
        "Department": "系统部",
        "PostalCode": "100080",
        "Address": "北京市海淀区某街道某号",
        "City": "北京",
        "Province": "北京",
        "Country": "CN",
        "Email": "doc-test@example.com",
        "BusinessLicenseNo": "11100000000000000R",
        "Contact": {
            "FirstName": "三",
            "LastName": "张",
            "Email": "zhangsan@example.com",
            "Phone": "13111111111",
            "IdCardNo": "310000202010202020"
        },
        "Tags": null,
        "ProjectName": "default",
        "CreatedTime": "2025-01-06 19:11:43"
    }
}

错误码

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

状态码	错误码	错误信息	说明
400	MalformedRequest	The request is malformed	请求参数格式不合法。
400	MissingParameter	The required parameter %s is missing.	缺少必填参数。
400	NotFound. InformationTemplate	The specified information template is not found	指定的信息模板不存在。
500	InternalError	The request has failed due to an unknown error.	未知错误。