All Products
Search
Document Center

Server Migration Center:ListTagResources

Last Updated:Oct 29, 2024

Queries the tags that are attached to Server Migration Center (SMC) resources. SMC resources include migration sources and migration jobs.

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
smc:ListTagResourcesget
  • ReplicationJob
    acs:smc:{#regionId}:{#AccountId}:replicationjob/{#ReplicationJobId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringYes

The type of the SMC resource. Valid values:

  • sourceserver: migration source.
  • replicationjob: migration job.
sourceserver
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results.

caeba0bbb2be03f84eb48b699f0a4883
ResourceIdarrayNo

The IDs of SMC resources. SMC resources include migration sources and migration jobs. You can specify a maximum of 50 SMC resource IDs.

stringNo

The ID of the SMC resource. SMC resources include migration sources and migration jobs.

s-bp1e2fsl57knvuug****
Tagarray<object>No

The tags that are attached to SMC resources.

objectNo

The tags list.

KeystringNo

The key of tag N. The tag key must be 1 to 64 characters in length. Valid values of N: 1 to 20.

Tag.N is used for exact match of SMC resources to which the tag is attached. Tag N consists of a key-value pair.

  • Tag keys and values are case-sensitive.
  • If you set only the Tag.N.Key parameter, all resources to which the specified tags are attached are returned.
  • If you set only the Tag.N.Value parameter, the error message InvalidParameter.TagValue is returned.
  • If you specify multiple tag key-value pairs at a time, only SMC resources that match all tag key-value pairs are returned.
TestKey
ValuestringNo

The value of tag N. The value must be 1 to 64 characters in length. Valid values of N: 1 to 20.

TestValue

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The pagination token that is used in the next request to retrieve a new page of results.

If NextToken is empty, no next page exists.

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

The request ID.

17743161-66F3-4E7F-B8AE-845FB28B928F
TagResourcesarray<object>

The information about SMC resources and tags, such as the IDs, types, and tag key-value pairs of the resources.

TagResourceobject

The details about the resources and tags, such as the resource ID, the resource type, tag keys, and tag values.

ResourceTypestring

The type of the resource.

ALIYUN::SMC::SOURCESERVER
TagValuestring

The value of the tag that is attached to the resource.

TestValue
ResourceIdstring

The resource ID.

s-bp1e2fsl57knvuug****
TagKeystring

The key of the tag that is attached to the resource.

TestKey

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "17743161-66F3-4E7F-B8AE-845FB28B928F",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "ALIYUN::SMC::SOURCESERVER",
        "TagValue": "TestValue",
        "ResourceId": "s-bp1e2fsl57knvuug****",
        "TagKey": "TestKey"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NumberExceed.TagsThe maximum number of the Tag parameters cannot exceed 20.The maximum number of Tag parameters cannot exceed 20.
400MissingParameter.ResourceTypeYou must specify ResourceType.You must specify ResourceType.
400InvalidResourceType.NotFoundThe specified ResourceType does not exist.The specified ResourceType does not exist.
400NumberExceed.ResourceIdsThe maximum number of ResourceId parameters cannot exceed 50.The maximum number of ResourceId parameters cannot exceed 50.
400Duplicate.ResourceIdThe ResourceId contains duplicate values.The ResourceId contains duplicate values.
400InvalidResourceId.NotFoundThe specified ResourceIds do not exist.The specified ResourceIds do not exist.

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

Change history

Change timeSummary of changesOperation
No change history