幫助中心
首頁 Certificate Management Service 開發參考 API參考（SSL認證） API目錄 訂閱執行個體 GetInstanceDetail

GetInstanceDetail

更新時間：
Copy as MD
產品

查詢執行個體詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

  • 操作：是指具體的許可權點。

  • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

  • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

    • 對於必選的資源類型，用前面加 * 表示。

    • 對於不支援資源級授權的操作，用全部資源表示。

  • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

  • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-cert:GetInstanceDetail

get

*All Resource

*

 無 無

請求參數

名稱

類型

必填

描述

樣本值
InstanceId

string

是

執行個體的 ID。

cas_dv-cn-123

返回參數

名稱

類型

描述

樣本值

object

InstanceId

string

執行個體的 ID。

cas_dv-cn-123
InstanceType

string

執行個體類型，BUY：正式憑證；TEST：測試憑證。

TEST
RequestId

string

本次呼叫請求的 ID，是由阿里雲為該請求生成的唯一識別碼，可用於排查和定位問題。

B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9
KeyAlgorithm

string

憑證演算法。

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • ECC_256

  • SM2。

RSA_2048
Status

string

執行個體狀態。

  • inactive：待使用

  • pending：審核中，最新憑證提交審核中

  • willExpire：執行個體即將過期

  • expired：執行個體已經過期

  • refund：已退款

  • normal：正常

  • closed：已關閉，不可使用。

inactive
Domain

string

憑證綁定的網域。

example.com
CertificateId

integer

憑證 ID。

1234567890
CertificateName

string

執行個體的名稱，簽發憑證時則作為憑證的預設名稱。

123
CertIdentifier

string

全域憑證 ID，格式為憑證 Id + "-" + 站點 regionId，常用在阿里雲各個雲端產品中。 --國內站為憑證 Id + "-cn-hangzhou" 國際站為憑證 Id + "-ap-southeast-1" 例如憑證 Id = 123，則國內站 CertIdentifier = "123-cn-hangzhou"，國際站 CertIdentifier = "123-ap-southeast-1"。

22783111-cn-hangzhou
Spec

string

購買的執行個體規格。

ss.dv.t
CertificateType

string

憑證的類型。取值：DV、OV、EV。

DV
CertificateStatus

string

憑證的狀態。

  • issued：已簽發

  • revoked：已吊銷

  • willExpire：即將過期

  • expired：已過期。

issued
CertificateNotAfter

integer

最新憑證的結束時間，時間戳。未簽發憑證則為空。

1801324800000
CertificateNotBefore

integer

OrderEndTime

integer

執行個體購買時的結束時間，時間戳，用來判斷執行個體的購買時長。

1801324800000
InstanceStartTime

integer

執行個體的開始時間，時間戳。如果未簽發過憑證，則返回空。

1801324800000
InstanceEndTime

integer

執行個體的到期時間，時間戳。如果未簽發過憑證，則返回空。

1801324800000
FullDomainCount

integer

精準網域數量。

1
WildcardDomainCount

integer

萬用字元網域的數量。

0
CompanyId

integer

公司資訊 ID。

47305
ContactIdList

array

聯絡人 ID 列表。

integer

聯絡人 ID。

123
ResourceGroupId

string

資源群組 ID。

rg-aek****wia
DomainValidationList

array<object>

驗證網域列表。

object

驗證網域。

Domain

string

要驗證的網域。

example.com
RootDomain

string

根網域。

example.com
ValidationType

string

驗證類型，TXT、HTTP、CNAME。

TXT
ValidationValue

string

驗證主機記錄值。

123
ValidationKey

string

主機記錄。

@
Cname

string

免驗證授權的 Cname 記錄值。可能返回空。

123.com
CnameKey

string

CNAME 驗證時的前綴。

abc
City

string

購買憑證的使用者所屬的公司或組織所在的城市。生成 CSR 時需要該欄位。預設為 Beijing。

Beijing
Province

string

公司所在省份或者地區。生成 CSR 時需要該欄位，預設為 Beijing。

Beijing
CountryCode

string

設定憑證組織機構所在國家或地區的代碼。例如，CN 表示中國，US 表示美國。生成 CSR 時需要該欄位，預設為 CN。

CN
Csr

string

PEM 格式的憑證請求。

-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----
ValidationMethod

string

申請憑證驗證方式。

  • DNS：DNS 驗證方式，TXT 或者 CNAME。

  • HTTP：檔案驗證方式。

DNS
AverageWaitingTime

string

簽發該規格憑證平均等待時長，單位秒。

120
DingGroupList

array<object>

關聯的專家服務釘釘群列表。

object

關聯的專家服務釘釘群。

DingGroupInstanceId

string

專家服務釘釘群執行個體 ID。

123
DingGroupName

string

專家服務釘釘群名稱。

123
DingGroupType

string

專家服務釘釘群類型。

  • expedite 協助申請

  • remote 線下部署。

remote
DingGroupUrl

string

專家服務釘釘群入群連結。

https://123.com
Tags

array<object>

標籤列表。

object

標籤列表。

TagKey

string

標籤 Key。

test
TagValue

string

標籤值。

test
GenerateCsrMethod

string

CSR 生成方式。

  • online：系統生成，則會忽略 Csr 欄位。

  • upload：未開啟，使用者上傳，則要求 Csr 為必填。

online
AutoReissue

string

是否開啟自動託管。

  • enable：開啟

  • disable：未開啟。

enable
PendingResult

string

最後一次操作憑證時，CA 返回的結果。

pending
UpgradeStatus

string

執行個體升級狀態。

  • none：執行個體未升級

  • payed：執行個體升級已經付款

  • issued：執行個體升級已簽發最新憑證。

none
CertificateRevokeTime

integer

最新一張憑證吊銷時間，時間戳。

1801324800000
Brand

string

CA 品牌。WoSign、CFCA、DigiCert、GeoTrust、GlobalSign、vTrus、Alibaba。

DigiCert
OrderStartTime

integer

執行個體購買時的開始時間，時間戳，用來判斷退款時間限制。

1801324800000

樣本

正常返回樣本

JSON格式

{
  "InstanceId": "cas_dv-cn-123",
  "InstanceType": "TEST",
  "RequestId": "B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9",
  "KeyAlgorithm": "RSA_2048",
  "Status": "inactive",
  "Domain": "example.com",
  "CertificateId": 1234567890,
  "CertificateName": "123",
  "CertIdentifier": "22783111-cn-hangzhou",
  "Spec": "ss.dv.t",
  "CertificateType": "DV",
  "CertificateStatus": "issued",
  "CertificateNotAfter": 1801324800000,
  "CertificateNotBefore": 0,
  "OrderEndTime": 1801324800000,
  "InstanceStartTime": 1801324800000,
  "InstanceEndTime": 1801324800000,
  "FullDomainCount": 1,
  "WildcardDomainCount": 0,
  "CompanyId": 47305,
  "ContactIdList": [
    123
  ],
  "ResourceGroupId": "rg-aek****wia",
  "DomainValidationList": [
    {
      "Domain": "example.com",
      "RootDomain": "example.com",
      "ValidationType": "TXT",
      "ValidationValue": "123",
      "ValidationKey": "@",
      "Cname": "123.com",
      "CnameKey": "abc"
    }
  ],
  "City": "Beijing",
  "Province": "Beijing",
  "CountryCode": "CN",
  "Csr": "-----BEGIN CERTIFICATE REQUEST-----   ...... -----END CERTIFICATE REQUEST-----",
  "ValidationMethod": "DNS",
  "AverageWaitingTime": "120",
  "DingGroupList": [
    {
      "DingGroupInstanceId": "123",
      "DingGroupName": "123",
      "DingGroupType": "remote",
      "DingGroupUrl": "https://123.com"
    }
  ],
  "Tags": [
    {
      "TagKey": "test",
      "TagValue": "test"
    }
  ],
  "GenerateCsrMethod": "online",
  "AutoReissue": "enable",
  "PendingResult": "pending",
  "UpgradeStatus": "none",
  "CertificateRevokeTime": 1801324800000,
  "Brand": "DigiCert",
  "OrderStartTime": 1801324800000
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。

上一篇：UpdateInstance - 更新執行個體下一篇：DeleteInstance - 刪除執行個體