文档中心 > API类目 > 阿里云ocsAPI

m-kvstore.aliyuncs.com.CreateInstance.2015-03-01 (创建OCS实例)

创建OCS实例

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
InstanceName String 可选 name_str
  • 最大长度:256
  • 实例昵称长度为2-128个字符,以大小写英文字母或中文开头,不支持字符@/:="<>{[]}和空格
    Password String 必须 Qx123456 说明:实例密码规则:需同时且只能包含大写字母、小写字母和数字长度8~30个字符
    Capacity Number 必须 256 说明:实例容量设置单位:MByte输入范围请见OCS规格参数表
    RegionId String 必须 cn-hangzhou 华东杭州:cn-hangzhou 华北青岛:cn-qingdao
    Token String 可选 5689-1234-abcd 用于保证幂等性
    ZoneId String 可选 cn-hangzhou-a RegionId下级可用区编码
    NetworkType String 可选 vpc OCS实例的网络类型:classic或vpc。默认为classic
    VpcId String 可选 vpc-297j3hwg5 OCS实例所属vpc实例id。如果NetworkType参数为vpc,则本参数为必须。
    VSwitchId String 可选 vsw-291ku4tyo OCS实例所属vpc实例的虚拟交换机ID。如果NetworkType参数为vpc,则本参数为必须。
    PrivateIpAddress String 可选 172.16.1.1 OCS实例所属vpc内的私网IP地址。当NetworkType参数为vpc时有效。如果不带本参数,则系统通过VpcId和VSwitchId自动分配。如果此参数对应的私网IP地址不在VSwitchId包含的IP地址段内,则创建失败。

    响应参数

    名称 类型 示例值 描述
    InstanceId String bs66d9sck9u628d8 OCS例ID; 16位字符串(全局唯一)
    InstanceName String name_string 实例名称
    ConnectionDomain String 10.200.16.7 Memcached连接域名 注:仅支持内网
    Port Number 8080 Memcached连接端口
    UserName String bs66d9sck9u628d8 Memcached连接用户名 注:取InstanceId的值
    InstanceStatus String Available 使用中:Available 已禁用:Unavailable 创建中:Creating 修改中:Changing
    RegionId String cn-hangzhou cn-hangzhou cn-qingdao 地域-城市
    Capacity Number 256 实例容量上限 单位:MByte
    QPS Number 100 实例QPS限制 单位:次/秒
    Bandwidth Number 1024 实例带宽限制 单位:MKbps
    Connections Number 512 实例连接数限制 单位:个
    RequestId String bbbbb-xxxx-ccc 请求唯一标识
    ZoneId String cn-hangzhou-a RegionId下级可用区编码
    NetworkType String vpc OCS实例的网络类型
    PrivateIpAddress String 172.16.1.1 NetworkType为vpc时OCS实例所属vpc内由用户指定或系统分配的私网IP地址。NetworkType为classic时忽略此返回参数。

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    M-kvstoreAliyuncsComCreateInstance2015-03-01Request req = new M-kvstoreAliyuncsComCreateInstance2015-03-01Request();
    req.setnstanceName("name_str");
    req.setassword("Qx123456");
    req.setapacity(256L);
    req.setegionId("cn-hangzhou");
    req.setoken("5689-1234-abcd");
    req.setoneId("cn-hangzhou-a");
    req.setetworkType("vpc");
    req.setpcId("vpc-297j3hwg5");
    req.setSwitchId("vsw-291ku4tyo");
    req.setrivateIpAddress("172.16.1.1");
    M-kvstoreAliyuncsComCreateInstance2015-03-01Response rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <CreateInstanceResponse>
        <InstanceId>bs66d9sck9u628d8</InstanceId>
        <InstanceName>name_string</InstanceName>
        <ConnectionDomain>10.200.16.7</ConnectionDomain>
        <Port>8080</Port>
        <UserName>bs66d9sck9u628d8</UserName>
        <InstanceStatus>Available</InstanceStatus>
        <RegionId>cn-hangzhou</RegionId>
        <Capacity>256</Capacity>
        <QPS>100</QPS>
        <Bandwidth>1024</Bandwidth>
        <Connections>512</Connections>
        <RequestId>bbbbb-xxxx-ccc</RequestId>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <NetworkType>vpc</NetworkType>
        <PrivateIpAddress>172.16.1.1</PrivateIpAddress>
    </CreateInstanceResponse>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部