All Products
Search
Document Center

Microservices Engine:PullServices

Last Updated:Nov 20, 2024

Queries information about services that can be imported from a specified source.

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
mse:PullServicesget
*Gateway
acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceTypestringNo

The type of the service source.

Enumeration Value:
  • k8s: k8s.
  • MSE: MSE.
K8s
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-eccf313e2224438ba53d95d039e5****
NamespacestringNo

The namespace.

public
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

RequestIdstring

The ID of the request.

EC0A99B9-8BA3-5FE3-8FE7-D7C719CF7BD2
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

You are not authorized to perform this operation. Action: mse:PullServices, Resource: acs:mse:cn-shenzhen:1228932054837788:*
Codeinteger

The status code returned.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Dataarray<object>

The returned data.

PullServicesobject

The data structure.

Namespacestring

The namespace.

default
GroupNamestring

The name of the group.

test
Servicesarray<object>

The information about services.

Servicesobject

The data structure.

Namestring

The name of the service.

test
Namespacestring

The namespace.

public
GroupNamestring

The name of the group.

test
SourceIdstring

The ID of the service source.

1
SourceTypestring

The type of the service source.

MSE
NamespaceShowNamestring

The alias of the namespace.

public

Examples

Sample success responses

JSONformat

{
  "RequestId": "EC0A99B9-8BA3-5FE3-8FE7-D7C719CF7BD2",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation. Action: mse:PullServices, Resource: acs:mse:cn-shenzhen:1228932054837788:*",
  "Code": 200,
  "Success": true,
  "Data": [
    {
      "Namespace": "default",
      "GroupName": "test",
      "Services": [
        {
          "Name": "test",
          "Namespace": "public",
          "GroupName": "test",
          "SourceId": "1",
          "SourceType": "MSE"
        }
      ],
      "NamespaceShowName": "public"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400duplicatedClusterAliasNameduplicated cluster alias nameThe instance name is duplicate. User another name.
400illegalRequestillegal request:%sInvalid request: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404clusterNotFoundcluster not foundThe cluster is not found.
500systemErrorsystem errorAn error occurred on the system. Try again later.

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