GetClassificationTemplate API Reference - Data Management - Alibaba Cloud - Data Management

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetClassificationTemplate

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	integer	Yes	The ID of the instance. You can call the ListInstances or GetInstance operation to query the instance ID.	169****
Tid	integer	No	The ID of the tenant. Note To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	23***

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which you can use to query logs and troubleshoot issues.	427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
ClassificationResourceTemplateMap	object	The classification template associated with the instance.
TemplateId	integer	The ID of the classification and grading template.	3***
TemplateType	string	The type of the classification and grading template. Valid values: INNER: a built-in template. USER_DEFINE: a custom template. Valid values: USER_DEFINE : USER_DEFINE INNER : INNER	INNER
ResourceId	integer	The resource ID. The resource type is INSTANCE, so this value corresponds to InstanceId. You can call the ListInstances operation to query this value.	24****
ResourceType	string	The resource type. The value is fixed to INSTANCE.	INSTANCE
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "ClassificationResourceTemplateMap": {
    "TemplateId": 0,
    "TemplateType": "INNER",
    "ResourceId": 0,
    "ResourceType": "INSTANCE"
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.