Queries the detailed information about a secret of an Alibaba Cloud Service Mesh (ASM) gateway.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeGatewaySecretDetails

The operation that you want to perform. Set the value to DescribeGatewaySecretDetails.

ServiceMeshId String Yes c08ba3fd1e6484b0f8cc1ad8fe10d****

The ID of the ASM instance.

IstioGatewayName String No ingressgateway

The name of the ASM gateway.

Response parameters

Parameter Type Example Description
RequestId String 31d3a0f0-07ed-4f6e-9004-1804498c****

The ID of the request.

GatewaySecretDetails Array of gatewaySecretDetail

The detailed information about the secret of the ASM gateway.

IssueTime String 2022-03-03 07:45

The time when the certificate was issued.

ExpiredTime String 2023-03-03 07:45

The time when the certificate expires.

GatewayName String bookinfo-gateway

The name of the gateway.

State String normal

The status of the certificate. Valid values:

  • normal
  • abnormal
Message String tls.crt not exist
  • An error message is returned if the status of the gateway is abnormal. Examples: tls.crt not exist, tls.key not exist, and secret type must be kubernetes.io/tls.
  • An empty value is returned if the status of the gateway is normal.
SNI String demo.com

The Server Name Indication (SNI) value that indicates the hostname of the service.

SecretName String demo-secret

The name of the secret.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeGatewaySecretDetails
&ServiceMeshId=c08ba3fd1e6484b0f8cc1ad8fe10d****
&IstioGatewayName=ingressgateway
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeGatewaySecretDetailsResponse>
    <RequestId>31d3a0f0-07ed-4f6e-9004-1804498c****</RequestId>
    <GatewaySecretDetails>
        <IssueTime>2022-03-03 07:45</IssueTime>
        <ExpiredTime>2023-03-03 07:45</ExpiredTime>
        <GatewayName>bookinfo-gateway</GatewayName>
        <State>normal</State>
        <Message>tls.crt not exist</Message>
        <SNI>demo.com</SNI>
        <SecretName>demo-secret</SecretName>
    </GatewaySecretDetails>
</DescribeGatewaySecretDetailsResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "31d3a0f0-07ed-4f6e-9004-1804498c****",
  "GatewaySecretDetails" : {
    "IssueTime" : "2022-03-03 07:45",
    "ExpiredTime" : "2023-03-03 07:45",
    "GatewayName" : "bookinfo-gateway",
    "State" : "normal",
    "Message" : "tls.crt not exist",
    "SNI" : "demo.com",
    "SecretName" : "demo-secret"
  }
}

Error codes

For a list of error codes, visit the API Error Center.