公共参数
公共返回参数 API返回结果采用统一格式，调用成功返回的数据格式有XML和JSON两种，可以在发送请求时指定返回的数据格式，默认为XML格式。每次接口调用，无论成功与否，系统都会返回一个唯一识别码 RequestId。返回 2xx HTTP状态码表示调用...
公共参数
公共返回参数 API返回结果采用统一格式，调用成功返回的数据格式有XML和JSON两种，可以在发送请求时指定返回的数据格式，默认为XML格式。每次接口调用，无论成功与否，系统都会返回一个唯一识别码 RequestId。返回 2xx HTTP状态码表示调用...
XML函数
本节中描述的函数以及类函数的表达式都在类型 xml 的值上操作。用于在值和类型 xml 之间转换的类函数的表达式 xmlparse 和 xmlserialize 记录在这里，而不是在本节中。使用大部分这些函数要求本数据库使用了 configure-with-libxml 进行...
公共参数
公共返回参数 API返回结果采用统一格式，调用成功返回的数据格式有XML和JSON两种，可以在发送请求时指定返回的数据格式，默认为JSON格式。每次接口调用，无论成功与否，系统都会返回一个唯一识别码 RequestId。返回 2xx HTTP状态码表示调用...
公共参数
API返回结果采用统一格式，调用成功返回的数据格式有XML和JSON两种，可以在发送请求时指定返回的数据格式，默认为JSON格式。每次接口调用，无论成功与否，系统都会返回一个唯一识别码 RequestId。返回 2xx HTTP状态码表示调用成功。返回 4...
JSON与XML解析库
请求参数 参数 必选 类型 说明 property_value 是 string JSON 格式数据 property_type 是 int 解析类型，0 表示 JSON，1 表示 XML 返回值 参数 必选 类型 说明 result 是 uint 处理 JSON 数据解析的标识符 property_destroy 删除 JSON 与 ...
公共响应参数
外部系统可以在请求时传入参数来制定返回的数据格式，默认为XML格式。为了便于查看，本文档中的返回示例做了格式化处理，实际返回结果没有进行换行、缩进等处理。JSON格式 {"RequestId":"4C467B38-3910-447D-87BC-AC049166F216",/*返回结果...
公共响应参数
外部系统可以在请求时传入参数来制定返回的数据格式，默认为XML格式。为了便于查看，本文档中的返回示例做了格式化处理，实际返回结果没有进行换行、缩进等处理。JSON格式 {"RequestId":"4C467B38-3910-447D-87BC-AC049166F216",/*返回结果...
公共参数
调用成功返回的数据格式有XML和JSON两种，可以在发送请求时指定返回的数据格式，默认为JSON格式。每次调用接口，无论成功与否，系统都会返回一个唯一识别码 RequestId。JSON格式 {"RequestId":"4C467B38-3910-447D-87BC-AC049166F216",/*...
公共参数
调用成功返回的数据格式主要有XML和JSON两种，外部系统可以在请求时传入参数来制定返回的数据格式，默认为XML格式。为了便于查看，本文档中的返回示例做了格式化处理，实际返回结果是没有进行换行、缩进等处理的。成功结果 XML格式?xml ...
公共参数
调用成功返回的数据格式主要有XML和JSON两种，外部系统可以在请求时传入参数来制定返回的数据格式，默认为XML格式。为了便于查看，本文档中的返回示例做了格式化处理，实际返回结果是没有进行换行、缩进等处理的。成功结果 XML格式?xml ...
RestAPI（HTTP形式）数据源
是 无 responseType 返回结果的数据格式，目前仅支持JSON格式。是 JSON column 读取字段列表，type指定源数据的类型，name指定当前column数据获取的JSON路径。您可以指定column字段信息，配置如下。column":[{"type":"long","name":"a.b"/...
DeleteDatabase
描述 删除实例中的数据库，该接口会删除该数据库中的数据。接口必须满足以下条件，否则将调用失败：实例状态为运行中。实例类型为主实例。当该数据库是实例下唯一的数据库时，此数据库不能被删除。请求参数 名称 类型 是否必须 描述<公共...
DeleteInstance
描述 删除数据库实例，该接口会删除该实例下所有数据库中的数据。说明 接口必须满足以下条件，否则将调用失败：实例状态为运行中。实例没有被锁定。请求参数 名称 类型 是否必须 描述<公共参数>-是 参见 公共参数。Action String 是 系统...
释放同步实例
调用DeleteSynchronizationJob释放数据同步实例。说明 数据同步实例一旦释放将无法找回。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 ...
释放订阅实例
调用DeleteSubscriptionInstance接口释放数据订阅实例。说明 数据订阅实例一旦释放将无法找回。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 ...
返回结果
调用成功返回的数据格式主要有XML和JSON两种，外部系统可以在请求时传入参数来制定返回的数据格式，默认为XML格式。本文档中的返回示例为了便于用户查看，做了格式化处理，实际返回结果是没有进行换行、缩进等处理的。成功结果 XML示例?xml...
返回结果
调用成功返回的数据格式主要有XML和JSON两种，外部系统可以在请求时传入参数来指定返回的数据格式，默认为XML格式。本文档中的返回示例为了便于用户查看，做了格式化处理，实际返回结果是没有进行换行、缩进等处理的。成功结果 XML示例 XML...
查询订阅实例的监控报警
调用DescribeSubscriptionInstanceAlert接口查询数据订阅实例的监控报警设置详情。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否...
ModifyHiTSDBInstanceClass
类型 是否必选 示例值 描述 InstanceClass String 是 tsdb.1x.basic 实例规格 InstanceId String 是 ts-xxxxxxxxxxxxxxxxx 实例ID InstanceStorage String 是 500 实例存储容量，单位GB RegionId String 是 cn-shanghai 区域ID 返回数据 ...
购买迁移实例
调用CreateMigrationJob购买一个数据迁移实例。说明 此接口为旧版API，建议您使用新版API 购买DTS实例。请确保在使用该接口前，已充分了解云数据库DTS产品的收费方式和 价格。购买完成后，还需要调用 ConfigureMigrationJob 接口配置迁移...
购买订阅实例
调用CreateSubscriptionInstance接口购买DTS数据订阅实例。请确保在使用该接口前，已充分了解云数据库DTS产品的收费方式和 价格。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以...
ModifyDBInstanceDescription
调用ModifyDBInstanceDescription接口修改实例备注描述。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action ...
释放迁移实例
调用DeleteMigrationJob释放数据迁移实例。说明 数据迁移实例一旦释放将无法找回。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否...
RestartDBInstance
调用RestartDBInstance接口重启实例。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ...
启动订阅实例
调用StartSubscriptionInstance接口启动数据订阅实例。调用本接口时，数据订阅实例需处于未启动或启动失败状态。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码...
ListHBaseInstances
调用ListHBaseInstances接口获取相同专有网络的云数据库HBase实例。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 ...
DeleteDBInstance
调用DeleteDBInstance接口删除实例。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是 ...
启动迁移实例
调用StartMigrationJob接口启动数据迁移实例。说明 调用本接口时，数据迁移任务须处于未启动、暂停或迁移失败状态。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK...
清空同步实例配置
调用ResetSynchronizationJob清空数据同步实例配置。说明 清空数据同步任务配置后，原先的同步任务就会被释放，您需要调用接口 ConfigureSynchronizationJob重新配置同步任务，才能成功启动该任务。调试 您可以在OpenAPI Explorer中直接...
启动同步实例
调用StartSynchronizationJob接口启动数据同步实例。说明 请确保在使用该接口前，已充分了解DTS产品的收费方式和 价格。调用本接口时，数据同步作业须处于未启动、同步失败、暂停状态。调用成功后，处于未启动状态的任务需要进行预检查。...
DescribeCharacterSet
调用DescribeCharacterSet接口查询目标实例下数据库所支持的字符集类型。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例...
RemoveDrdsInstance
调用RemoveDrdsInstance接口释放目标实例。说明 只能释放按量付费（后付费）实例。实例处于变配中或关联有数据库时，无法调用本接口释放实例。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI ...
解绑付费版DNS域名
实例ID以”dns-“开头的实例为新版实例，支持绑定多个域名，调用接口直接绑定到实例，如果域名个数超过实例的配置，则会报错。实例ID以非”dns-“开头的实例为旧版实例，只支持绑定一个域名，因此调用此接口，如果实例已经绑定域名，则会...
UpdateDBInstanceSSL
调用UpdateDBInstanceSSL接口更新实例SSL配置。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。请求参数 名称 类型 是否必选 示例值 描述 Action String 是...
CreateThingScript
注意 若设备数据格式为 ICA标准数据格式（Alink JSON），不支持使用接口CreateThingScript。QPS限制 单阿里云账号调用该接口的每秒请求数（QPS）最大限制为10。说明 RAM用户共享阿里云账号配额。调试 您可以在OpenAPI Explorer中直接运行该...
DeleteInstance
调用DeleteInstance释放HBase实例。调用本接口时，实例必须满足以下条件：实例状态为 运行中。实例的付费方式为 按量付费。说明 包年包月实例无法调用此接口主动删除，到期后将自动释放。如需提前释放，请提交工单申请。调试 您可以在Open...
EnableInstancePublicAccess
调用EnableInstancePublicAccess开启指定数据库审计实例对公网流量的审计能力，开启后还需要通过ConfigInstanceWhiteList指定数据库审计实例需要审计的公网流量IP白名单。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的...
暂停同步实例
调用SuspendSynchronizationJob接口暂停处于同步中的数据同步实例。说明 调用本接口时，同步作业须处于同步中状态。暂停同步作业不能超过6个小时，否则将无法被再次启动。按量付费类型的同步作业即使处于暂停状态，DTS依然会收取费用。这是...
ConfigInstanceWhiteList
数据库审计实例默认拒绝所有公网审计流量，实例开启公网访问后，需要将指定公网IP地址配置到白名单中，允许来自公网IP的审计流量访问数据库审计实例。调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，...
- 产品推荐
- 这些文档可能帮助您