ListAllEndEntityInstance - Certificate Management Service

Queries end-entity instances.

Operation description

This operation queries the status of a private Certificate Authority (CA) instance by its ID. It returns details for a private CA instance that you purchased in the Certificate Management Service console. These details include the instance status, the number of certificates it contains, and the number of issued certificates.

Before calling this operation, purchase a private CA from the Certificate Management Service console. For more information, see Purchase a private CA.

QPS limits

The queries per second (QPS) limit for this operation is 10 calls per second for each user. If you exceed the limit, API calls are throttled, which may affect your business. Plan your calls accordingly.

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:ListAllEndEntityInstance

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ParentId	integer	No	The ID of the parent instance.	37633
RecursiveChildren	integer	No	Specifies whether to return information about the billing type in the response. Valid values: -0: The information is not returned. -1: The information is returned.	9
CurrentPage	integer	No	The page number of the instance list.	1
ShowSize	integer	No	The maximum number of entries to display on each page for a paged query.	20
MaxResults	integer	No	The maximum number of entries to return for this call.	20
NextToken	string	No	The token that is used to retrieve the next page of results. You can get this token from the `NextToken` response parameter of the previous query.	1d2db86sca4384811e0b5e8707e68181f

Response elements

Element	Type	Description	Example
	object	OpenApiResponse<PagedResultData<Map<String, Object>>>
RequestId	string	The request ID.	443C05A8-6C16-52B5-BB97-5D8798F7A49A
TotalCount	integer	The total number of records.	23
PageCount	integer	The total number of pages.	1
CurrentPage	integer	The page number of the instance list.	1
ShowSize	integer	The maximum number of entries displayed on each page of a paged query.	10
List	array<object>	The list of instances.
	object	The list of instances.
	any	The details of the end-entity instance.	{ "CurrentYearFreeCertCount": 0, "ParentId": 36739, "Trial": false, "InstanceId": "cas_deposit-cn-XXX", "IssuedCertCount": 29, "Algorithm": "RSA", "Gift": true, "AliasName": "pca-subordinate-XXX", "CertCount": 60, "CurrentYearIssuedFreeCertCount": 0, "Id": 36740, "HistoricalIssuedFreeCertCount": 0, "Detail": { "Identifier": "1f0d426f-8645-62ef-9bd1-XXX", "Organization": "a", "SerialNumber": "XXX", "OrganizationUnit": "a", "SubjectDN": "C=AE,ST=a,L=a,O=a,OU=a,CN=a", "CommonName": "a" } }
NextToken	string	The token that you can use to retrieve the next page of results. If this parameter is empty, all results have been returned.	1d2db86sca4384811e0b5e8707e68181f
MaxResults	integer	The maximum number of entries returned in this call.	20

Examples

Success response

JSON format

{
  "RequestId": "443C05A8-6C16-52B5-BB97-5D8798F7A49A",
  "TotalCount": 23,
  "PageCount": 1,
  "CurrentPage": 1,
  "ShowSize": 10,
  "List": [
    {
      "key": "\n    {\n      \"CurrentYearFreeCertCount\": 0,\n      \"ParentId\": 36739,\n      \"Trial\": false,\n      \"InstanceId\": \"cas_deposit-cn-XXX\",\n      \"IssuedCertCount\": 29,\n      \"Algorithm\": \"RSA\",\n      \"Gift\": true,\n      \"AliasName\": \"pca-subordinate-XXX\",\n      \"CertCount\": 60,\n      \"CurrentYearIssuedFreeCertCount\": 0,\n      \"Id\": 36740,\n      \"HistoricalIssuedFreeCertCount\": 0,\n      \"Detail\": {\n        \"Identifier\": \"1f0d426f-8645-62ef-9bd1-XXX\",\n        \"Organization\": \"a\",\n        \"SerialNumber\": \"XXX\",\n        \"OrganizationUnit\": \"a\",\n        \"SubjectDN\": \"C=AE,ST=a,L=a,O=a,OU=a,CN=a\",\n        \"CommonName\": \"a\"\n      }\n    }\n  "
    }
  ],
  "NextToken": "1d2db86sca4384811e0b5e8707e68181f",
  "MaxResults": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.