OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

Product Overview
DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

Product Overview
DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Cloud Platform

V4.3.1

    Download PDF

    OceanBase logo

    The Unified Distributed Database for the AI Era.

    Follow Us
    Products
    OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
    Resources
    DocsBlogLive DemosTraining & CertificationTicket
    Company
    About OceanBaseTrust CenterLegalPartnerContact Us
    Follow Us

    © OceanBase 2026. All rights reserved

    Cloud Service AgreementPrivacy PolicySecurity
    Contact Us
    Document Feedback
    1. Documentation Center
    2. OceanBase Cloud Platform
    3. V4.3.1
    iconOceanBase Cloud Platform
    V 4.3.1
    • V 4.3.6
    • V 4.3.5
    • V 4.3.4
    • V 4.3.3
    • V 4.3.2
    • V 4.3.1
    • V 4.3.0
    • V 4.2.2
    • V 4.0.0 and earlier

    Add IDC information

    Last Updated:2026-04-14 07:46:02  Updated
    share
    What is on this page
    Description
    Call description
    Prerequisite
    Request path
    Request parameters
    Response parameters
    Examples
    Sample request
    Sample response

    folded

    share

    Description

    You can call this operation to add IDC information.

    Call description

    Prerequisite

    You have the HOST_MANAGER permissions.

    Request path

    POST /api/v2/compute/idcs

    Request parameters

    Parameter
    Type
    Required
    Example value
    Description
    name String Yes idc-bj The name of the IDC.
    description String No The Beijing IDC. The description of the IDC.
    regionId Long Yes 100 The ID of the region.

    Response parameters

    Parameter
    Type
    Description
    data Object The requested IDC data.
    successful Boolean Indicates whether the request was successful.
    timestamp Datetime The timestamp when the server completed the request.
    duration Integer The time taken by the server to process the request, in milliseconds.
    status Integer An HTTP status code.
    traceId String The trace ID of the request. This trace ID is used for troubleshooting.
    server String The address of the application server that responded to the request.

    Data structure of the IDC information

    Parameter
    Type
    Description
    id Integer The ID of the region.
    name String The name of the region.
    description String The description of the region.
    regionId Integer The ID of the region associated with the IDC.
    regionName String The name of the region associated with the IDC.
    createTime String The time when the IDC was created.
    updateTime String The time when the IDC was modified.

    Examples

    Sample request

    POST /api/v2/compute/idcs

    curl --user <username>:<password> -X POST 'http://<IP>:<PORT>/api/v2/compute/idcs' \
    -H 'Content-Type: application/json' \
    --data-raw '{"name":"idc-bj","description":"The Beijing IDC.","regionId":100}'
    

    Sample response

    {
      "data": {
        "createTime": "2021-07-22T20:04:15+08:00",
        "description": null,
        "id": 1000002,
        "name": "test-idc",
        "regionId": 1000002,
        "regionName": "testregion",
        "updateTime": "2021-07-22T20:04:15+08:00"
      },
      "duration": 41,
      "server": "a83ad33525",
      "status": 200,
      "successful": true,
      "timestamp": "2021-08-25T16:00:19.895+08:00",
      "traceId": "c8e610e3b33a4b17"
    }
    

    Previous topic

    Query details about an IDC
    Last

    Next topic

    Delete an IDC
    Next
    What is on this page
    Description
    Call description
    Prerequisite
    Request path
    Request parameters
    Response parameters
    Examples
    Sample request
    Sample response