All Products
Search
Document Center

Server Load Balancer:DescribeServerCertificates

Last Updated:Mar 14, 2024

Queries the server certificates in a region.

Operation description

Note For security reasons, only fingerprints and names of the server certificates are returned. The content of the server certificates and private keys is not returned.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
slb:DescribeServerCertificatesLIST
  • certificate
    acs:slb:{#regionId}:{#accountId}:certificate/*
  • slb:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region where the CLB instances are deployed.

You can call the DescribeRegions operation to query the most recent region list.

Note If the endpoint of the region is slb.aliyuncs.com, you must specify the RegionId parameter.
cn-hangzhou
ServerCertificateIdstringNo

The ID of the server certificate.

12315790*******_166f8204689_1714763408_709981430
ResourceGroupIdstringNo

The ID of the resource group.

rg-atstuj3rtop****
Tagobject []No

The tags.

KeystringNo

The tag key.

test
ValuestringNo

The tag value.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

365F4154-92F6-4AE4-92F8-7FF34B540710
ServerCertificatesobject []

The list of server certificates.

CreateTimeStamplong

The timestamp generated when the server certificate is uploaded.

1504147745000
AliCloudCertificateNamestring

The name of the server certificate from Alibaba Cloud Certificate Management Service.

testcertkey
ExpireTimestring

The expiration time.

2023-01-26T23:59:59Z
CreateTimestring

The time when the server certificate is uploaded.

2021-08-31T02:49:05Z
ServerCertificateIdstring

The ID of the server certificate.

123157********_166f8204689_1714763408_709981430-cn-east-hangzhou-02
ExpireTimeStamplong

The timestamp that indicates when the certificate expires.

15041477450
RegionIdstring

The ID of the region where the server certificate is created.

cn-hangzhou
ServerCertificateNamestring

The name of the server certificate.

slb
Fingerprintstring

The fingerprint of the server certificate.

68:08:1a:f8:2c:97:69:a3:a1:e6:16:41:4b:ca:4f:5d:ee:a5:ef:0d
CommonNamestring

The domain name of the certificate. The domain name is specified in the CommonName field.

www.example.com
ResourceGroupIdstring

The ID of the resource group.

rg-atstuj3rtop****
IsAliCloudCertificateinteger

Indicates whether the server certificate is from Alibaba Cloud Certificate Management Service. Valid values:

  • 1: yes
  • 0: no
0
AliCloudCertificateIdstring

The ID of the server certificate from Alibaba Cloud Certificate Management Service.

7309********_15d97e7709a_71445759hr_789289731
Tagsobject []

The tags.

TagValuestring

The tag value.

1
TagKeystring

The tag keys of the resource.

test
SubjectAlternativeNamesarray

The list of alternative domain names of the server certificate. The alternative domain names are specified in the Subject Alternative Name field of the server certificate.

string

The alternative domain names are specified in the Subject Alternative Name field of the server certificate.

["demo.aliyundoc.com","example.aliyundoc.com"]

Examples

Sample success responses

JSONformat

{
  "RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "ServerCertificates": {
    "ServerCertificate": [
      {
        "CreateTimeStamp": 1504147745000,
        "AliCloudCertificateName": "testcertkey",
        "ExpireTime": "2023-01-26T23:59:59Z",
        "CreateTime": "2021-08-31T02:49:05Z",
        "ServerCertificateId": "123157********_166f8204689_1714763408_709981430-cn-east-hangzhou-02",
        "ExpireTimeStamp": 15041477450,
        "RegionId": "cn-hangzhou",
        "ServerCertificateName": "slb",
        "Fingerprint": "68:08:1a:f8:2c:97:69:a3:a1:e6:16:41:4b:ca:4f:5d:ee:a5:ef:0d",
        "CommonName": "www.example.com",
        "ResourceGroupId": "rg-atstuj3rtop****",
        "IsAliCloudCertificate": 0,
        "AliCloudCertificateId": "7309********_15d97e7709a_71445759hr_789289731",
        "Tags": {
          "Tag": [
            {
              "TagValue": "1",
              "TagKey": "test"
            }
          ]
        },
        "SubjectAlternativeNames": {
          "SubjectAlternativeName": [
            "[\"demo.aliyundoc.com\",\"example.aliyundoc.com\"]"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400Abs.ServerCertificateIdAndResourceGroupId.MissMatchServerCertificateId or ResourceGroupId miss match.
400LocationServiceTimeoutLocation service connection timeout. Please try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2023-07-04The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2023-07-04The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Tag