All Products
Search
Document Center

Server Migration Center:ListTagResources

Last Updated:Mar 03, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

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****
Tagobject []No

The tags that are attached to SMC resources.

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
TagResourcesobject []

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

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