全部產品
Search
文件中心

:GetExternalStore

更新時間:Jun 30, 2024

調用GetExternalStore介面擷取指定外部儲存資料的詳細資料。

介面說明

目前支援OSS資料來源和VPC下的RDS MySQL資料庫作為外部儲存資料。本文以RDS MySQL為例,OSS資料來源作為外部儲存資料時其參數配置請參見關聯OSS資料來源

請求文法

GET /externalstores/externalStoreName 
Content-Length: 0 
x-log-bodyrawsize: 0 
x-log-apiversion: 0.6.0 
x-log-signaturemethod: hmac-sha1
Host: ProjectName.Endpoint
Date: GMT Date
Authorization: LOG yourAccessKeyId:yourSignature

其中,Host由Project名稱和Log ServiceEndpoint構成,您需要在Host中指定Project。

請求參數

  • 要求標頭

    GetExternalStore介面無特有要求標頭,關於Log Service API的公用要求標頭請參見公用要求標頭

  • 參數列表
    參數名稱資料類型是否必填樣本值描述
    projectNameStringali-test-projectProject名稱。
    externalStoreNameStringrds_store外部儲存名稱。

返回資料

  • 回應標頭

    GetExternalStore介面無特有回應標頭。關於Log Service API的公用回應標頭,請參見公用回應標頭

  • 響應元素
    返回HTTP狀態代碼200,則表示請求成功。響應Body中包含該Project下指定外部儲存詳細資料,具體如下:
    參數名稱資料類型樣本值描述
    storeTypeStringrds-vpc儲存類型。固定取值為rds-vpc,表示VPC下的RDS MySQL資料庫。
    vpc-idStringvpc-bp1aevy8sofi8mh1q****RDS MySQL執行個體所屬的VPC ID。
    instance-idStringi-bp1b6c719dfa08exf****RDS MySQL的執行個體ID。
    hostString192.***.***.***RDS MySQL執行個體的內網地址或外網地址。
    portString3306RDS MySQL執行個體的內網或者外網連接埠。
    usernameStringuserRDS MySQL執行個體中建立的帳號名稱。
    dbStringmetaRDS MySQL執行個體的資料庫名稱。
    tableStringjoin_metaRDS MySQL執行個體的資料庫表名稱。
    regionStringcn-qingdaoRDS MySQL執行個體所在地區,目前僅支援cn-qingdao、cn-beijing、cn-hangzhou。

樣本

  • 請求樣本
    GET /externalstores/rds_store
    Header :
    {
    Content-Length: 0 
    x-log-bodyrawsize: 0
    x-log-apiversion: 0.6.0
    x-log-signaturemethod: hmac-sha1
    Host: ali-test-project.cn-chengdu.log.aliyuncs.com 
    Date: Thu, 19 Apr 2018 03:26:49 GMT
    Authorization: LOG yourAccessKeyId:yourSignature
    }
  • 正常返回樣本
    HTTP/1.1 200 OK
    Header :
    {   
    content-length: 730
    server: nginx/1.6.1
    connection: close
    date: Mon, 09 Nov 2015 08:29:15 GMT
    content-type: application/json
    x-log-requestid: 5640595B99248CAA23004A59
    }
    Body :
    {
      'storeType': 'rds-vpc', 
      'parameter': {
                   'region': 'cn-qingdao', 
                   'vpc-id': 'vpc-p1aevy8sofi8mh1q****', 
                   'instance-id': 'i-bp1b6c719dfa08exf****', 
                   'host': '192.168.XX.XX', 
                   'port': '3306', 
                   'username': 'user', 
                   'db': 'meta', 
                   'table': 'join_meta'
                   }
    }

錯誤碼

HTTP狀態代碼錯誤碼錯誤資訊描述
404ProjectNotExistThe Project does not exist : projectNameProject不存在。
404LogStoreNotExistLogstore externalStoreName does not exist外部儲存不存在。
500InternalServerErrorSpecified Server Error Message.內部服務調用錯誤。

更多錯誤碼,請參見錯誤碼