All Products
Search
Document Center

AnalyticDB:ModifyApsDatasoure

Last Updated:Nov 10, 2025

Modifies an AnalyticDB Pipeline Service (APS) data source.

Operation description

  • You can call this operation only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition that have 32 cores or more.
  • You cannot modify the number of nodes for the USER_DEFAULT resource group.

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
adb:ModifyApsDatasoureupdate
*DBClusterLakeVersion
acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

amv-*******
RegionIdstringYes

The region ID.

cn-shanghai
DatasourceIdlongYes

The data source ID.

1
DatasourceNamestringNo

The name of the data source.

sls-******
DatasourceDescriptionstringNo

The description of the data source.

test
SlsInfoobjectNo

The information about Simple Log Service (SLS).

SourceRegionIdstringNo

The region ID.

cn-beijing
AcrossbooleanNo

Specifies whether to use a cross-account resource as the data source. Valid values:

  • true
  • false
false
AcrossUidstringNo

The cross-account UID.

123456
AcrossRolestringNo

The name of the cross-account role.

test-role
KafkaInfoobjectNo

The information about the Kafka instance.

KafkaClusterIdstringNo

The ID of the Kafka instance.

-
KafkaTopicstringNo

The topic of the Kafka instance.

test-topic
LakehouseIdobjectNo

The lakehouse ID.

VswitchstringNo

The name of the vSwitch.

vsw-******
SecurityGroupstringNo

The name of the security group.

sg-******
VpcIdstringNo

The virtual private cloud (VPC) ID.

vpc-******
RdsMysqlInfoobjectNo

The parameter is no longer supported.

UserNamestringNo

The parameter is no longer supported.

-
PasswordstringNo

The parameter is no longer supported.

-
RegionIdstringNo

The parameter is no longer supported.

-
ConnectUrlstringNo

The parameter is no longer supported.

-
PolarDBMysqlInfoobjectNo

The parameter is no longer supported.

UserNamestringNo

The parameter is no longer supported.

-
PasswordstringNo

The parameter is no longer supported.

-
RegionIdstringNo

The parameter is no longer supported.

-
ConnectUrlstringNo

The parameter is no longer supported.

-

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

A3EB3BCD-D974-52D4-B75C-BB06505916CB
Datastring

The returned data.

150
HttpStatusCodestring

The response code. The status code 200 indicates that the request was successful.

200
Successstring

Indicates whether the request was successful. Valid values:

  • true
  • false
True
Codestring

The HTTP status code or the error code.

InvalidInput
Messagestring

The returned message. Valid values:

  • If the request was successful, a success message is returned.****
  • If the request failed, an error message is returned.
OK

Examples

Sample success responses

JSONformat

{
  "RequestId": "A3EB3BCD-D974-52D4-B75C-BB06505916CB",
  "Data": 150,
  "HttpStatusCode": 200,
  "Success": "True",
  "Code": "InvalidInput\n",
  "Message": "OK"
}

Error codes

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