全部產品
Search

搜尋本產品

    AnalyticDB：DescribeCreateIndexJob - 擷取建立索引任務

    文件中心

    AnalyticDB：DescribeCreateIndexJob - 擷取建立索引任務

    更新時間：Mar 21, 2026

    擷取建立索引任務

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    gpdb:DescribeCreateIndexJob

    get

    *Collection

    acs:gpdb:{#regionId}:{#accountId}:collection/{#DBInstanceId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    地區 ID。

    說明

    您可以調用 DescribeRegions 介面查看可用的地區 ID。

    cn-hangzhou
    DBInstanceId

    string

    否

    執行個體 ID。

    說明

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

    gp-xxxxxxxxx
    WorkspaceId

    string

    否

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

    gp-ws-*****
    Namespace

    string

    是

    命名空間。

    說明

    您可以通過 ListNamespaces 介面查看列表。

    mynamespace
    NamespacePassword

    string

    是

    命名空間對應的密碼。

    說明

    本值為 CreateNamespace 介面指定。

    testpassword
    Collection

    string

    是

    集合名。

    說明

    您可以通過 ListCollections 介面查看列表。

    testcollection

    JobId

    string

    是

    建立索引的任務 ID，由CreateIndex介面獲得。

    231460f8-75dc-405e-a669-0c5204887e91

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

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

    string

    介面返回詳細資料。

    success
    Status

    string

    API 執行狀態，取值如下：

    • success：執行成功。

    • fail：執行失敗。

    success
    Job

    object

    建立索引的任務的詳細資料。

    Id

    string

    Job ID。

    231460f8-75dc-405e-a669-0c5204887e91
    Completed

    boolean

    操作是否完成。

    false
    CreateTime

    string

    任務建立時間。

    2024-01-08 16:52:04.864664
    UpdateTime

    string

    任務更新時間。

    2024-01-08 16:53:04.864664
    Status

    string

    任務狀態。取值說明：

    • Success：成功。

    • Failed：失敗，失敗原因可查看 Error 欄位。

    • Cancelled：已取消。

    • Running：執行中。

    Running
    Error

    string

    當前操作異常或者失敗時的錯誤資訊。

    Failed to connect database.
    Progress

    integer

    建立進度，此數值為進度百分比，值為 100 時表示完成。

    說明

    • 僅 AnalyticDB PostgreSQL 7.0 版執行個體支援進度更新。

    20

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "Job": {
    "Id": "231460f8-75dc-405e-a669-0c5204887e91",
    "Completed": false,
    "CreateTime": "2024-01-08 16:52:04.864664",
    "UpdateTime": "2024-01-08 16:53:04.864664",
    "Status": "Running",
    "Error": "Failed to connect database.",
    "Progress": 20
  }
}

    錯誤碼

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

    變更歷史

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