GetDocumentList

​

Operation description

• You have activated Alibaba Cloud Model Studio and the Tongyi Gold Point service.
• You have obtained a workspace ID. For more information, see Get a workspace ID.

​

Try it now

​

RAM authorization

• Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
• API: The API that you can call to perform the action.
• Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
• Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
  • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
  • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
• Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
• Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

​

Request syntax

GET /{workspaceId}/api/library/listDocument HTTP/1.1

​

Path Parameters

​

Request parameters

​

Response elements

​

Examples

{
  "cost": 0,
  "data": {
    "currentPage": 1,
    "pageSize": 10,
    "records": [
      {
        "docId": "8326748346",
        "documentMeta": {
          "test": "test",
          "test2": 1
        },
        "fileType": "pdf",
        "gmtCreate": "2024-01-01 00:00:00",
        "gmtModified": "2024-01-01 00:00:00",
        "libraryId": "skjdhshbv",
        "statusCode": "WaitRefresh",
        "title": "test",
        "url": "null"
      }
    ],
    "totalPages": 10,
    "totalRecords": 100
  },
  "dataType": "null",
  "errCode": "0",
  "message": "ok",
  "requestId": "5E3FBAF1-17AF-53B7-AF0A-CDCEEB6DE658",
  "success": true,
  "time": "2024-04-24 11:54:34"
}

​

Error codes

​

Release notes