DescribeImportedServicesDetail - Alibaba Cloud Service Mesh

Queries the details of services imported into an ASM gateway.

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:DescribeImportedServicesDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The Service Mesh instance ID.	cb8963379255149cb98c8686f274x****
ASMGatewayName	string	No	The name of the gateway.	ingressgateway
ServiceNamespace	string	No	The namespace where the service resides.	default

Response elements

Element	Type	Description	Example
	object	The response content.
RequestId	string	The request ID.	E0496204-7586-5B4C-B364-2361CC0EDxxxx
Details	array<object>	A list of service details.
	object	The details of the service.
ServiceName	string	The name of the service.	productpage
Namespace	string	The namespace where the service resides.	default
Labels	object	A list of labels.
	string	The labels that are defined for the service.	app: productpage
ClusterIds	array	A list of data plane clusters.
	string	The ID of the cluster where the service resides.	c7894c929677643a5bfe1a732d778****
ServiceType	string	The type of the service.	Kubernetes
Ports	array<object>	A list of ports that are declared for the service.
	object	A list of port information.
Name	string	The name of the port.	http-0
Protocol	string	The protocol of the port.	tcp
Port	integer	The port number.	80
TargetPort	integer	The container port.	8080
NodePort	integer	The node port.	12345

Examples

Success response

JSON format

{
  "RequestId": "E0496204-7586-5B4C-B364-2361CC0EDxxxx",
  "Details": [
    {
      "ServiceName": "productpage",
      "Namespace": "default",
      "Labels": {
        "key": "app: productpage"
      },
      "ClusterIds": [
        "c7894c929677643a5bfe1a732d778****"
      ],
      "ServiceType": "Kubernetes",
      "Ports": [
        {
          "Name": "http-0",
          "Protocol": "tcp",
          "Port": 80,
          "TargetPort": 8080,
          "NodePort": 12345
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.