全部產品
Search

搜尋本產品

    AnalyticDB：CreateSecret - 建立訪問憑證

    文件中心

    AnalyticDB：CreateSecret - 建立訪問憑證

    更新時間：Mar 21, 2026

    通過使用者名稱密碼建立訪問執行個體的憑證。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    gpdb:CreateSecret

    create

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    否

    執行個體 ID。

    說明

    您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 版執行個體的詳情，包括執行個體 ID。

    gp-xxxxxxxxx
    WorkspaceId

    string

    否

    多資料庫執行個體組成的 Workspace 的 Id。此參數和 DBInstanceId 參數不能同時為空白，當和 DBInstanceId 同時指定時以此參數為準。

    gp-ws-*****
    RegionId

    string

    是

    執行個體所在地區 ID。

    cn-beijing
    Username

    string

    是

    資料庫訪問使用者名稱。

    說明

    限制：

    • 由小寫字母，數字，底線組成，並且以小寫字母開頭。

    • 長度不能超過 64 個字元。

    testacc
    Password

    string

    是

    資料庫訪問密碼。

    pwd123
    Description

    string

    否

    憑據的描述資訊。長度不能超過 255 個字元。

    test
    SecretName

    string

    否

    憑據名稱。由字母、數字和底線組成，長度為 1-16 個字元。為空白時則使用 Username 參數作為 SecretName。

    testsecret
    TestConnection

    boolean

    否

    是否通過使用者名稱和密碼檢測執行個體連結是否正常。

    true

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    ABB39CC3-4488-4857-905D-2E4A051D0521
    Message

    string

    介面返回詳細資料。

    Successful
    Status

    string

    狀態，取值如下：

    • success：成功。

    • fail：失敗。

    success
    SecretArn

    string

    唯一指定使用者建立的 Data API 帳號的登入憑證及許可權。 格式如下：acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}。

    acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ
    SecretName

    string

    憑證的名稱。

    testsecret

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "success",
  "SecretArn": "acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ",
  "SecretName": "testsecret"
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。