TagResources API を呼び出してリソースにタグを追加 - Resource Management

さまざまな Alibaba Cloud サービスのリソースにタグを追加します。

操作説明

タグはリソースを識別するために使用されます。タグを使用すると、さまざまなディメンションから同じ特性を持つリソースを分類、検索、集約できます。これにより、リソース管理が容易になります。詳細については、「タグの概要」をご参照ください。

タグをサポートする Alibaba Cloud サービスについては、「タグと連携するサービス」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

tag:TagResources

update

*All Resource

*

なし

*:TagResources
vod:TagVodResources
dcdn:TagDcdnResources
ecs:AddTags
rds:AddTagsToResource
slb:AddTags
oss:PutBucketTagging
live:TagLiveResources

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。リソースが集中デプロイされたサービスに属している場合、値を `cn-hangzhou` またはリソースのリージョン ID に設定します。詳細については、「集中デプロイされた Alibaba Cloud サービスのリソースに対するタグ関連操作でサポートされるリージョン」をご参照ください。リソースが集中デプロイされていないサービスに属している場合、値をリソースのリージョン ID に設定します。	cn-hangzhou
RegionId	string	必須	リージョン ID。リソースが集中デプロイされたサービスに属している場合、値を `cn-hangzhou` またはリソースのリージョン ID に設定します。詳細については、「集中デプロイされた Alibaba Cloud サービスのリソースに対するタグ関連操作でサポートされるリージョン」をご参照ください。リソースが集中デプロイされていないサービスに属している場合、値をリソースのリージョン ID に設定します。	cn-hangzhou
Tags	string	必須	タグのキーと値のペア。1～10 個のキーと値のペアを指定できます。複数のタグを指定すると、システムは指定されたリソースにすべてのタグを追加します。制限: タグキーは 1～128 文字の長さである必要があります。タグ値は 1～128 文字の長さである必要があります。タグキーとタグ値は、大文字と小文字を区別します。リソース上の各タグキーには、1 つのタグ値のみを設定できます。既存のタグと同じキーを持つタグを作成すると、既存のタグの値が上書きされます。	{"k1":"v1","k2":"v2"}
ResourceARN	array	必須	リソースの Alibaba Cloud リソース名 (ARN)。	arn:acs:vpc:cn-hangzhou:123456789**:vpc/vpc-bp19dd90tkt6tz7wu**
	string	任意	リソースの ARN。 N の有効な値: 1～50。形式: `arn:acs:${ProductCode}:${Region}:${Account}:${ResourceType}/${ResourceId}`。フィールド: `ProductCode`: サービスコード。このフィールドには、ListSupportResourceTypes 操作の応答から取得した値を設定できます。 `Region`: リソースのリージョン ID。このフィールドには、現在リージョンを示すアスタリスク () を設定できます。 `Account`: リソースが属する Alibaba Cloud アカウントの ID。このフィールドには、現在 Alibaba Cloud アカウントを示すアスタリスク () を設定できます。 `ResourceType`: リソースタイプ。このフィールドには、ListSupportResourceTypes 操作の応答から取得した値を設定できます。 `ResourceId`: リソース ID。説明 ResourceARN の `ProductCode` と `ResourceType` には、リソースグループ、ActionTrail、またはリソースセンターで定義された値を設定できます。	arn:acs:vpc:cn-hangzhou:123456789**:vpc/vpc-bp19dd90tkt6tz7wu**

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	返された結果。
RequestId	string	リクエスト ID。	72086426-9F8C-4A60-852B-864048FD1199
FailedResources	object
FailedResource	array<object>	タグの追加に失敗したリソースに関する情報。説明すべてのリソースにタグが追加された場合、`FailedResources` の値は空です。一部またはすべてのリソースにタグの追加が失敗した場合、`FailedResources` の値にはリソースに関する詳細情報が含まれます。
	array<object>	タグの追加に失敗したリソースに関する情報。
ResourceARN	string	リソースの ARN。	arn:acs:vpc:cn-hangzhou:123456789**:vpc/vpc-bp19dd90tkt6tz7wu**
Result	object	エラーに関する情報。
Code	string	エラーコード。	InvalidResourceId.NotFound
Message	string	エラーメッセージ。	The specified ResourceIds are not found in our records.

例

成功レスポンス

JSONJSON

{
  "RequestId": "72086426-9F8C-4A60-852B-864048FD1199",
  "FailedResources": {
    "FailedResource": [
      {
        "ResourceARN": "arn:acs:vpc:cn-hangzhou:123456789****:vpc/vpc-bp19dd90tkt6tz7wu****",
        "Result": {
          "Code": "InvalidResourceId.NotFound",
          "Message": "The specified ResourceIds are not found in our records."
        }
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidResourceARN.Region	The Region specified in the ResourceARN parameter does not match the RegionId parameter, specifically: %s.
400	InvalidResourceARN.Account	The Account specified in the ResourceARN parameter does not match the actual account, specifically: %s.
400	InvalidResourceARN.FormatError	The format of parameter ResourceARN: %s is not valid, for the correct format, you can refer to the Recommend.
400	InvalidParameter.ResourceType	The parameter resource type: %s in ResourceARN is not valid or not support.
400	InvalidParameter.ServiceCode	The parameter service code: %s in ResourceARN is not valid or not support.
400	InvalidParameter.TagKey	The TagKey parameter is invalid. The following TagKeys are invalid: %s.
400	InvalidParameter.TagValue	The TagValue parameter is invalid. The following TagValues are invalid: %s.
400	InvalidParameter.Tags	The Tags parameter cannot be empty, and JSON parsing should adhere to the format of a Map.
403	Duplicate.TagKey	The Tag.N.Key contains duplicate keys.	The Tag.N.Key contains duplicate keys.
403	InvalidParameter.Category	The specified Category is invalid. Valid values are Custom and System.	The specified Category is invalid. Valid values are Custom and System.
403	MissingParameter.Createby	You must specify Createby.	You must specify Createby.
403	MissingParameter.ResourceIds	You must specify ResourceIds.	You must specify ResourceIds.
403	NoPermission.Operator	The user is not authorized to operate on the specified resource.	The user is not authorized to operate on the specified resource.
403	NoPermissionKey.Category	Some keys cannot be modified because the user does not have permission.	Some keys cannot be modified because the user does not have permission.
403	NoPermissionKey.Operator	You are not authorized to operate the tag key.	You are not authorized to operate the tag key.
403	NumberExceed.ResourceIds	The maximum number of ResourceIds is exceeded.	The maximum number of ResourceIds is exceeded.
403	NumberExceed.Tags	The maximum number of Tags is exceeded.	The maximum number of Tags is exceeded.
403	QuotaExceed.TagsPerResource	The maximum number of tags for each resource is exceeded.	The maximum number of tags for each resource is exceeded.
404	Missing.TagKey	Tag.N.Value has been specified and you must specify Tag.N.Key.	Tag.N.Value has been specified and you must specify Tag.N.Key.
404	MissingParameter.AliUid	You must specify AliUid.	You must specify AliUid.
404	MissingParameter.Bid	You must specify Bid.	You must specify Bid.
404	MissingParameter.TagKey	You must specify TagKey.	You must specify TagKey.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。