GetCertificate - 获取指定证书信息

更新时间:
复制为 MD 格式

获取站点下指定证书信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:GetCertificate

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

请求参数

名称

类型

必填

描述

示例值

SiteId

integer

站点 ID,可通过调用 ListSites 接口查询获取。

1234567890123

Id

string

证书 Id。

babaded901474b9693acf530e0fb1d95

返回参数

名称

类型

描述

示例值

object

Schema of Response

SiteId

integer

站点 ID。

1234567890123

SiteName

string

站点名称。

example.com

Status

string

证书状态。

OK

Certificate

string

证书内容。

-----BEGIN CERTIFICATE-----

Result

object

证书信息。

CasId

string

云证书 Id。

30000478

Id

string

证书 Id。

babaded901474b9693acf530e0fb1d95

Name

string

证书名称。

yourCertName

Region

string

地域。

cn-hangzhou

Status

string

证书状态。

OK

Type

string

证书类型。

枚举值:

  • cas :

    云盾证书

  • upload :

    自定义上传证书

  • keyless :

    Keyless 证书

  • free :

    免费证书

free

CommonName

string

证书通用名称 CN 字段。

www.example.com

NotBefore

string

证书有效期的开始时间。

2023-11-26T16:00:00Z

NotAfter

string

证书有效期的截止时间。

2023-11-26T16:00:00Z

Issuer

string

证书发行商。

DigiCert

IssuerCN

string

证书颁发机构。

DigiCert Global Root CA

SAN

string

证书主题备用名。

www.example.com,*.example.com

SigAlg

string

证书签名算法。

ECDSA-SHA1

PubAlg

string

证书公钥算法。

ECDSA

CreateTime

string

创建时间。

2020-05-12 02:00:53

UpdateTime

string

更新时间。

2022-09-22 05:33:13

SerialNumber

string

证书的序列号。

babaded901474b9693acf530e0fb1daa

FingerprintSha256

string

证书 sha256 指纹。

1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66

DCV

array<object>

DCV 信息。

object

DCV 信息。

Id

string

DCV ID。

bababf7cdd1546a2ad04c0def1f4c980

Type

string

DCV 类型。可能值:DNS;HTTP。

枚举值:

  • DNS :

    DNS

  • HTTP :

    HTTP

HTTP

Key

string

DCV 名称。DNS 类型为 TXT 记录名;HTTP 类型为 URL。

http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow

Value

string

DCV 内容。

pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ

Status

string

验证状态。

pending

ApplyCode

integer

证书申请错误码。

2

ApplyMessage

string

证书申请错误信息。

canceled

KeyServerId

string

Keyless server ID,当 Type 为 keyless 时有效。

baba39055622c008b90285a8838e****

RequestId

string

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368

示例

正常返回示例

JSON格式

{
  "SiteId": 1234567890123,
  "SiteName": "example.com ",
  "Status": "OK",
  "Certificate": "-----BEGIN CERTIFICATE-----",
  "Result": {
    "CasId": "30000478",
    "Id": "babaded901474b9693acf530e0fb1d95",
    "Name": "yourCertName",
    "Region": "cn-hangzhou",
    "Status": "OK",
    "Type": "free",
    "CommonName": "www.example.com",
    "NotBefore": "2023-11-26T16:00:00Z",
    "NotAfter": "2023-11-26T16:00:00Z",
    "Issuer": "DigiCert",
    "IssuerCN": "DigiCert Global Root CA",
    "SAN": "www.example.com,*.example.com",
    "SigAlg": "ECDSA-SHA1",
    "PubAlg": "ECDSA",
    "CreateTime": "2020-05-12 02:00:53",
    "UpdateTime": "2022-09-22 05:33:13",
    "SerialNumber": "babaded901474b9693acf530e0fb1daa",
    "FingerprintSha256": "1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66",
    "DCV": [
      {
        "Id": "bababf7cdd1546a2ad04c0def1f4c980",
        "Type": "HTTP",
        "Key": "http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow",
        "Value": "pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ",
        "Status": "pending"
      }
    ],
    "ApplyCode": 2,
    "ApplyMessage": "canceled",
    "KeyServerId": "baba39055622c008b90285a8838e****"
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

错误码

HTTP status code

错误码

错误信息

描述

400 MissingSiteId Required parameter SiteId missing. Specify SiteId and try again. 缺少必填参数SiteId,请指定SiteId参数后重试。
400 InternalException Failed to call the service. Try again later or contact technical support. 调用服务失败,请稍后重试或联系客服咨询详情。
400 Id.MissingParameter The parameter Id is required. 缺少必填参数Id。
403 Unauthorized.InvalidTime The specified authentication time is invalid. 您输入的鉴权时间参数无效,请检查参数值后重试。
403 Unauthorized.InvalidToken Token authentication failed. 您输入的token无效,请检查并输入正确的token后进行重试。
404 Certificate.NotFound The specified certificate does not exist. 指定的证书不存在。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情