GetInstanceDetail-阿里云帮助中心

Queries the details of an instance.

Operation description

Queries the status information of a Private Certificate Authority (PCA) instance that you purchased through the SSL Certificate Service console by using the instance ID. The information includes the instance status, the total number of certificates, and the number of issued certificates.

Before you invoke this operation, you must purchase a private CA through the digital certificate management service console. For more information, see Purchase a private CA.

QPS limit

The QPS limit for a single user is 10 invocations per second. If the limit is exceeded, API invocations are throttled, which may affect your services. Invoke this operation at a reasonable frequency.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cert:GetInstanceDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	cas_dv-cn-123

The InstanceId is obtained from ListInstances after you purchase a certificate plan through BSS. You must first complete the purchase in the Certificate Management Service console or through the BSS API. For instance IDs in the cas-upload-* format, you must call the UploadUserCertificate operation to upload the certificate and obtain the instance ID.

Response elements

Element	Type	Description	Example
	object
AutoReissue	string	Specifies whether automatic hosting is enabled. Valid values: enable: Enabled. disable: Disabled.	enable
AutoReissueFlag	integer	Specifies whether the current version includes automatic hosting. Valid values: 1: Included. 0: Not included.	1
AverageWaitingTime	string	The average waiting time for issuing a certificate of this specification, in seconds.	120
Brand	string	The CA brand. Valid values: WoSign, CFCA, DigiCert, GeoTrust, GlobalSign, vTrus, and Alibaba.	DigiCert
CertIdentifier	string	The global certificate ID. The format is Certificate ID + "-" + Site region ID. This ID is commonly used across Alibaba Cloud services. For the Chinese site, the format is Certificate ID + "-cn-hangzhou". For the international site, the format is Certificate ID + "-ap-southeast-1". For example, if the certificate ID is 123, the CertIdentifier for the Chinese site is "123-cn-hangzhou", and for the international site, it is "123-ap-southeast-1".	22783111-cn-hangzhou
CertificateId	integer	The ID of the certificate.	1234567890
CertificateName	string	The name of the instance. When a certificate is issued, this name is used as the default name of the certificate.	123
CertificateNotAfter	integer	The expiration time of the latest certificate. The value is a UNIX timestamp accurate to seconds. If no certificate is issued, this parameter is empty.	1801324800000
CertificateNotBefore	integer	The start time of the latest certificate. The value is a UNIX timestamp accurate to seconds. If no certificate is issued, this parameter is empty.	1781568000000
CertificateRevokeTime	integer	The revocation time of the latest certificate. The value is a UNIX timestamp accurate to seconds.	1801324800000
CertificateStatus	string	The status of the certificate. Valid values: issued: Issued. revoked: Revoked. willExpire: Expiring soon. expired: Expired.	issued
CertificateType	string	The type of the certificate. Valid values: DV, OV, and EV.	DV
City	string	The city where the company or organization of the user who purchased the certificate is located. This field is required when generating a CSR. Default value: Beijing.	Beijing
CompanyId	integer	The ID of the company information.	47305
ContactIdList	array	The list of contact IDs.
	integer	The ID of the contact.	123
CountryCode	string	The code of the country or region where the organization specified in the certificate is located. For example, CN indicates China, and US indicates the United States. This field is required when generating a CSR. Default value: CN.	CN
Csr	string	The certificate signing request in PEM format.	-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----
DeploymentResourceCount	integer	The number of deployed cloud service resources.	30
DeploymentUseCount	integer	The used quota for deployment to cloud servers.	30
DingGroupList	array<object>	The list of associated DingTalk groups for expert services.
	object	The associated DingTalk group for expert services.
DingGroupInstanceId	string	The instance ID of the DingTalk group for expert services.	123
DingGroupName	string	The name of the DingTalk group for expert services.	123
DingGroupType	string	The type of the DingTalk group for expert services. Valid values: expedite: Application assistance. remote: Offline deployment.	remote
DingGroupUrl	string	The link to join the DingTalk group for expert services.	https://123.com
Domain	string	The domain name bound to the certificate.	example.com
DomainValidationList	array<object>	The list of domain names to be validated.
	object	The domain name to be validated.
Cname	string	The CNAME record value for verification-free authorization. This parameter may be empty.	123.com
CnameKey	string	The prefix used for CNAME validation.	abc
Domain	string	The domain name to be validated.	example.com
RootDomain	string	The root domain name.	example.com
ValidationKey	string	The host record.	@
ValidationType	string	The validation type. Valid values: TXT, HTTP, and CNAME.	TXT
ValidationValue	string	The value of the host record for validation.	123
FullDomainCount	integer	The number of exact domain names.	1
GenerateCsrMethod	string	The method used to generate the CSR. Valid values: online: Generated by the system. The Csr field is ignored. upload: Uploaded by the user. The Csr field is required.	online
InstanceEndTime	integer	The expiration time of the instance. The value is a UNIX timestamp accurate to seconds. If no certificate has been issued, this parameter is empty.	1801324800000
InstanceId	string	The ID of the instance.	cas_dv-cn-123
InstanceStartTime	integer	The start time of the instance. The value is a UNIX timestamp accurate to seconds. If no certificate has been issued, this parameter is empty.	1801324800000
InstanceType	string	The type of the instance. Valid values: BUY: Official certificate. TEST: Test certificate.	TEST
KeyAlgorithm	string	The algorithm of the certificate. Valid values: RSA_2048 RSA_3072 RSA_4096 ECC_256 SM2	RSA_2048
MonitorExpandFlag	integer	Specifies whether the quota for domain name monitoring can be expanded. Valid values: 1: Yes. 0: No.	1
MonitorUseCount	integer	The used quota for domain name monitoring.	10
OrderEndTime	integer	The end time of the instance purchase. The value is a UNIX timestamp used to determine the purchase duration of the instance.	1801324800000
OrderProgress	string	The progress of the order.	{ "orderProgress": [ { "certificateId": 12345, "certificateName": "example.com", "notBefore": 1727000000000, "notAfter": 1735000000000, "stages": [ { "name": "apply", "title": "apply", "status": "completed", "time": 1726990000000 }, { "name": "domainValidation", "title": "domainValidation", "status": "completed", "time": 1727000000000 }, { "name": "issue", "title": "issue", "status": "completed", "time": 1727000000000 } ] } ] }
OrderStartTime	integer	The start time of the instance purchase. The value is a UNIX timestamp accurate to seconds, used to determine the time limit for refunds.	1801324800000
PendingResult	string	The result returned by the CA during the last operation on the certificate.	pending
Province	string	The province or region where the company is located. This field is required when generating a CSR. Default value: Beijing.	Beijing
RequestId	string	The ID of the request. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.	B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9
ResourceGroupId	string	The ID of the resource group.	rg-aek****wia
Spec	string	The specifications of the purchased instance.	ss.dv.t
Status	string	The instance status. Valid values: inactive: Pending use. pending: Under review. The latest certificate is committed for review. willExpire: Expiring soon. expired: Expired. refund: Refunded. normal: Normal. closed: Shutdown and unavailable.	inactive
Tags	array<object>	The list of tags.
	object	The list of tags.
TagKey	string	The key of the tag.	test
TagValue	string	The value of the tag.	test
TotalDeploymentCount	integer	The total quota for deployment to cloud servers.	60
TotalMonitorCount	integer	The total quota for domain name monitoring.	80
UpgradeStatus	string	The upgrade status of the instance. Valid values: none: The instance is not upgraded. payed: The instance upgrade is paid. issued: The latest certificate is issued for the instance upgrade.	none
ValidationMethod	string	The validation method for the certificate application. Valid values: DNS: DNS validation, using TXT or CNAME records. HTTP: File validation.	DNS
VersionType	string	The version type. Valid values: FOTA: System upgrade. APP: Application upgrade.	0
WildcardDomainCount	integer	The number of wildcard domain names.	0

Examples

Success response

JSON format

{
  "AutoReissue": "enable",
  "AutoReissueFlag": 1,
  "AverageWaitingTime": "120",
  "Brand": "DigiCert",
  "CertIdentifier": "22783111-cn-hangzhou",
  "CertificateId": 1234567890,
  "CertificateName": "123",
  "CertificateNotAfter": 1801324800000,
  "CertificateNotBefore": 1781568000000,
  "CertificateRevokeTime": 1801324800000,
  "CertificateStatus": "issued",
  "CertificateType": "DV",
  "City": "Beijing",
  "CompanyId": 47305,
  "ContactIdList": [
    123
  ],
  "CountryCode": "CN",
  "Csr": "-----BEGIN CERTIFICATE REQUEST-----   ...... -----END CERTIFICATE REQUEST-----",
  "DeploymentResourceCount": 30,
  "DeploymentUseCount": 30,
  "DingGroupList": [
    {
      "DingGroupInstanceId": "123",
      "DingGroupName": "123",
      "DingGroupType": "remote",
      "DingGroupUrl": "https://123.com"
    }
  ],
  "Domain": "example.com",
  "DomainValidationList": [
    {
      "Cname": "123.com",
      "CnameKey": "abc",
      "Domain": "example.com",
      "RootDomain": "example.com",
      "ValidationKey": "@",
      "ValidationType": "TXT",
      "ValidationValue": "123"
    }
  ],
  "FullDomainCount": 1,
  "GenerateCsrMethod": "online",
  "InstanceEndTime": 1801324800000,
  "InstanceId": "cas_dv-cn-123",
  "InstanceStartTime": 1801324800000,
  "InstanceType": "TEST",
  "KeyAlgorithm": "RSA_2048",
  "MonitorExpandFlag": 1,
  "MonitorUseCount": 10,
  "OrderEndTime": 1801324800000,
  "OrderProgress": "{\n  \"orderProgress\": [\n    {\n      \"certificateId\": 12345,\n      \"certificateName\": \"example.com\",\n      \"notBefore\": 1727000000000,\n      \"notAfter\": 1735000000000,\n      \"stages\": [\n        { \"name\": \"apply\", \"title\": \"apply\", \"status\": \"completed\", \"time\": 1726990000000 },\n        { \"name\": \"domainValidation\", \"title\": \"domainValidation\", \"status\": \"completed\", \"time\": 1727000000000 },\n        { \"name\": \"issue\", \"title\": \"issue\", \"status\": \"completed\", \"time\": 1727000000000 }\n      ]\n    }\n  ]\n}",
  "OrderStartTime": 1801324800000,
  "PendingResult": "pending",
  "Province": "Beijing",
  "RequestId": "B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9",
  "ResourceGroupId": "rg-aek****wia",
  "Spec": "ss.dv.t",
  "Status": "inactive",
  "Tags": [
    {
      "TagKey": "test",
      "TagValue": "test"
    }
  ],
  "TotalDeploymentCount": 60,
  "TotalMonitorCount": 80,
  "UpgradeStatus": "none",
  "ValidationMethod": "DNS",
  "VersionType": "0",
  "WildcardDomainCount": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.