All Products
Search
Document Center

Server Load Balancer:DescribeServerCertificates

Last Updated:Oct 10, 2024

Queries the server certificates in a region.

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
  • ServerCertificate
    acs:slb:{#regionId}:{#AccountId}:certificate/*
  • slb:tag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region where the CLB instance is deployed.

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

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

The server certificate ID.

12315790*******_166f8204689_1714763408_709981430
ResourceGroupIdstringNo

The resource group ID.

rg-atstuj3rtop****
Tagarray<object>No

The tags.

objectNo

The tags.

KeystringNo

The tag key of the resource. You can specify up to 20 tag keys.

The tag key cannot be an empty string. The tag key must be 1 to 64 characters in length and cannot start with aliyun or acs:. The tag key cannot contain http:// or https://.

test
ValuestringNo

The tag value of the resource. You can specify up to 20 tag values. The tag value cannot be an empty string.

The tag value can be up to 128 characters in length and cannot start with acs: or aliyun. The tag value cannot contain http:// or https://.

1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

365F4154-92F6-4AE4-92F8-7FF34B540710
ServerCertificatesarray<object>

The server certificates.

ServerCertificateobject
CreateTimeStamplong

The timestamp when the server certificate was uploaded.

1504147745000
AliCloudCertificateNamestring

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

testcertkey
ExpireTimestring

The time when the server certificate expires.

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

The time when the server certificate was uploaded.

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

The server certificate ID.

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

The timestamp when the server certificate expires.

15041477450
RegionIdstring

The region ID of the server certificate.

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 server certificate. The domain name is specified in the CommonName field.

www.example.com
ResourceGroupIdstring

The resource group ID.

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
Tagsarray<object>

The tags.

Tagobject

The tag value.

TagValuestring

The tag value.

1
TagKeystring

The tag keys of the resource.

test
SubjectAlternativeNamesarray

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

SubjectAlternativeNamestring

The alternative domain names of the server certificate. 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 changedView Change Details
2023-07-04The Error code has changed. The response structure of the API has changedView Change Details
2023-07-04The Error code has changed. The request parameters of the API has changedView Change Details