All Products
Search
Document Center

Alibaba Cloud Service Mesh:DescribeImportedServicesDetail

Last Updated:Jan 07, 2025

Queries the details of the imported services on a Service Mesh (ASM) gateway.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
servicemesh:DescribeImportedServicesDetailget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ServiceMeshIdstringYes

The ASM instance ID.

cb8963379255149cb98c8686f274x****
ASMGatewayNamestringNo

The name of the ASM gateway.

ingressgateway
ServiceNamespacestringNo

The namespace in which the services reside.

default

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

E0496204-7586-5B4C-B364-2361CC0EDxxxx
Detailsarray<object>

The details of the services.

detailobject
ServiceNamestring

The name of a service.

productpage
Namespacestring

The namespace in which the service resides.

default
Labelsobject

The labels of the service.

string

The label of the service.

app: productpage
ClusterIdsarray

The clusters on the data plane.

clusterIdstring

The IDs of the clusters to which the service belongs.

c7894c929677643a5bfe1a732d778****
ServiceTypestring

The type of the service.

Kubernetes
Portsarray<object>

The ports declared for the service.

portobject
Namestring

The name of a port.

http-0
Protocolstring

The protocol of the port.

tcp
Portinteger

The port number.

80
TargetPortinteger

The container port.

8080
NodePortinteger

The node port.

12345

Examples

Sample success responses

JSONformat

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

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

Change history

Change timeSummary of changesOperation
No change history