All Products
Search
Document Center

:ListExternalStore

Last Updated:Apr 25, 2024

Queries a list of external stores.

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

GET /externalstores

Request parameters

ParameterTypeRequiredDescriptionExample
projectstringYes

The name of the project.

ali-test-project
offsetintegerNo

The line from which the query starts. Default value: 0.

0
sizsintegerNo

The number of entries per page. Maximum value: 500.

10
externalStoreNamestringNo

The name of the external store. You can query external stores that contain a specified string.

store

Response parameters

ParameterTypeDescriptionExample
headersobject
Serverstring

The name of the server.

nginx
Content-Typestring

The content type of the response body. Valid values: application/json and application/x-protobuf.

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
object
countinteger

The number of external stores returned on the current page.

3
totalinteger

The number of external stores that meet the query conditions.

3
externalstoresarray

The names of the external stores.

externalStore

The name of the external store.

["ecs_store", "rds_store", "ecs_store1"]

Examples

Sample success responses

JSONformat

{
  "count": 3,
  "total": 3,
  "externalstores": [
    {
      "externalStoreName": "rds_store",
      "storeType": "rds-vpc",
      "parameter": {
        "vpc-id": "vpc-bp1aevy8sofi8mh1q****",
        "instance-id": "i-bp1b6c719dfa08exf****",
        "host": "192.168.XX.XX",
        "port": "3306",
        "username": "root",
        "password": "sfdsfldsfksfls****",
        "db": "meta",
        "table": "join_meta",
        "region": "cn-qingdao"
      }
    }
  ]
}

Error codes

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