创建数据库实例（v5）

功能介绍

该接口由“创建数据库实例（v3.1）”接口派生而来，接口请求头新增了“Subscription-Agency”字段，该字段用于使用共享密钥创建GaussDB包周期实例的场景。

• 调用接口前，您需要了解API 认证鉴权。
• 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

调试

您可以在API Explorer中调试该接口。

约束

• 当前接口仅支持IAM新平面鉴权。
• 使用共享的KMS密钥创建包周期实例时，需要创建委托给费用中心服务并授权系统策略ServicePolicyForGaussDBFulfillment。获取到委托的URN，格式iam::{account_id}:agency:{agency_name}，调用时增加请求头Subscription-Agency，值为委托的URN。

URI

请求参数

响应参数

请求示例

• 创建一个GaussDB实例，实例部署形态为分布式独立部署，包周期付费（1年），引擎版本为2.7，三个不同可用区下，3个协调节点，3个分片，3个副本，规格为8U64G。

  POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances
  {
      "name": "user1-v3-independent-02", 
      "datastore": {
          "type": "GaussDB", 
          "version": "2.7"
      }, 
      "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in", 
      "volume": {
          "type": "ULTRAHIGH", 
          "size": 120
      },
      "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab",
      "region": "aaa",
      "availability_zone": "bbb,ccc,ddd", 
      "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329", 
      "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189", 
      "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f", 
      "backup_strategy": {
          "start_time": "17:00-18:00", 
          "keep_days": 7
      }, 
      "charge_info": {
          "charge_mode": "prePaid",
          "period_type": "year",
          "period_num": 1
      },
      "password": "xxxxxx", 
      "configuration_id": "", 
      "enterprise_project_id": "", 
      "time_zone": "UTC+08:00",
      "ha":{
          "mode":"enterprise",
          "consistency":"strong",
          "replication_mode":"sync"
      },
      "sharding_num": 3,
      "coordinator_num": 3,
      "replica_num": 3,
      "port":8000,
      "enable_force_switch":true
  }

• 创建一个GaussDB实例，实例部署形态为主备版高可用（1主2备），按需付费，引擎版本为2.7，同一可用区下，规格为8U64G。

  POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances
  {
      "name": "user1-v3-ha-01",
      "datastore": {
          "type": "GaussDB",
          "version": "2.7"
      },
      "flavor_ref": "gaussdb.opengauss.ee.km1.2xlarge.arm8.ha",
      "volume": {
          "type": "ULTRAHIGH",
          "size": 120
      },
      "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab",
      "region": "aaa",
      "availability_zone": "bbb,bbb,bbb", 
      "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
      "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
      "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
      "backup_strategy": {
          "start_time": "17:00-18:00",
          "keep_days": 7
      },
      "charge_info": {
          "charge_mode": "postPaid"
      },
      "password": "xxxxxx",
      "configuration_id": "", 
      "enterprise_project_id": "",
      "time_zone": "UTC+08:00",
      "ha": {
          "mode": "centralization_standard",
          "consistency": "strong",
          "replication_mode": "sync"
      },
      "replica_num": 3,
      "port": 8000,
      "enable_force_switch": true
  }

• 创建一个GaussDB实例，实例部署形态为主备版高可用（1主2备），包周期付费（1年），引擎版本为2.，三个不同可用区下，规格为8U64G。

  POST https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances
  {
      "name": "user1-v3-ha-02",
      "datastore": {
          "type": "GaussDB",
          "version": "2.7"
      },
      "flavor_ref": "gaussdb.opengauss.ee.km1.2xlarge.arm8.ha",
      "volume": {
          "type": "ULTRAHIGH",
          "size": 120
      },
      "disk_encryption_id": "24ae42b5-4009-4ea2-b66a-0b211e424dab",
      "region": "aaa",
      "availability_zone": "bbb,ccc,ddd", 
      "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
      "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
      "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
      "backup_strategy": {
          "start_time": "17:00-18:00",
          "keep_days": 7
      },
      "charge_info": {
          "charge_mode": "prePaid",
          "period_type": "year",
          "period_num": 1
      },
      "password": "xxxxxx",
      "configuration_id": "", 
      "enterprise_project_id": "",
      "time_zone": "UTC+08:00",
      "ha": {
          "mode": "centralization_standard",
          "consistency": "strong",
          "replication_mode": "sync"
      },
      "replica_num": 3,
      "port": 8000,
      "enable_force_switch": true
  }

响应示例

• 创建一个GaussDB分布式独立部署，按需付费，引擎版本为2.7，同一可用区下，3个协调节点，3个分片，3个副本，规格为8U64G的实例：

  {
   "instance": {
          "id": "ad8cd1440aa94a02ae4580fcbebb3143in14",
          "name": "user1-v3-independent-01",
          "status": "BUILD",
          "datastore": {
              "type": "GaussDB",
              "version": "2.7"
          },
          "ha": {
              "mode": "Enterprise",
              "replication_mode": "sync",
              "consistency": "strong"
              
          },
          "port": "8000",
          "volume": {
              "type": "ULTRAHIGH",
              "size": 120
          },
          "replica_num": 3,
          "region": "aaa",
          "backup_strategy": {
              "start_time": "17:00-18:00",
              "keep_days": 7
          },
          "enterprise_project_id": "0",
          "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
          "availability_zone": "bbb,bbb,bbb",
          "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
          "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
          "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
          "charge_info": {
              "charge_mode": "postPaid"
          }
      },
      "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af"
  }

• GaussDB分布式部署形态，包周期付费（1年），引擎版本为2.7，三个不同可用区下，3个协调节点，3个分片，3个副本，规格为8U64G的实例响应：

  {
      "instance": {
          "id": "ad8cd1440aa94a02ae4580fcbebb3143in14",
          "name": "user1-v3-independent-02",
          "datastore": {
              "type": "GaussDB",
              "version": "2.7"
          },
          "ha": {
              "mode": "Enterprise",
              "replication_mode": "sync",
              "consistency": "strong"
              
          },
          "port": "8000",
          "volume": {
              "type": "ULTRAHIGH",
              "size": 120
          },
          "replica_num": 3,
          "region": "aaa",
          "backup_strategy": {
              "start_time": "17:00-18:00",
              "keep_days": 7
          },
          "enterprise_project_id": "0",
          "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
          "availability_zone": "bbb,bbb,bbb",
          "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
          "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
          "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
          "charge_info": {
              "charge_mode": "prePaid",
              "period_type": "year",
              "period_num": 1,
              "is_auto_renew": false,
              "is_auto_pay": false
          }
      },
      "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af"
  }

• GaussDB主备版高可用（1主2备），按需付费，引擎版本为2.7，同一可用区下，规格为8U64G的实例响应：

  {
      "instance": {
          "id": "ad8cd1440aa94a02ae4580fcbebb3143in14",
          "name": "user1-v3-ha-01",
          "status": "BUILD",
          "datastore": {
              "type": "GaussDB",
              "version": "2.7"
          },
          "ha": {
              "mode": "Enterprise",
              "replication_mode": "sync",
              "consistency": "strong"
              
          },
          "port": "8000",
          "volume": {
              "type": "ULTRAHIGH",
              "size": 120
          },
          "region": "aaa",
          "replica_num": 3,
          "backup_strategy": {
              "start_time": "17:00-18:00",
              "keep_days": 7
          },
          "enterprise_project_id": "0",
          "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
          "availability_zone": "bbb,bbb,bbb",
          "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
          "charge_info": {
              "charge_mode": "postPaid"
          },
          "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
          "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f"
      },
      "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af"
  }

• GaussDB主备版高可用（1主2备），包周期付费（1年），引擎版本为2.7，三个不同可用区下，规格为8U64G的实例响应：

  {
      "instance": {
          "id": "ad8cd1440aa94a02ae4580fcbebb3143in14",
          "name": "user1-v3-ha-02",
          "datastore": {
              "type": "GaussDB",
              "version": "2.7"
          },
          "ha": {
              "mode": "Enterprise",
              "replication_mode": "sync",
              "consistency": "strong"
              
          },
          "port": "8000",
          "volume": {
              "type": "ULTRAHIGH",
              "size": 120
          },
          "replica_num": 3,
          "region": "aaa",
          "backup_strategy": {
              "start_time": "17:00-18:00",
              "keep_days": 7
          },
          "enterprise_project_id": "0",
          "flavor_ref": "gaussdb.opengauss.ee.dn.m6.2xlarge.8.in",
          "availability_zone": "bbb,bbb,bbb",
          "vpc_id": "1f011c32-2de2-4aa8-a161-9498dbcef329",
          "subnet_id": "54a44bec-e36f-441e-86bb-d749ace9c189",
          "security_group_id": "c6123999-8532-421c-9db6-e078013ff58f",
          "charge_info": {
              "charge_mode": "prePaid",
              "period_type": "year",
              "period_num": 1,
              "is_auto_renew": false,
              "is_auto_pay": false
          }
      },
      "job_id": "30f2790a-a5b6-4a13-a5ab-733c746609af"
  }

状态码

• 正常

  202

• 异常

  请参见状态码。

错误码

请参见错误码。