文档中心

查询信息模板

最近更新时间：2024.04.19 16:37:27

首次发布时间：2023.10.19 10:52:38

API说明

API名称：CertificateGetOrganization
API域名：open.volcengineapi.com
API描述：调用本接口查询已有的信息模板。

注意

目前您只可以使用证书中心控制台创建信息模板。更多信息，请参见管理信息模板。

请求方法

GET

使用限制

QPS 限制：同一个租户每秒最多允许请求20次。

公共参数

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

参数名称	数据类型	是否必选	参数说明
Region	String	是	服务地区。该参数的取值是`cn-north-1`。
ServiceName	String	是	服务名称。该参数的取值是`certificate_service`。

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

参数名称	数据类型	是否必选	参数说明
Action	String	是	API名称。该参数的取值是`CertificateGetOrganization`。
Version	String	是	API版本。该参数的取值是`2021-06-01`。

请求参数

下方表格中参数的类型是查询参数。

参数名称	数据类型	是否必选	参数说明	示例
organization_id	String	否	设置一个模板ID以按ID查询信息模板。	`org-4d954cd1fe8e487086e67f687f83****`
ov	String	否	设置一个模板类型以按类型查询信息模板。该参数有以下取值：为空：查询全部模板。 `0`：仅查询个人类型的模板。 `1`：仅查询企业类型的模板。	`0`
tag	String	否	设置一个模板名称以按名称查询信息模板。支持模糊匹配。	`doc-test`
project_name	String	否	设置一个火山引擎项目名称，以按信息模板所属的项目查询信息模板。	`default`

响应正文

参数名称	参数类型	参数说明	示例
count	Integer	满足查询条件的信息模板的总数。
content	Array	信息模板详情列表。

示例

请求示例

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

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20231012143611D18B45161E262C169AB5",
        "Action": "CertificateGetOrganizationList",
        "Version": "2021-06-01",
        "Service": "certificate_service",
        "Region": "cn-north-1"
    },
    "Result": {
        "count": 1,
        "content": [
            {
                "id": "org-4d954cd1fe8e487086e67f687f83****",
                "upstream": "volcano",
                "upstream_filter": "21000000XX",
                "ov": 1,
                "tag": "doc-test",
                "project": "default",
                "department": "IT",
                "name": "火山引擎",
                "postal_code": "200000",
                "address": "某某路某号",
                "city": "上海",
                "province": "上海",
                "country": "中国",
                "email": "zhangsan@volcengine.com",
                "phone": "13111111111",
                "bank_account_license_no": "",
                "business_license_no": "",
                "contact": {
                    "first_name": "三",
                    "last_name": "张",
                    "email": "zhangsan@volcengine.com",
                    "phone": "13111111111",
                    "title": "IT负责人",
                    "id_card_no": "111111111111111111"
                },
                "upstream_extension": null,
                "supplier_org": null
            }
        ]
    }
}

错误代码

如果响应正文的ResponseMetadata字段中包含Error字段，则表示API请求失败。关于更多错误码的信息，参见错误码说明。