Get an Image File

Retrieves the details of an image file.

Request URL

GET {base_url}/uc-cautop/api/v1/image-files/{id}

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The image file ID. You can obtain the ID using the Search Image Files interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Image_File> The details of the image file.
Image_File
Parameter Type Description
id String The unique identifier of the image file.
ucId String The ID of the UC domain that the image file belongs to.
name String The name of the image file, which is unique under the same administrator.
fileName String The original file name of the image file.
fileResourceId String The ID of the file in the resource service.
fileSize String The size of the file, in bytes.
remark String The remark of the image file.
createdAt String The time when the image file was created, in Unix timestamp format (seconds).
updatedAt String The time when the image file was last updated, in Unix timestamp format (seconds).
ownerType String The owner type of the image file: - admin: Administrator. - reseller: Reseller.
ownerId String The ID of the owner.
ownerEmail String The email address of the owner's primary account.
assignTo Object<Assign_To> The assignment configuration of the image file.
Assign_To
Parameter Type Description
myTenantAssignment Object<My_Tenant_Assignment> The assignment configuration for the tenants directly under the administrator.
resellerAssignment Object<Reseller_Assignment> The assignment configuration for resellers.
My_Tenant_Assignment
Parameter Type Description
enabled Boolean Whether the image file is assigned to tenants.
scope String The assignment scope: - all: The image file is visible to all the tenants directly under the administrator. - specific: The image file is visible only to the specified tenants.
tenantCodes Array<String> The codes of the tenants. This parameter takes effect only when scope is specific.
Reseller_Assignment
Parameter Type Description
enabled Boolean Whether the image file is assigned to resellers.
scope String The assignment scope: - all: The image file is visible to all the resellers. - specific: The image file is visible only to the specified resellers.
resellers Array<Reseller_Assign_Item> The list of reseller assignments. This parameter takes effect only when scope is specific.
excludedResellerIds Array<String> The IDs of the excluded resellers. This parameter takes effect only when scope is all.
Reseller_Assign_Item
Parameter Type Description
resellerId String The user ID of the reseller.
tenantScope String The tenant scope under the reseller: - all: The image file is visible to all the tenants of the reseller. - specific: The image file is visible only to the specified tenants. - none: The image file is visible only to the reseller itself.
tenantCodes Array<String> The codes of the tenants. This parameter takes effect only when tenantScope is specific.