咨询.反馈
|
API Explorer
运营
应用中间件
软件开发生产线
网络
CDN与智能边缘
计算
安全和合规
数据库
人工智能
大数据
容器
迁移
管理与监管
企业应用
存储
开发者工具
视频
IoT物联网
运营
应用中间件
软件开发生产线
网络
CDN与智能边缘
计算
安全和合规
数据库
人工智能
大数据
容器
迁移
管理与监管
企业应用
存储
开发者工具
视频
IoT物联网
收藏服务

请登录后查看

我的集合
更多
简体中文
文档数据库服务
| 产品详情
  • 查询API版本
    • 查询当前支持的API版本信息列表ListApiVersion
    • 查询指定API版本信息ShowApiVersion
  • 引擎版本和规格
    • 查询数据库版本信息ListDatastoreVersions
    • 查询数据库规格ListFlavorInfos
    • 查询所有实例规格信息ListFlavors
    • 查询数据库磁盘类型ListStorageType
  • 实例管理
    • 实例新增只读节点AddReadonlyNode
    • 扩容集群实例的节点数量AddShardingNode
    • 绑定弹性公网IPAttachEip
    • 修改实例内网地址AttachInternalIp
    • 批量数据库补丁升级BatchUpgradeDatabaseVersion
    • 解绑弹性公网IPCancelEip
    • 设置可维护时间段ChangeOpsWindow
    • 检查弱密码CheckWeakPassword
    • 创建实例CreateInstance
    • 创建集群的Shard/Config IPCreateIp
    • 删除实例DeleteInstance
    • 解除关联LTS日志流DeleteLtsConfig
    • 删除只读节点DeleteReadonlyNode
    • 扩容副本集实例的节点数量ExpandReplicasetNode
    • 查询实例可迁移到的可用区ListAz2Migrate
    • 查询实例列表和详情ListInstances
    • 查询LTS日志配置信息ListLtsConfigs
    • 查询回收站实例列表ListRecycleInstances
    • 获取SSL证书下载地址ListSslCertDownloadAddress
    • 实例可用区迁移MigrateAz
    • 变更实例规格ResizeInstance
    • 扩容实例存储容量ResizeInstanceVolume
    • 重启实例RestartInstance
    • 设置磁盘自动扩容策略SetAutoEnlargePolicies
    • 设置实例回收站策略SetRecyclePolicy
    • 查询磁盘自动扩容策略ShowAutoEnlargePolicy
    • 查询副本集跨网段访问配置ShowClientNetwork
    • 查询实例磁盘信息ShowDiskUsage
    • 查询实例回收站策略ShowRecyclePolicy
    • 查询数据库复制集名称ShowReplSetName
    • 查询秒级监控配置ShowSecondLevelMonitoringStatus
    • 查询数据库补丁升级预估时长ShowUpgradeDuration
    • 删除实例的节点ShrinkInstanceNodes
    • 切换副本集实例的主备节点SwitchoverReplicaSet
    • 开启/关闭秒级监控SwitchSecondLevelMonitoring
    • 切换SSL开关SwitchSsl
    • 副本集跨网段访问配置。UpdateClientNetwork
    • 修改实例名称UpdateInstanceName
    • 修改数据库端口UpdateInstancePort
    • 修改实例备注UpdateInstanceRemark
    • 关联LTS日志流UpdateLtsConfig
    • 修改数据库复制集名称UpdateReplSetName
    • 变更实例安全组UpdateSecurityGroup
    • 数据库补丁升级UpgradeDatabaseVersion
  • 连接管理
    • 终结实例节点会话DeleteSession
    • 查询实例节点会话ListSessions
    • 查询实例连接数统计信息ShowConnectionStatistics
  • 备份与恢复
    • 批量删除手动备份BatchDeleteBackup
    • 创建手动备份CreateManualBackup
    • 删除手动备份DeleteManualBackup
    • 查询备份列表ListBackups
    • 获取可恢复的数据库集合列表ListRestoreCollections
    • 获取可恢复的数据库列表ListRestoreDatabases
    • 查询可恢复的时间段ListRestoreTimes
    • 恢复到当前实例RestoreInstance
    • 库表级时间点恢复RestoreInstanceFromCollection
    • 恢复到新实例RestoreNewInstance
    • 设置自动备份策略SetBackupPolicy
    • 获取备份下载链接ShowBackupDownloadLink
    • 查询自动备份策略ShowBackupPolicy
    • 停止备份StopBackup
  • 获取日志信息
    • 删除审计日志DeleteAuditLog
    • 获取错误日志下载链接DownloadErrorlog
    • 获取慢日志下载链接DownloadSlowlog
    • 获取审计日志下载链接ListAuditlogLinks
    • 获取审计日志列表ListAuditlogs
    • 查询数据库错误日志ListErrorLogs
    • 查询数据库错误日志ListLtsErrorLogs
    • 查询数据库慢日志ListLtsSlowLogs
    • 查询数据库慢日志ListSlowLogs
    • 设置审计日志策略SetAuditlogPolicy
    • 查询审计日志策略ShowAuditlogPolicy
    • 查询慢日志明文开关ShowSlowlogDesensitizationSwitch
    • 设置慢日志明文开关SwitchSlowlogDesensitization
  • 标签管理
    • 批量添加或删除资源标签BatchTagAction
    • 查询资源实例ListInstancesByTags
    • 查询资源标签ListInstanceTags
    • 查询项目标签ListProjectTags
  • 管理数据库和用户
    • 检查数据库密码CheckPassword
    • 创建数据库角色CreateDatabaseRole
    • 创建数据库用户CreateDatabaseUser
    • 删除数据库角色DeleteDatabaseRole
    • 删除数据库用户DeleteDatabaseUser
    • 查询数据库角色列表ListDatabaseRoles
    • 查询数据库列表ListDatabases
    • 查询数据库用户列表ListDatabaseUsers
    • 修改数据库用户密码ResetPassword
    • 设置集群均衡开关SetBalancerSwitch
    • 设置集群均衡活动时间窗SetBalancerWindow
    • 查询集群均衡设置ShowShardingBalancer
  • 参数配置
    • 参数模板比较CompareConfiguration
    • 复制参数模板CopyConfiguration
    • 创建参数模板CreateConfiguration
    • 删除参数模板DeleteConfiguration
    • 查询可应用的实例ListAppliedInstances
    • 获取参数模板列表ListConfigurations
    • 重置参数模板ResetConfiguration
    • 查询参数模板被应用历史ShowConfigurationAppliedHistory
    • 查询参数模板修改历史ShowConfigurationModifyHistory
    • 获取参数模板的详情ShowConfigurationParameter
    • 获取指定实例的参数信息ShowEntityConfiguration
    • 查询实例参数的修改历史ShowInstanceConfigurationModifyHistory
    • 应用参数模板SwitchConfiguration
    • 修改参数模板UpdateConfigurationParameter
    • 修改指定实例的参数UpdateEntityConfiguration
    • 校验参数模板名称是否存在ValidateConfigurationName
  • 配额管理
    • 查询配额ShowQuotas
  • 任务管理
    • 查询任务列表和详情ListTasks
    • 获取DDS任务中心指定ID的任务信息。ShowJobDetail
  • 数据库运维
    • 创建killOp规则CreateKillOpRule
    • 删除killOp规则DeleteKillOpRuleList
    • 获取killOp规则列表ShowKillOpRuleRuleList
    • 强制备节点升主SwitchInstancePrimary
    • 启用/禁用killOp规则UpdateKillOpRule
  • 定时任务
    • 取消定时任务CancelScheduledTask
    • 查询定时任务ListScheduledTasks

ListFlavorInfos

查询数据库规格

GET
https://dds.af-south-1.myhuaweicloud.com/v3.1/{project_id}/flavors
高级设置
只看必填项
填写默认值
密文显示特定参数
*
Region
Headers
*
Authorization
Parameters
*
project_id
*
engine_name
*
engine_version
*
offset
*
limit
接口说明

查询指定条件下的实例规格信息。

URL
GET  https://dds.af-south-1.myhuaweicloud.com/v3.1/{project_id}/flavors
请求参数
名称类型IN必选描述
x-auth-token
stringheader 是

用户Token。

project_id
stringpath 是

租户在某一region下的project ID。

limit
integerquery 否

查询规格信息上限值。

  • 取值范围: 1~100。
  • 不传该参数时,默认查询前100条规格信息。
offset
integerquery 否

索引位置,偏移量。

  • 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)。
  • 取值必须为数字,不能为负数。
engine_version
stringquery 否

数据库版本号。

engine_name
stringquery 否

数据库版本类型。取值为“DDS-Community”。

返回参数
返回码: 200

Success.

名称类型描述
total_count
integer

总记录数。

flavors
Array of FlavorInfo objects

实例规格信息列表。

200 flavors
名称类型描述
engine_name
string

引擎名称。

type
string

节点类型。文档数据库包含以下几种节点类型:

  • mongos
  • shard
  • config
  • replica
  • single
  • readonly
vcpus
string

CPU核数。

ram
string

内存大小,单位为兆字节。

spec_code
string

资源规格编码。例如:dds.mongodb.c6.xlarge.2.shard。

  • “dds”表示文档数据库服务产品。
  • “c6.xlarge.2”表示节点性能规格,为高内存类型。
  • “shard”表示节点类型。
az_status
az_status object

'支持该规格的可用区ID。' 示例:["cn-east-2a","cn-east-2b","cn-east-2c"]。

engine_versions
Array of strings

数据库版本号列表。针对DDS引擎的mongos节点,例如:{"3.4", "4.0"}

返回码: default

Client or server error.

名称类型描述
error_code
string

错误码。

error_msg
string

错误消息。

请求示例
示例 1
"GET https://{endpoint}/v3.1/054e292c9880d4992f02c0196d3ea468/flavors?engine_name=DDS-Community&engine_version=3.4&offset=1&limit=20"
返回示例
返回码：200

Success.

示例 1
{
  "total_count": 5,
  "flavors": [
    {
      "engine_name": "DDS-Community",
      "type": "mongos",
      "vcpus": "1",
      "ram": "4",
      "spec_code": "dds.mongodb.c6.medium.4.mongos",
      "engine_versions": [
        "3.4",
        "4.0"
      ]
    },
    {
      "engine_name": "DDS-Community",
      "type": "shard",
      "vcpus": "4",
      "ram": "8",
      "spec_code": "dds.mongodb.c6.xlarge.2.shard",
      "engine_versions": [
        "3.4",
        "4.0"
      ]
    },
    {
      "engine_name": "DDS-Community",
      "type": "config",
      "vcpus": "2",
      "ram": "4",
      "spec_code": "dds.mongodb.c6.large.2.config",
      "engine_versions": [
        "3.4"
      ]
    },
    {
      "engine_name": "DDS-Community",
      "type": "replica",
      "vcpus": "1",
      "ram": "4",
      "spec_code": "dds.mongodb.c6.medium.4.repset",
      "engine_versions": [
        "3.4",
        "4.0"
      ]
    },
    {
      "engine_name": "DDS-Community",
      "type": "single",
      "vcpus": "16",
      "ram": "64",
      "spec_code": "dds.mongodb.c6.4xlarge.4.single",
      "engine_versions": [
        "3.4",
        "4.0"
      ]
    }
  ]
}
SDK
点击 文档数据库服务 (DDS) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明。

本文导读

接口说明
URL
请求参数
返回参数
请求示例
返回示例
SDK
错误码