You can call ListClusterServiceQuickLink operation to query the shortcut links of a specified service or all services of a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes ListClusterServiceQuickLink

The operation that you want to perform. This parameter is required for API requests that you create by piecing together HTTP or HTTPS URLs. Set the value to ListClusterServiceQuickLink.

ClusterId String Yes C-A15B381E446C****

The ID of the cluster. You can call ListClusters Interface to view the cluster ID.

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call DescribeRegions Interface to view the latest list of Alibaba Cloud regions.

DirectType Boolean No true

A reserved parameter that you do not need to specify.
ServiceName String No SPARK

Service name:

  • SPARK
  • RANGER
  • GANGLIA
  • HDFS
  • YARN

Response parameters

Parameter Type Example Description
QuickLinkList Array of QuickLink

The list of links.
QuickLink
Port String 8443

The service port.
Protocol String https

The connection protocol.
QuickLinkAddress String knox.C-A15B381E446C****.cn-hangzhou.emr.aliyuncs.com:8443/gateway/cluster-topo/sparkhistory/

The URL of the service.
ServiceDisplayName String Spark

The display name of the service.
ServiceName String SPARK

The name of the service.
Type String KNOX

Service type:

  • DEFAULT: includes the HUE and ZEPPELIN services.
Note The HUE and ZEPPELIN services are added to the cluster.
  • KNOX: includes services for YARN, HDFS, SPARK, GANGLIA, and RANGER.
RequestId String 621094BA-8C21-4199-9F04-CA9AA5B63955

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListClusterServiceQuickLink
&ClusterId=C-A15B381E446C****
&RegionId=cn-hangzhou
&<common request parameters>

Sample success responses

XML format 

<RequestId>621094BA-8C21-4199-9F04-CA9AA5B63955</RequestId>
<QuickLinkList>
    <QuickLink>
        <QuickLinkAddress>knox.C-A15B381E446C****.cn-hangzhou.emr.aliyuncs.com:8443/gateway/cluster-topo/sparkhistory/</QuickLinkAddress>
        <Type>KNOX</Type>
        <ServiceName>SPARK</ServiceName>
        <Port>8443</Port>
        <Protocol>https</Protocol>
        <ServiceDisplayName>Spark</ServiceDisplayName>
    </QuickLink>
</QuickLinkList>

JSON Syntax 

{
    "RequestId": "621094BA-8C21-4199-9F04-CA9AA5B63955",
    "QuickLinkList": {
        "QuickLink": [
            {
                "QuickLinkAddress": "knox.C-A15B381E446C****.cn-hangzhou.emr.aliyuncs.com:8443/gateway/cluster-topo/sparkhistory/",
                "Type": "KNOX",
                "ServiceName": "SPARK",
                "Port": "8443",
                "Protocol": "https",
                "ServiceDisplayName": "Spark"
            }
        ]
    }
}

Error codes

HttpCode Error code Error message Description
403 Params.Illegal The specified parameters are wrongly formed.. The error message returned because the format of the specified parameters is invalid.
403 User.OtherUserResource.NotAllow It is not allowed to operate other user's resource The error message returned because you are not authorized to manage the resources of other users.
403 Invalid.Cluster.Status Invalid cluster status %s in status list The error message returned because the specified cluster status is invalid.
403 Invalid.Cluster.Type Invalid cluster type %s in cluster type list The error message returned because the type of the specified cluster is invalid.
500 InternalError The request processing has failed due to some unknown error. The error message returned because the request processing has failed due to an internal error. Submit a ticket.

The port number of a client that accesses a Error CenterFor more information, see error codes.