All Products
Search
Document Center

AnalyticDB:DescribeApsHiveWorkload

Last Updated:Nov 10, 2025

Queries the information about an AnalyticDB Pipeline Service (APS) job from a Hive data 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
adb:DescribeApsHiveWorkloadnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

amv-*******
WorkloadIdstringYes

The job ID.

aps-******
RegionIdstringNo

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters

RequestIdstring

The request ID.

86F92D26-B774-5FA1-8E53-******
ApsWorkloadobject

The queried job.

RegionIdstring

The region ID.

cn-hangzhou
DBClusterIdstring

The cluster ID.

amv-*******
WorkloadIdstring

The job ID.

aps-******
WorkloadNamestring

The name of the workload.

test
ResourceGroupstring

The resource group to which the SQL statement belongs.

test
FullComputeUnitstring

The number of AnalyticDB compute units (ACUs) required for migration.

16
SyncAllowExpressionstring

The expression that manually matches the source database table whitelist.

abc
SyncDenyExpressionstring

Manually match the blacklist expressions for source database tables.

def
TargetTypestring

The destination type.

OSS
OssLocationstring

The Object Storage Service (OSS) URL of the AnalyticDB for MySQL cluster data.

oss://******
ConflictStrategystring

The policy to handle tables with the same name in the destination cluster.

Intercept
AdvancedConfigstring

The advanced configurations.

test.adv.config=value
DatasourceIdlong

The data source ID.

8
DatasourceNamestring

The name of the data source.

sls-******
Parallelismlong

The number of tasks that are allowed in parallel.

2
WorkloadTypeNamestring

The name of the workload.

test
Statestring

The status of the workload.

COMPLETED
CreateTimestring

The time when the workload was created.

-
MetaStoreUristring

The URL of the Hive Metastore.

-
Vswitchstring

The name of the vSwitch.

vsw-******
EmrClusterIdstring

The ID of the E-MapReduce (EMR) cluster.

-

Examples

Sample success responses

JSONformat

{
  "RequestId": "86F92D26-B774-5FA1-8E53-******",
  "ApsWorkload": {
    "RegionId": "cn-hangzhou",
    "DBClusterId": "amv-*******",
    "WorkloadId": "aps-******",
    "WorkloadName": "test",
    "ResourceGroup": "test",
    "FullComputeUnit": 16,
    "SyncAllowExpression": "abc",
    "SyncDenyExpression": "def",
    "TargetType": "OSS",
    "OssLocation": "oss://******",
    "ConflictStrategy": "Intercept",
    "AdvancedConfig": "test.adv.config=value",
    "DatasourceId": 8,
    "DatasourceName": "sls-******",
    "Parallelism": 2,
    "WorkloadTypeName": "test",
    "State": "COMPLETED",
    "CreateTime": "-",
    "MetaStoreUri": "-",
    "Vswitch": "vsw-******",
    "EmrClusterId": "-"
  }
}

Error codes

HTTP status codeError codeError message
400InvalidInputThe specified parameter is invalid.

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