All Products
Search
Document Center

Alibaba Cloud Service Mesh:DescribeIstioGatewayDomains

Last Updated:Mar 05, 2024

Queries a list of the domain names that are exposed by a 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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ServiceMeshIdstringYes

The ASM instance ID.

c08ba3fd1e6484b0f8cc1ad8fe10d****
IstioGatewayNamestringNo

The name of the ASM gateway.

ingressgateway
NamespacestringNo

The namespace in which the ASM gateway resides.

default
LimitstringNo

The maximum number of Istio gateways to query.

10

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

31d3a0f0-07ed-4f6e-9004-1804498c****
GatewaySecretDetailsobject []

The domain names that are exposed by the ASM gateway.

Domainsarray

The list of domain names.

string

The domain name.

example.com
Protocolstring

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

HTTPS
CredentialNamestring

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

bookinfo-secret
Detailstring

The details of the domain name in the JSON format.

{ "servers": [ { "port": { "number": 27018, "name": "mongo", "protocol": "MONGO" }, "hosts": [ "*" ] } ] }
PortNamestring

The port name.

https-demo
Namespacestring

The namespace in which the ASM gateway resides.

default
GatewayCRNamestring

The name of the Istio gateway.

ingressgateway

Examples

Sample success responses

JSONformat

{
  "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",
      "GatewayCRName": "ingressgateway"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-05-25The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.