DescribeIstioGatewayDomains - Alibaba Cloud Service Mesh

Returns a list of gateway domain names.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicemesh:DescribeIstioGatewayDomains

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The ID of the Service Mesh instance.	c08ba3fd1e6484b0f8cc1ad8fe10d****
IstioGatewayName	string	No	The name of the ASM gateway.	ingressgateway
Namespace	string	No	The namespace.	default
Limit	string	No	The maximum number of entries to return.	10

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	31d3a0f0-07ed-4f6e-9004-1804498c****
GatewaySecretDetails	array<object>	A list of gateway domain name details.
	object	The details of a gateway domain name.
Domains	array	A list of domain names.
	string	The domain name.	example.com
Protocol	string	The protocol. Valid values: `HTTP`, `HTTPS`, `GRPC`, `HTTP2`, `MONGO`, `TCP`, and `TLS`.	HTTPS
CredentialName	string	The name of the secret that contains the Transport Layer Security (TLS) certificate and the certificate authority (CA) certificate.	bookinfo-secret
Detail	string	The detailed information in JSON format.	{ "servers": [ { "port": { "number": 27018, "name": "mongo", "protocol": "MONGO" }, "hosts": [ "*" ] } ] }
PortName	string	The name of the port.	https-demo
Namespace	string	The namespace.	default
GatewayCRName	string	The name of the gateway custom resource (CR).	ingressgateway

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.