調用該接口獲取項目列表。

限制說明

單阿里云賬號調用該接口的每秒請求數（QPS）最大限制為5。

說明 RAM用戶共享阿里云賬號配額。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 QueryStudioProjectList

系統規定參數。取值：QueryStudioProjectList。
Name String 否 test1

項目名稱。

  • 支持中文、英文字母、數字、下劃線（_）、短劃線（-）、英文圓括號（()）。
  • 必須以中文、英文字母或數字開頭。
  • 長度不超過30個字符（一個中文算一個字符）。
PageNo Integer 否 1

指定從返回結果中的第幾頁開始顯示。默認為1。
PageSize Integer 否 20

返回結果中每頁顯示的條數。最小值1，最大值50，默認值20。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

實例ID。

您可在物聯網平臺控制臺的實例概覽頁面，查看當前實例的ID。若有ID值，必須傳入該ID值，否則調用會失敗。

說明 如果公共實例沒有ID值，請參見如何獲取實例ID。

調用API時，除了本文介紹的該API的特有請求參數，還需傳入公共請求參數。公共請求參數說明，請參見公共參數文檔。

返回數據

名稱 類型 示例值 描述
Code String iot.system.SystemException

調用失敗時，返回的錯誤碼。錯誤碼詳情，請參見錯誤碼。

Data Struct

項目列表詳情。
List Array of ProjectInfo

項目列表。
ProjectInfo
Description String This is a test project.

項目描述。
GmtCreate Long 1611819839000

項目的創建時間。毫秒值時間戳。
GmtModified Long 1611819860000

項目的修改時間。毫秒值時間戳。
Name String test1

項目名稱。
ProjectId String a123********

項目ID。
PageNo Integer 1

指定從返回結果中的第幾頁開始顯示。
PageSize Integer 20

每頁顯示的條數。
Total Integer 200

項目總數。
TotalPage Integer 10

分頁總數。
ErrorMessage String 系統異常

調用失敗時，返回的出錯信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云為該請求生成的唯一標識符。
Success Boolean true

表示是否調用成功。

  • true：調用成功。
  • false：調用失敗。

示例

請求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryStudioProjectList
&<公共請求參數>

正常返回示例

XML格式 

<QueryStudioProjectListResponse>
      <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
      <Data>
            <TotalPage>10</TotalPage>
            <PageSize>20</PageSize>
            <Total>200</Total>
            <PageNo>1</PageNo>
            <List>
                  <ProjectInfo>
                        <GmtCreate>1611819839000</GmtCreate>
                        <Description>This is a test project.</Description>
                        <ProjectId>a123********</ProjectId>
                        <GmtModified>1611819860000</GmtModified>
                        <Name>test1</Name>
                  </ProjectInfo>
            </List>
      </Data>
      <Success>true</Success>
</QueryStudioProjectListResponse>

JSON格式 

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "TotalPage": 10,
        "PageSize": 20,
        "Total": 200,
        "PageNo": 1,
        "List": {
            "ProjectInfo": [
                {
                        "GmtCreate": 1611819839000,
                        "Description": "This is a test project.",
                        "ProjectId": "a123********",
                        "GmtModified": 1611819860000,
                        "Name": "test1"
                }
            ]
        }
    },
    "Success": true
}