CertificateGetOrganizationList - 获取信息模板列表--证书中心-火山引擎

文档中心

立即注册

导航

CertificateGetOrganizationList - 获取信息模板列表

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

调用本接口获取已有信息模板列表。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
OrganizationIds	Array of String	否	org-879f6502723b4e0f8762cf3528f4****	要查询的信息模板的ID。
OrganizationType	String	否	Enterprise	要查询的信息模板的类型。该参数有以下取值： `Individual`：个人类型模板 `Enterprise`：企业类型模板
Tag	String	否	doc-test	要查询的信息模板的名称。
ProjectName	String	否	default	要查询的信息模板所属火山引擎项目。
PageNumber	Integer	否	1	设置要返回的页码。默认值：1。
TagFilters	Array of Object	否		标签过滤器，用于查找绑定了指定标签的信息模板。
PageSize	Integer	否	10	设置每页包含信息模板的数量。默认值：10。最大值：100。

返回参数

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

参数	类型	示例值	描述
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	每页包含信息模板的数量。
TotalCount	Integer	1	符合条件的信息模板总数。
Organizations	Array of Object		信息模板详情。

请求示例

POST /?Action=CertificateGetOrganizationList&Version=2024-10-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241031T065642Z
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

{
    "PageSize": 10,
    "pageNumber": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20241108172436E00484B0612B22051C8A",
        "Action": "CertificateGetOrganizationList",
        "Version": "2024-10-01",
        "Service": "certificate_service",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "Organizations": [
            {
                "OrganizationID": "org-5d6ea5d9a0ed41b8a01aeefce7f9****",
                "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	InvalidParameter	The specified parameter %s is invalid.	指定的参数值无效。
500	InternalError	The request has failed due to an unknown error.	未知错误。