All Products
Search
Document Center

API Gateway:GetSource

Last Updated:Dec 24, 2025

Obtains the details of a service 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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
apig:GetSourceget
*All Resources
*
    none
none

Request syntax

GET /v1/sources/{sourceId} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
sourceIdstringNo

The request ID.

src-d1596kem1hkv3o72qkdg

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

Id of the request

DE10E3C0-A676-5169-812D-6610AACBFAFF
codestring

The status code.

Ok
messagestring

The response message.

success
dataobject

The response data.

sourceIdstring

The source ID.

src-crdddallhtgt***
namestring

The name.

import-test
k8SSourceInfoobject

Kubernetes source information.

clusterIdstring

The ID of the Container Service for Kubernetes (ACK) cluster.

c2d290b2d8b5d4935864cace5f0173f31
nacosSourceInfoobject

The source information when the source type is MSE_NACOS.

instanceIdstring

The Nacos instance ID.

hgprecn-cn-cfn47q7oh001
clusterIdstring

The cluster ID.

fluss-cn-w7k4hann601
addressstring

The endpoint of the Nacos instance.

mse
createTimestamplong

The creation timestamp.

1719386834548
updateTimestamplong

The update timestamp.

1719386834548
gatewayIdstring

The gateway ID.

gw-cq2vundlhtg***
typestring

The type.

K8S
resourceGroupIdstring

The resource group ID.

rg-aekz4us4iruleja

Examples

Sample success responses

JSONformat

{
  "requestId": "DE10E3C0-A676-5169-812D-6610AACBFAFF",
  "code": "Ok",
  "message": "success",
  "data": {
    "sourceId": "src-crdddallhtgt***",
    "name": "import-test",
    "k8SSourceInfo": {
      "clusterId": "c2d290b2d8b5d4935864cace5f0173f31"
    },
    "nacosSourceInfo": {
      "instanceId": "hgprecn-cn-cfn47q7oh001",
      "clusterId": "fluss-cn-w7k4hann601",
      "address": "mse"
    },
    "createTimestamp": 1719386834548,
    "updateTimestamp": 1719386834548,
    "gatewayId": "gw-cq2vundlhtg***",
    "type": "K8S",
    "resourceGroupId": "rg-aekz4us4iruleja"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-12-11Add OperationView Change Details