Skip to content

UpdateFileTag

Updates the tags for a specified file.

Operation description

  • A RAM User (sub-account) must be granted the required API permissions for Alibaba Cloud Model Studio (the AliyunBailianDataFullAccess policy, which includes the sfm:UpdateFileTag permission) and join a workspace before calling this operation. An Alibaba Cloud account (main account) can call this operation directly without authorization. We recommend using the latest version of the Alibaba Cloud Model Studio SDK to call this operation.

Throttling: Do not call this operation more than 5 times per second. If a request is throttled, try again later.

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.

ActionAccess levelResource typeCondition keyDependent action
sfm:UpdateFileTagupdate*All Resource *NoneNone

Request syntax

HELPCODEESCAPE-plaintext
PUT /{WorkspaceId}/datacenter/file/{FileId} HTTP/1.1

Path Parameters

ParameterTypeRequiredDescriptionExample
WorkspaceIdstringYesThe ID of the workspace that contains the file. For instructions on obtaining the ID, see How to use workspaces.llm-3z7uw7fwz0vxxxx
FileIdstringYesThe ID of the file. You can obtain the ID from the application data page by clicking the ID icon next to the file name.file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

Request parameters

ParameterTypeRequiredDescriptionExample
TagsarrayYes- The list of tags to associate with the file. You can specify a maximum of 100 tags. The combined length of all tag values cannot exceed 700 characters.
stringNoThe value of a tag. Each tag can be up to 32 characters long. Supported characters include Unicode letters (such as English and Chinese characters), digits, underscores (_), and hyphens (-). A tag cannot contain spaces.标签A

Response elements

ElementTypeDescriptionExample
objectThe response body.
CodestringThe result code. A value of Success indicates that the request was successful.Success
DataobjectThe data returned.
FileIdstringThe ID of the file.file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
MessagestringThe response message.Requests throttling triggered.
RequestIdstringThe request ID.35A267BF-xxxx-54DB-8394-AA3B0742D833
StatusstringThe status code.200
SuccessbooleanIndicates whether the request was successful. Valid values: - true: The request was successful. - false: The request failed.true

Examples

Success response

JSON format

HELPCODEESCAPE-json
{
  "Code": "Success",
  "Data": {
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx"
  },
  "Message": "Requests throttling triggered.",
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Status": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

Mirror of Alibaba Cloud Model Studio docs for reference and RAG. Not affiliated with Alibaba Cloud.