阅读本文，您可以获取 Python SDK 证书管理的接口调用示例，实现快速开发。
说明
本文的调用示例包含接口的部分参数。由于参数间可能存在互斥关系，在调用时，请您参考注释，进行调整。
调用接口前，请先完成 Python SDK 的安装及初始化操作。
本节为您介绍证书管理相关接口的功能和调用示例。
您可以调用 CreateCert 接口添加证书。详细的参数说明可参见 CreateCert 接口文档。
接口调用示例如下所示。
# coding:utf-8 import os from volcengine.live.v20230101.live_service import LiveService if __name__ == "__main__": # 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。 # 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY service = LiveService( "live.volcengineapi.com", os.environ["VOLC_ACCESSKEY"], os.environ["VOLC_SECRETKEY"], ) body = { # 证书名称。 "CertName": "pushCertName", # 证书链 ID，用于标识整个证书链，包括叶子证书（服务器证书）、中间证书（中间 CA 证书）以及根证书（根 CA 证书）。 "ChainID": "9*********a982edf6e84bba1f", # 证书信息。 "Rsa": { # 证书私钥。 "Prikey": "*******", # 证书公钥。 "Pubkey": "*******", }, # 证书用途，默认为 https，取值及含义如下所示。 # <li> https：用于 HTTPS 加密； </li> # <li> sign：用于签名加密。 </li> "UseWay": "https", # 项目名称，默认值为 default，您可以登录[访问控制](https://console.volcengine.com/iam/resourcemanage/project)获取项目名称。 "ProjectName": "default", } resp = service.create_cert(body) print(resp)
您可以调用 DeleteCert 接口删除证书。详细的参数说明可参见 DeleteCert 接口文档。
接口调用示例如下所示。
# coding:utf-8 import os from volcengine.live.v20230101.live_service import LiveService if __name__ == "__main__": # 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。 # 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY service = LiveService( "live.volcengineapi.com", os.environ["VOLC_ACCESSKEY"], os.environ["VOLC_SECRETKEY"], ) body = { # 待删除的 HTTPS 证书的证书链 ID，可以通过[查询证书列表](https://www.volcengine.com/docs/6469/1126822)接口获取。 "ChainID": "be37f7c23b514c4987f486*******1f", } resp = service.delete_cert(body) print(resp)
您可以调用 BindCert 接口绑定证书。详细的参数说明可参见 BindCert 接口文档。
接口调用示例如下所示。
# coding:utf-8 import os from volcengine.live.v20230101.live_service import LiveService if __name__ == "__main__": # 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。 # 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY service = LiveService( "live.volcengineapi.com", os.environ["VOLC_ACCESSKEY"], os.environ["VOLC_SECRETKEY"], ) body = { # 需要绑定的 HTTPS 证书的证书链 ID，可以通过[查询证书列表](https://www.volcengine.com/docs/6469/1126822)接口获取。 "ChainID": "be37f********c487f486244759821f", # 填写需要配置 HTTPS 证书的域名。 您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看需要绑定证书的域名。 "Domain": "push.example.com", # 是否启用 HTTPS 协议，默认值为 false，取值及含义如下所示。 # <li> false：关闭； </li> # <li> true：启用。 </li> "HTTPS": False, # HTTPS 证书支持的最大 TLS 协议版本，默认为空，可选值如下所示。 # <li> TLSv1.0 </li> # <li> TLSv1.1 </li> # <li> TLSv1.2 </li> # <li> TLSv1.3 </li> "MaxTLSVersion": "TLSv1.3", # HTTPS 证书支持的最小 TLS 版本，默认值为 TLSv1.2，可选值如下所示。 # <li> TLSv1.0 </li> # <li> TLSv1.1 </li> # <li> TLSv1.2 </li> # <li> TLSv1.3 </li> "MinTLSVersion": "TLSv1.2", } resp = service.bind_cert(body) print(resp)
您可以调用 UnbindCert 接口解绑证书。详细的参数说明可参见 UnbindCert 接口文档。
接口调用示例如下所示。
# coding:utf-8 import os from volcengine.live.v20230101.live_service import LiveService if __name__ == "__main__": # 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。 # 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY service = LiveService( "live.volcengineapi.com", os.environ["VOLC_ACCESSKEY"], os.environ["VOLC_SECRETKEY"], ) body = { # 填写需要解绑 HTTPS 证书的域名。 您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看需要解绑证书的域名。 "Domain": "push.example.com", } resp = service.unbind_cert(body) print(resp)
您可以调用 DescribeCertDetailSecretV2 接口查看证书详情。详细的参数说明可参见 DescribeCertDetailSecretV2 接口文档。
接口调用示例如下所示。
# coding:utf-8 import os from volcengine.live.v20230101.live_service import LiveService if __name__ == "__main__": # 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。 # 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY service = LiveService( "live.volcengineapi.com", os.environ["VOLC_ACCESSKEY"], os.environ["VOLC_SECRETKEY"], ) body = { # 证书 ID，您可以通过[ListCertV2](https://www.volcengine.com/docs/6469/1126823)接口获取证书 ID。 # note： # 参数 ChainID 与 CertID 传且仅传一个。 "CertID": "812******1", # 证书链 ID，您可以通过[ListcCertV2](https://www.volcengine.com/docs/6469/1126823)接口获取 证书链 ID。 # note： # 参数 ChainID 与 CertID 传且仅传一个。 "ChainID": "188b5c6f6b3c47728418932*******d2", } resp = service.describe_cert_detail_secret_v2(body) print(resp)
您可以调用 ListCertV2 接口查询证书列表。详细的参数说明可参见 ListCertV2 接口文档。
接口调用示例如下所示。
# coding:utf-8 import os from volcengine.live.v20230101.live_service import LiveService if __name__ == "__main__": # 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里，否则可能导致 AccessKey 泄露，威胁您账号下所有资源的安全。 # 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY，来实现 API 访问的身份验证。运行代码示例前，请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY service = LiveService( "live.volcengineapi.com", os.environ["VOLC_ACCESSKEY"], os.environ["VOLC_SECRETKEY"], ) body = { # 证书是否启用，默认值为 true，支持的取值及含义如下所示。 # <li> true：启用证书； </li> # <li> false：禁用证书。 </li> "Available": True, # 域名，查询该域名对应的证书，支持精确查询。默认为空，您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console.volcengine.com/live/main/domain/list)页面，查看域名信息。 "Domain": "live.example.com", # 证书是否过期，默认值为 false，支持的取值及含义如下所示。 # <li> false：查询未过期的证书； </li> # <li> true：查询已过期的证书。 </li> # note： # 查看证书是否过期时，必须同时传入 Available 参数。 "Expiring": False, # 证书名称，支持输入证书名称中的关键字，进行模糊查询. "CertName": "domaincert", } resp = service.list_cert_v2(body) print(resp)