Queries the domain names that are exposed by 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 DescribeIstioGatewayDomains

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

ServiceMeshId String Yes c08ba3fd1e6484b0f8cc1ad8fe10d****

The ID of the ASM instance.

IstioGatewayName String No ingressgateway

The name of the ASM gateway.

Namespace String No default

The namespace in which the ASM gateway resides.

Limit String No 10

The maximum number of ASM gateways to query.

Response parameters

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

The ID of the request.

GatewaySecretDetails Array of gatewaySecretDetail

The domain names that are exposed by the ASM gateway.

Domains Array of String example.com

The domain name.

Protocol String HTTPS

The type of the protocol. Valid values: HTTP, HTTPS, GRPC, HTTP2, MONGO, TCP, and TLS.

CredentialName String bookinfo-secret

The name of the secret that contains the Transport Layer Security (TLS) certificate and certificate authority (CA) certificate.

Detail String null

The details of the domain name in the JSON format.

PortName String https-demo

The name of the port.

Namespace String default

The namespace in which the ASM gateway resides.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeIstioGatewayDomains
&ServiceMeshId=c08ba3fd1e6484b0f8cc1ad8fe10d****
&IstioGatewayName=ingressgateway
&Namespace=default
&Limit=10
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeIstioGatewayDomainsResponse>
    <RequestId>31d3a0f0-07ed-4f6e-9004-1804498c****</RequestId>
    <GatewaySecretDetails>
        <Domains>example.com</Domains>
        <Protocol>HTTPS</Protocol>
        <CredentialName>bookinfo-secret</CredentialName>
        <Detail>{   "servers": [     {       "port": {         "number": 27018,         "name": "mongo",         "protocol": "MONGO"       },       "hosts": [         "*"       ]     }   ] }</Detail>
        <PortName>https-demo</PortName>
        <Namespace>default</Namespace>
    </GatewaySecretDetails>
</DescribeIstioGatewayDomainsResponse>

JSON format 

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

{
  "RequestId" : "31d3a0f0-07ed-4f6e-9004-1804498c****",
  "GatewaySecretDetails" : {
    "Domains" : "example.com",
    "Protocol" : "HTTPS",
    "CredentialName" : "bookinfo-secret",
    "Detail" : "{   \"servers\": [     {       \"port\": {         \"number\": 27018,         \"name\": \"mongo\",         \"protocol\": \"MONGO\"       },       \"hosts\": [         \"*\"       ]     }   ] }",
    "PortName" : "https-demo",
    "Namespace" : "default"
  }
}

Error codes

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