All Products
Search

This Product

    :CreateRdsExternalStore

    Document Center

    :CreateRdsExternalStore

    Last Updated:Apr 25, 2024

    Creates an ApsaraDB RDS external store.

    Operation description

    Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request syntax

    POST /externalstores

    Request parameters

    ParameterTypeRequiredDescriptionExample
    projectstringYes

    The name of the project.

    		ali-test-project
    bodyobjectYes

    The request body.

    externalStoreNamestringYes

    The name of the external store. The name must be unique in a project and must be different from Logstore names.

    		rds_store
    storeTypestringYes

    The storage type. Set the value to rds-vpc, which indicates an ApsaraDB RDS for MySQL database in a virtual private cloud (VPC).

    		rds-vpc
    parameterobjectYes

    The parameter struct.

    vpc-idstringNo

    The ID of the VPC to which the ApsaraDB RDS for MySQL instance belongs.

    		vpc-bp1aevy8sofi8mh1q****
    instance-idstringNo

    The ID of the ApsaraDB RDS for MySQL instance.

    		i-bp1b6c719dfa08exf****
    hoststringNo

    The internal or public endpoint of the ApsaraDB RDS for MySQL instance.

    		192.168.XX.XX
    portstringYes

    The internal or public port of the ApsaraDB RDS for MySQL instance.

    		3306
    usernamestringYes

    The username that is used to log on to the ApsaraDB RDS for MySQL instance.

    		root
    passwordstringYes

    The password that is used to log on to the ApsaraDB RDS for MySQL instance.

    		sfdsfldsfksfls****
    dbstringYes

    The name of the database in the ApsaraDB RDS for MySQL instance.

    		meta
    tablestringYes

    The name of the database table in the ApsaraDB RDS for MySQL instance.

    		join_meta
    regionstringYes

    The region where the ApsaraDB RDS for MySQL instance resides. Valid values: cn-qingdao, cn-beijing, and cn-hangzhou.

    		cn-qingdao

    Response parameters

    ParameterTypeDescriptionExample
    headersobject
    Serverstring

    The name of the server.

    		nginx
    Content-Typestring

    The content type of the response body.

    		application/json
    Content-Lengthstring

    The content length of the response body.

    		0
    Connectionstring

    Indicates whether the connection is persistent. Valid values:

    • close: The connection is non-persistent. A new TCP connection is established for each HTTP request.
    • keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.
    		close
    Datestring

    The time when the response was returned.

    		Sun, 27 May 2018 08:25:04 GMT
    x-log-requestidstring

    The request ID.

    		5B0A6B60BB6EE39764D458B5

    Examples

    Sample success responses

    JSONformat

    {}

    Error codes

    For a list of error codes, visit the Service error codes.