Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/ranges/{rangeAddress} |
| Metode HTTP | GET |
| Jenis aplikasi yang didukung | appType-Aplikasi internal |
| Izin yang diperlukan | permission-Document.Workbook.Read-Izin baca Spreadsheet |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan dengan memanggil API Mendapatkan access token aplikasi internal. |
Parameter path
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| workbookId | String | Ya | ID file spreadsheet. Nilai nodeId(dentryUuid) yang dikembalikan oleh Knowledge Base API adalah workbookId dari spreadsheet. Dapatkan dengan memanggil API Mendapatkan sebuah node atau Membuat dokumen Knowledge Base. |
| sheetId | String | Ya | ID atau nama lembar kerja. Dapatkan nilai parameter id atau name dengan memanggil API Mendapatkan semua lembar kerja. |
| rangeAddress | String | Ya | Alamat rentang. |
Parameter query
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| select | String | Tidak | Memfilter bidang yang akan dikembalikan. Jika parameter ini tidak ditentukan, semua bidang akan dikembalikan. - Contohnya, select=values hanya mengembalikan bidang values. - Untuk mengembalikan beberapa bidang, pisahkan dengan koma. Contohnya, select=values,formulas hanya mengembalikan bidang values dan formulas. Kami menyarankan Anda menentukan parameter ini untuk meningkatkan performa dan menghindari timeout API akibat penambahan nilai kembalian di kemudian hari. |
| operatorId | String | Ya | unionId dari operator. - Dapatkan nilai parameter unionid dengan memanggil API Mendapatkan informasi pengguna melalui kode login senyap. - Dapatkan nilai parameter unionid dengan memanggil API Kueri detail pengguna. Jika operator tidak memiliki izin, API akan mengembalikan error The operator has no permission. |
Contoh permintaan
HTTPGET /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/ranges/A1:B2?select=values&operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* Initialize the account Client using Token
* @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 {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkdoc_1_0.models.GetRangeHeaders getRangeHeaders = new com.aliyun.dingtalkdoc_1_0.models.GetRangeHeaders();
getRangeHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkdoc_1_0.models.GetRangeRequest getRangeRequest = new com.aliyun.dingtalkdoc_1_0.models.GetRangeRequest()
.setSelect("values")
.setOperatorId("ppgAxxx");
try {
client.getRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", getRangeRequest, getRangeHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// Objek err berisi atribut code dan message yang membantu menemukan issue
}
} 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)) {
// Objek err berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
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:
"""
Initialize the account Client using Token
@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()
get_range_headers = dingtalkdoc__1__0_models.GetRangeHeaders()
get_range_headers.x_acs_dingtalk_access_token = '<your access token>'
get_range_request = dingtalkdoc__1__0_models.GetRangeRequest(
select='values',
operator_id='ppgAxxx'
)
try:
client.get_range_with_options('e54Lq3xxx', 'Sheet1', 'A1:B2', get_range_request, get_range_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# Objek err berisi atribut code dan message yang membantu menemukan issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
get_range_headers = dingtalkdoc__1__0_models.GetRangeHeaders()
get_range_headers.x_acs_dingtalk_access_token = '<your access token>'
get_range_request = dingtalkdoc__1__0_models.GetRangeRequest(
select='values',
operator_id='ppgAxxx'
)
try:
await client.get_range_with_options_async('e54Lq3xxx', 'Sheet1', 'A1:B2', get_range_request, get_range_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# Objek err berisi atribut code dan message yang membantu menemukan issue
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?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\GetRangeHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\GetRangeRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client using Token
* @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();
$getRangeHeaders = new GetRangeHeaders([]);
$getRangeHeaders->xAcsDingtalkAccessToken = "<your access token>";
$getRangeRequest = new GetRangeRequest([
"select" => "values",
"operatorId" => "ppgAxxx"
]);
try {
$client->getRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", $getRangeRequest, $getRangeHeaders, 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)) {
// Objek err berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"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"
)
/**
* Initialize the account Client using Token
* @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
}
getRangeHeaders := &dingtalkdoc_1_0.GetRangeHeaders{}
getRangeHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
getRangeRequest := &dingtalkdoc_1_0.GetRangeRequest{
Select: tea.String("values"),
OperatorId: tea.String("ppgAxxx"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.GetRangeWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("A1:B2"), getRangeRequest, getRangeHeaders, &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)) {
// Objek err berisi atribut code dan message yang membantu menemukan issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkdoc_1_0, * as $dingtalkdoc_1_0 from '@alicloud/dingtalk/doc_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* Initialize the account Client using Token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkdoc_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkdoc_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let getRangeHeaders = new $dingtalkdoc_1_0.GetRangeHeaders({ });
getRangeHeaders.xAcsDingtalkAccessToken = "<your access token>";
let getRangeRequest = new $dingtalkdoc_1_0.GetRangeRequest({
select: "values",
operatorId: "ppgAxxx",
});
try {
await client.getRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", getRangeRequest, getRangeHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// Objek err berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
Client.main(process.argv.slice(2));
// This file is auto-generated, don't edit it. Thanks.
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
{
/**
* Initialize the account Client using Token
* @return Client
* @throws 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.GetRangeHeaders getRangeHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetRangeHeaders();
getRangeHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetRangeRequest getRangeRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetRangeRequest
{
Select = "values",
OperatorId = "ppgAxxx",
};
try
{
client.GetRangeWithOptions("e54Lq3xxx", "Sheet1", "A1:B2", getRangeRequest, getRangeHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// Objek err berisi atribut code dan message yang membantu menemukan issue
}
}
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))
{
// Objek err berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| values | Array | Nilai-nilai dari sel. Jika sebuah sel berisi formula, hasil perhitungan dari formula tersebut yang dikembalikan. Nilai dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan nilai sel dari setiap baris dalam rentang. |
| Array of Any | Nilai-nilai dari sel. Jika sebuah sel berisi formula, hasil perhitungan dari formula tersebut yang dikembalikan. Nilai dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan nilai sel dari setiap baris dalam rentang. | |
| formulas | Array | Formula dari sel. Formula dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan formula dari semua sel di setiap baris dalam rentang. |
| Array of String | Formula dari sel. Formula dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan formula dari semua sel di setiap baris dalam rentang. | |
| displayValues | Array | Nilai tampilan dari sel. Nilai tampilan adalah hasil yang ditampilkan pada antarmuka spreadsheet. Dibandingkan dengan values, nilai ini dipengaruhi oleh faktor-faktor seperti format angka (misalnya, tempat desimal, persen, dan format tanggal). Nilai tampilan dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan nilai tampilan dari semua sel di setiap baris dalam rentang. |
| Array of String | Nilai tampilan dari sel. Nilai tampilan adalah hasil yang ditampilkan pada antarmuka spreadsheet. Dibandingkan dengan values, nilai ini dipengaruhi oleh faktor-faktor seperti format angka (misalnya, tempat desimal, persen, dan format tanggal). Nilai tampilan dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan nilai tampilan dari semua sel di setiap baris dalam rentang. | |
| backgroundColors | Array | Warna latar dari sel. Warna latar dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan warna latar dari semua sel di setiap baris dalam rentang. |
| Array | Warna latar dari sel. Warna latar dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan warna latar dari semua sel di setiap baris dalam rentang. | |
| red | Integer | Komponen merah dari nilai RGB. |
| green | Integer | Komponen hijau dari nilai RGB. |
| blue | Integer | Komponen biru dari nilai RGB. |
| hexString | String | Warna dalam notasi heksadesimal. |
| fontSizes | Array | Ukuran font dari sel. Ukuran font dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan ukuran font dari semua sel di setiap baris dalam rentang. |
| Array of Integer | Ukuran font dari sel. Ukuran font dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan ukuran font dari semua sel di setiap baris dalam rentang. | |
| horizontalAlignments | Array | Perataan horizontal dari sel. Perataan horizontal dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan perataan horizontal dari semua sel di setiap baris dalam rentang. |
| Array of String | Perataan horizontal dari sel. Perataan horizontal dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan perataan horizontal dari semua sel di setiap baris dalam rentang. | |
| verticalAlignments | Array | Perataan vertikal dari sel. Perataan vertikal dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan perataan vertikal dari semua sel di setiap baris dalam rentang. |
| Array of String | Perataan vertikal dari sel. Perataan vertikal dikembalikan sebagai array dua dimensi. Dimensi pertama merepresentasikan semua baris dalam rentang, dan dimensi kedua merepresentasikan perataan vertikal dari semua sel di setiap baris dalam rentang. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"values" : [ [ "1" ] ],
"formulas" : [ [ "=B1+C2" ] ],
"displayValues" : [ [ "100%" ] ],
"backgroundColors" : [ [ {
"red" : 0,
"green" : 0,
"blue" : 0,
"hexString" : "#000000"
} ] ],
"fontSizes" : [ [ 14 ] ],
"horizontalAlignments" : [ [ "general" ] ],
"verticalAlignments" : [ [ "middle" ] ]
}
Kode error
Jika terjadi error saat Anda memanggil API ini, cari solusinya di dokumen Kode error global berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | invalidRequest.inputArgs.invalid | %s | Parameter permintaan tidak valid. Periksa pesan error. |
| 400 | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal. | workbookId tidak valid. |
| 400 | invalidRequest.resource.notWorkbook | %s | Jenis dokumen tidak didukung. Periksa workbookId. |
| 403 | forbidden.accessDenied | The operator has no permission. | Pengguna saat ini tidak memiliki izin untuk operasi ini. |
| 403 | forbidden.acrossOrg | %s | Permintaan tidak valid. Periksa apakah dokumen yang akan diakses milik organisasi yang ditentukan oleh access token. |
| 403 | forbidden.operationIllegal | %s | Operasi yang diminta tidak valid. Periksa pesan error. |
| 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. | Konten spreadsheet terlalu besar. Coba kurangi konten spreadsheet. |
| 404 | invalidRequest.resource.notFound | %s | Permintaan gagal. Sumber daya yang akan diakses tidak dapat ditemukan. |
| 500 | serviceBusy | The server is busy and unable to complete your request. Please try again later. | Layanan sedang sibuk. Coba lagi nanti. |
| 500 | internalError | The server encountered an internal error and was unable to complete your request. Please try again later. | Terjadi kesalahan internal server. Coba lagi nanti. |