You need to enable JavaScript to run this app.
导航
服务器迁移中心
  • 文档首页
    • /
  • 服务器迁移中心

TagResources

最近更新时间：2024.03.26 14:17:58

首次发布时间：2024.02.01 17:16:53

我的收藏

调用TagResources接口，为指定的SMC迁移源、迁移任务创建并绑定标签。

请求参数

名称类型是否必填示例值描述
ActionString是TagResources要执行的操作，取值：TagResources。
VersionString是2020-04-01API的版本，取值： 2020-04-01。

ResourceIds.N

String

是

ResourceIds.1=job-3tiegs1y963vj0****&ResourceIds.2=job-4segs15yts2ls****

资源ID。

  • 参数 - N：表示资源的序号，取值范围：1～50。
  • 多个资源之间用&分隔。

ResourceType

String

是

migrationjob

资源类型，取值：

  • migrationsource：迁移源。
  • migrationjob：迁移任务。

Tags.N.Key

String

是

Tags.1.Key=k1&Tags.2.Key=k2

为资源添加的用户标签的标签键。

  • 参数 - N：表示标签键的序号，取值范围：1～20。
  • 多个标签键之间用&分隔。
    命名规则如下：
  • 不能以任何大小写形式的volc:、sys:开头。

    volc:、sys开头为系统预留标签键禁止创建。

  • 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
  • 长度限制在1～128个字符之间。

Tags.N.Value

String

否

Tags.1.Value=v1&Tags.2.Value=v2

为资源添加的用户标签的标签值。

  • 参数 - N：表示标签值的序号，取值范围：1～20。
  • 多个标签值之间用&分隔。
    命名规则如下：
  • 只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。
  • 允许为空，长度限制在0～256个字符之间。

ClientToken

String

否

333456899ff****

保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
取值：仅支持ASCII字符，且不能超过64个字符。

返回数据

名称类型示例值描述
OperationDetailsArray of Struct-操作详情，具体请参见下表“OperationDetails 结构”。

OperationDetails 结构

名称类型示例值描述
ErrorStruct-操作的资源错误信息，具体请参见下表“Error 结构”。
ResourceIdStringjob-3tiegs1y963vj0****操作的资源ID。

Error 结构

名称类型示例值描述
CodeStringInvalidResourceId.NotFound批量操作时具体单个请求失败的错误码，具体请参见下表“ 错误码（批量操作时具体单个请求失败）”。
MessageStringThe specified ResourceId does not exist.批量操作时具体单个请求失败的错误信息，具体请参见下表“ 错误码（批量操作时具体单个请求失败）”中的错误信息。

错误码（批量操作时具体单个请求失败）

错误码错误信息描述
InvalidResourceIds.NotFoundThe specified resourceids do not exist.指定的资源不存在。
InvalidActionOrVersionCould not find operation %s for version %s.请求接口不存在。

请求示例

GET /?Action=TagResources&Version=2020-04-01&ResourceType=migrationjob&ResourceIds.1=job-3tiegs1y963vj0****&ResourceIds.2=job-4segs15yts2ls****&Tags.1.Key=key1&Tags.2.Key=k2&Tags.1.Value=v1&Tags.2.Value=2 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: smc

返回示例

{
    "ResponseMetadata":{
        "RequestId":"202306021637410F150Dxxxxx",
        "Action":"TagResources",
        "Version":"2020-04-01",
        "Service":"smc",
        "Region":"cn-beijing"
    },
    "Result":{
        "OperationDetails":[
            {
                "Error":null,
                "ResourceId":"job-3tiegs1y963vj0****"
            },
            {
                "Error":{
                    "Code":"InvalidResourceId.NotFound",
                    "Message":"The specified ResourceId does not exist."
                },
                "ResourceId":"job-4segs15yts2ls****"
            }
        ]
    }
}

错误码

HttpCode错误码错误信息描述
400InvalidResourceIds.NotFoundThe specified resourceids do not exist.指定的资源不存在。
400InvalidTagValue.MalformedThe specified TagValue is malformed.指定的标签的值不合法。
400LimitExceeded.MaximumResourceIdsYou've reached the limit on the number of ResourceIds that you can set.指定的资源ID数量超过最大限制。
400LimitExceeded.MaximumTagsYou've reached the limit on the number of tags that you can create.指定的标签数量超过最大限制。
404InvalidActionOrVersionCould not find operation %s for version %s.请求接口不存在。
409InvalidTagKey.ConflictThe specified TagKey already exists.指定的标签键已存在。