更新浮动图片 - DingTalk Help Center

调用本接口，可更新钉钉表格中已有浮动图片的属性，包括图片地址、锚点位置和尺寸偏移量。支持部分更新，未传入的字段将保留原值，例如只传 anchor 即可单独调整图片位置而不影响其他属性。适用于调整图片位置、更换图片源或修改展示尺寸等场景。成功后返回更新后的图片完整属性。

请求

基本信息

字段	值
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/floatImages/{id}`
HTTP Method	PUT
支持的应用类型	appType-企业内部应用
权限要求	permission-Document.Workbook.Write-钉钉表格写权限

请求头

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证，可调用获取企业内部应用的accessToken接口获取。

路径参数

名称	类型	是否必填	描述
workbookId	String	是	表格文件 ID ，知识库 API 返回的`nodeId(dentryUuid)`即是表格`workbookId`，可通过调用获取节点和创建知识库文档接口获取。
sheetId	String	是	工作表ID或标题，可调用获取所有工作表接口获取id和工作表的标题。
id	String	是	指定浮动图片 id，可通过「查询浮动图片」接口进行获取。

查询参数

名称	类型	是否必填	描述
operatorId	String	是	操作人的unionId，可调用查询用户详情接口获取。若操作人无权限，接口会报错 `The operator has no permission`。

请求体

名称	类型	是否必填	描述
src	String	否	浮动图片资源地址，需要通过调用获取资源上传信息接口获得 `resourceUrl`。
anchor	Object	否	锚点位置，指定图片固定在哪个单元格。
row	Integer	否	锚点所在行号（从 0 开始）。
col	Integer	否	锚点所在列号（从 0 开始）。
coordinate	Object	否	图片尺寸与相对锚点单元格的偏移量。
width	double	否	图片宽度，单位：像素。
height	double	否	图片高度，单位：像素。
offsetX	double	否	相对锚点单元格左上角的水平偏移量，单位：像素。
offsetY	double	否	相对锚点单元格左上角的垂直偏移量，单位：像素。

请求示例

HTTP

PUT /v1.0/doc/workbooks/xxx/sheets/xxx/floatImages/xxx?operatorId=xxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxx
Content-Type:application/json

{
  "src" : "/core/api/resources/img/xxx",
  "anchor" : {
    "row" : 0,
    "col" : 0
  },
  "coordinate" : {
    "width" : 300.0,
    "height" : 300.0,
    "offsetX" : 8.0,
    "offsetY" : 8.0
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用 Token 初始化账号Client</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkdoc_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageHeaders updateFloatImageHeaders = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageHeaders();
        updateFloatImageHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate coordinate = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate()
                .setWidth(300D)
                .setHeight(300D)
                .setOffsetX(8D)
                .setOffsetY(8D);
        com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor anchor = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor()
                .setRow(0)
                .setCol(0);
        com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest updateFloatImageRequest = new com.aliyun.dingtalkdoc_1_0.models.UpdateFloatImageRequest()
                .setOperatorId("xxx")
                .setSrc("/core/api/resources/img/xxx")
                .setAnchor(anchor)
                .setCoordinate(coordinate);
        try {
            client.updateFloatImageWithOptions("xxx", "xxx", "xxx", updateFloatImageRequest, updateFloatImageHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err 中含有 code 和 message 属性，可帮助开发定位问题
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err 中含有 code 和 message 属性，可帮助开发定位问题
            }

        }        
    }
}

Python

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_dingtalk.doc_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkdoc_1_0Client:
        """
        使用 Token 初始化账号Client
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdoc_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_float_image_headers = dingtalkdoc__1__0_models.UpdateFloatImageHeaders()
        update_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        coordinate = dingtalkdoc__1__0_models.UpdateFloatImageRequestCoordinate(
            width=300,
            height=300,
            offset_x=8,
            offset_y=8
        )
        anchor = dingtalkdoc__1__0_models.UpdateFloatImageRequestAnchor(
            row=0,
            col=0
        )
        update_float_image_request = dingtalkdoc__1__0_models.UpdateFloatImageRequest(
            operator_id='xxx',
            src='/core/api/resources/img/xxx',
            anchor=anchor,
            coordinate=coordinate
        )
        try:
            client.update_float_image_with_options('xxx', 'xxx', 'xxx', update_float_image_request, update_float_image_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性，可帮助开发定位问题
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_float_image_headers = dingtalkdoc__1__0_models.UpdateFloatImageHeaders()
        update_float_image_headers.x_acs_dingtalk_access_token = '<your access token>'
        coordinate = dingtalkdoc__1__0_models.UpdateFloatImageRequestCoordinate(
            width=300,
            height=300,
            offset_x=8,
            offset_y=8
        )
        anchor = dingtalkdoc__1__0_models.UpdateFloatImageRequestAnchor(
            row=0,
            col=0
        )
        update_float_image_request = dingtalkdoc__1__0_models.UpdateFloatImageRequest(
            operator_id='xxx',
            src='/core/api/resources/img/xxx',
            anchor=anchor,
            coordinate=coordinate
        )
        try:
            await client.update_float_image_with_options_async('xxx', 'xxx', 'xxx', update_float_image_request, update_float_image_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性，可帮助开发定位问题
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

PHP

<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFloatImageHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFloatImageRequest\coordinate;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFloatImageRequest\anchor;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFloatImageRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $updateFloatImageHeaders = new UpdateFloatImageHeaders([]);
        $updateFloatImageHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $coordinate = new coordinate([
            "width" => 300,
            "height" => 300,
            "offsetX" => 8,
            "offsetY" => 8
        ]);
        $anchor = new anchor([
            "row" => 0,
            "col" => 0
        ]);
        $updateFloatImageRequest = new UpdateFloatImageRequest([
            "operatorId" => "xxx",
            "src" => "/core/api/resources/img/xxx",
            "anchor" => $anchor,
            "coordinate" => $coordinate
        ]);
        try {
            $client->updateFloatImageWithOptions("xxx", "xxx", "xxx", $updateFloatImageRequest, $updateFloatImageHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err 中含有 code 和 message 属性，可帮助开发定位问题
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));

package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_1_0  "github.com/alibabacloud-go/dingtalk/doc_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// 使用 Token 初始化账号Client
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkdoc_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdoc_1_0.Client{}
  _result, _err = dingtalkdoc_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  updateFloatImageHeaders := &dingtalkdoc_1_0.UpdateFloatImageHeaders{}
  updateFloatImageHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  coordinate := &dingtalkdoc_1_0.UpdateFloatImageRequestCoordinate{
    Width: tea.Float64(300),
    Height: tea.Float64(300),
    OffsetX: tea.Float64(8),
    OffsetY: tea.Float64(8),
  }
  anchor := &dingtalkdoc_1_0.UpdateFloatImageRequestAnchor{
    Row: tea.Int32(0),
    Col: tea.Int32(0),
  }
  updateFloatImageRequest := &dingtalkdoc_1_0.UpdateFloatImageRequest{
    OperatorId: tea.String("xxx"),
    Src: tea.String("/core/api/resources/img/xxx"),
    Anchor: anchor,
    Coordinate: coordinate,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateFloatImageWithOptions(tea.String("xxx"), tea.String("xxx"), tea.String("xxx"), updateFloatImageRequest, updateFloatImageHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err 中含有 code 和 message 属性，可帮助开发定位问题
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkdoc_1_0 = require('@alicloud/dingtalk/doc_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * 使用 Token 初始化账号Client
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkdoc_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let updateFloatImageHeaders = new dingtalkdoc_1_0.UpdateFloatImageHeaders({ });
    updateFloatImageHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let coordinate = new dingtalkdoc_1_0.UpdateFloatImageRequestCoordinate({
      width: 300,
      height: 300,
      offsetX: 8,
      offsetY: 8,
    });
    let anchor = new dingtalkdoc_1_0.UpdateFloatImageRequestAnchor({
      row: 0,
      col: 0,
    });
    let updateFloatImageRequest = new dingtalkdoc_1_0.UpdateFloatImageRequest({
      operatorId: 'xxx',
      src: '/core/api/resources/img/xxx',
      anchor: anchor,
      coordinate: coordinate,
    });
    try {
      await client.updateFloatImageWithOptions('xxx', 'xxx', 'xxx', updateFloatImageRequest, updateFloatImageHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

using Newtonsoft.Json;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>使用 Token 初始化账号Client</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkdoc_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageHeaders updateFloatImageHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageHeaders();
            updateFloatImageHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate coordinate = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestCoordinate
            {
                Width = 300,
                Height = 300,
                OffsetX = 8,
                OffsetY = 8,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor anchor = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest.UpdateFloatImageRequestAnchor
            {
                Row = 0,
                Col = 0,
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest updateFloatImageRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFloatImageRequest
            {
                OperatorId = "xxx",
                Src = "/core/api/resources/img/xxx",
                Anchor = anchor,
                Coordinate = coordinate,
            };
            try
            {
                client.UpdateFloatImageWithOptions("xxx", "xxx", "xxx", updateFloatImageRequest, updateFloatImageHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
        }

    }
}

响应

响应体

名称	类型	描述
result	Object	返回更新后的结果。
id	String	浮动图片的唯一标识。
src	String	图片资源地址。
anchor	Object	锚点位置，指定图片固定在哪个单元格。
row	Integer	锚点所在行号（从 0 开始）。
col	Integer	锚点所在列号（从 0 开始）。
coordinate	Object	图片尺寸与相对锚点单元格的偏移量。
width	double	图片宽度，单位：像素。
height	double	图片高度，单位：像素。
offsetX	double	相对锚点单元格左上角的水平偏移量，单位：像素。
offsetY	double	相对锚点单元格左上角的垂直偏移量，单位：像素。
success	Boolean	成功状态。

响应体示例

HTTP/1.1 200 OK
Content-Type:application/json

{
  "result" : {
    "id" : "xxx",
    "src" : "/core/api/xxx",
    "anchor" : {
      "row" : 0,
      "col" : 0
    },
    "coordinate" : {
      "width" : 300,
      "height" : 300,
      "offsetX" : 8,
      "offsetY" : 8
    }
  },
  "success" : true
}

错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。

HttpCode	错误码	错误信息	说明
400	invalidRequest.inputArgs.invalid	%s	请求参数不合法，请查看错误信息。
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookId不合法。
400	invalidRequest.resource.notWorkbook	%s	不支持的文档类型，请检查workbookId。
403	forbidden.accessDenied	The operator has no permission.	当前用户无此操作权限。
403	forbidden.acrossOrg	%s	请求操作不合法，请查看错误信息。
403	forbidden.document.sizeOverLimit	The document size is over limit and the server is unable to complete your request. Retry is unlikely to work unless the document size is decreased.	表格内容过大，请尝试缩减表格内容。
404	invalidRequest.resource.notFound	%s	请求失败，无法找到要访问的资源。
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	服务内部错误，请稍后再试。
500	serviceBusy	The server is busy and unable to complete your request. Please try again later.	服务繁忙，请稍后重试。

​请求

​基本信息

​请求头

​路径参数

​查询参数

​请求体

​请求示例

​响应

​响应体

​响应体示例

​错误码

请求

基本信息

请求头

路径参数

查询参数

请求体

请求示例

响应

响应体

响应体示例

错误码