AI 助理
文档备案控制台
官方文档
首页

CreateTairSkvDdbWorkspace - 创建Tair Serverless KV 工作区

更新时间：
复制 MD 格式
产品详情
我的收藏

用于开通一个Tair Serverless KV的workspace实例

接口说明

请求说明

  • 在调用此接口前，请确保已了解云数据库 Redis 产品的收费方式和价格详情。

  • 若要创建 Tair Serverless KV 的 table 实例，请使用CreateTairSkvDdbTable接口。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

kvstore:CreateTairSkvDdbWorkspace

create

*全部资源

*

 无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值
ClientToken

string

否

用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，大小写敏感、不超过 64 个 ASCII 字符。

ETnLKlblzczshOTUbOCz**
RegionId

string

是

地域 ID，可调用 DescribeRegions 查询，使用此参数指定要创建实例的地域。

cn-hangzhou
ZoneId

string

是

可用区 ID，您可以调用 DescribeZones 查询。

cn-hangzhou-e
InstanceType

string

是

实例类型，固定取值：tair_skv_ddb_ws

tair_skv_ddb_ws
InstanceName

string

否

实例名称。 名称为 2-128 个字符，以大小写字母或中文开头，不支持字符@/:="<>{}和空格。

apitest
Password

string

否

实例密码，需满足下述要求：

  • 长度为 8~32 位。

  • 需包含大写字母、小写字母、特殊字符和数字中的至少三种，支持的特殊字符为!@#$%^&*()_+-=。

Pass!123456
VpcId

string

是

VPC 网络的 ID。

vpc-bp1nme44gek34slfc**
VSwitchId

string

是

虚拟交换机的 ID。

vsw-bp1e7clcw529l773d**
Port

integer

否

实例的服务端口，取值范围：1~65535，默认值为 443。

443
ResourceGroupId

string

否

资源组 ID。

rg-resourcegroupid1

https://r-kvstore.aliyuncs.com/?Action=CreateInstance &RegionId=cn-hangzhou &ZoneId=cn-hangzhou-e &InstanceType=tair_skv_ddb_ws &InstanceName=apitest &<公共请求参数>

返回参数

名称

类型

描述

示例值

object

Schema of Response

QPS

integer

每秒访问次数，此处为当前规格实例的理论值。

100000
ConnectionDomain

string

Redis 实例的内网连接地址。

r-bp1zxszhcgatnx**.redis.rds.aliyuncs.com
ChargeType

string

付费类型，返回值：

  • PrePaid：预付费。

  • PostPaid：按量付费。

PostPaid
InstanceId

string

实例 ID（全局唯一）。

r-bp1zxszhcgatnx**
Port

integer

Redis 服务端口。

443
Config

string

实例的详细配置。

{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}
RegionId

string

实例所在地域。

cn-hongkong
RequestId

string

请求 ID。

5DEA3CC9-F81D-4387-8E97-CEA40F09****
Bandwidth

integer

实例带宽限制，单位：MB/s。

96
Connections

integer

实例连接数限制。

10000
InstanceName

string

实例名称。

apitest
ZoneId

string

实例所属的可用区的 ID。

cn-hangzhou-b
InstanceStatus

string

实例的当前状态，返回值固定为 Creating（创建中）。

Creating
TaskId

string

创建执行的任务流 id

1111
OrderId

integer

订单 id。

20741011111111

{ "Connections": 0, "RequestId": "3631EF6F-2979-1C04-BDAA-51XXXXXXXXX", "InstanceId": "tt-2zesmjzrj0wzncb9y", "Port": 443, "OrderId": 0, "ConnectionDomain": "tt-2zesmjzrj0wzncb9y.tairskvddb.pre.rds.aliyuncs.com", "InstanceName": "apitest", "QPS": 0, "ChargeType": "PostPaid", "InstanceStatus": "Normal", "Bandwidth": 0, "RegionId": "cn-beijing" }

示例

正常返回示例

JSON格式

{
  "QPS": 100000,
  "ConnectionDomain": "r-bp1zxszhcgatnx**.redis.rds.aliyuncs.com",
  "ChargeType": "PostPaid",
  "InstanceId": "r-bp1zxszhcgatnx**",
  "Port": 443,
  "Config": "{\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64}",
  "RegionId": "cn-hongkong",
  "RequestId": "5DEA3CC9-F81D-4387-8E97-CEA40F09****",
  "Bandwidth": 96,
  "Connections": 10000,
  "InstanceName": "apitest",
  "ZoneId": "cn-hangzhou-b",
  "InstanceStatus": "Creating",
  "TaskId": "1111",
  "OrderId": 20741011111111
}

错误码

HTTP status code

错误码

错误信息

描述
400 MissingParameter Period is mandatory for this action.
400 InvalidToken.Malformed The Specified parameter Token is not valid.
400 InvalidInstanceName.Malformed The Specified parameter InstanceName is not valid.
400 InvalidPassword.Malformed The Specified parameter Password is not valid.
400 IdempotentParameterMismatch Request uses a client token in a previous request but is not identical to that request. 幂等性校验不过。
400 QuotaNotEnough Quota not enough in this zone.
400 QuotaExceed Living afterpay instances quota exceed.
400 VpcServiceError Invoke vpc service failed.
400 IzNotSupportVpcError Specify iz not support vpc.
400 InvalidvSwitchId The vpc does not cover the vswitch.
400 InvalidIzNo.NotSupported The Specified vpc zone not supported.
400 InvalidAccountPassword.Format Specified account password is not valid.
400 InstanceClass.NotMatch Current instance class and instance type is not match.
400 InvalidVPCId.NotFound Specified virtual vpc is not found. VPC未找到，建议检查VPC ID是否正确。
400 InvalidEngineVersion.Malformed Specified engine version is not valid. 无效的引擎版本
400 Zone.Closed The specified zone is closed.
400 InvalidRegion.Format Specified Region is not valid. 指定的地域Region无效
403 AuthorizationFailure The request processing has failed due to authorization failure.
403 TokenServiceError The specified token is duplicated, please change it.
404 InvalidCapacity.NotFound The Capacity provided does not exist in our records. 所指定的存储规格不存在。
404 InvalidvSwitchId The Specified vSwitchId zone not supported.
404 InvalidVpcIdOrVswitchId.NotSupported The Specified vpcId or vSwitchId not supported.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：Serverless KV 管理下一篇：DescribeTairSkvDdbTableSchema - 查询Tair Serverless KV表结构