All Products
Search
Document Center

:ListDataServiceApiAuthorities

最終更新日:May 10, 2024

Queries the APIs on which other users are granted the access permissions.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action

String

Yes

ListDataServiceApiAuthorities

The operation that you want to perform. Set the value to ListDataServiceApiAuthorities.

ProjectId

Long

Yes

10000

The workspace ID.

PageNumber

Integer

Yes

1

The page number. Pages start from page 1. Default value: 1.

PageSize

Integer

Yes

10

The number of entries per page. Valid values: 1 to 100. Default value: 10.

TenantId

Long

No

10001

The tenant ID. This parameter is deprecated.

ApiNameKeyword

String

No

My API name

The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.

Response parameters

Parameter

Type

Example

Description

HttpStatusCode

Integer

200

The HTTP status code.

RequestId

String

0000-ABCD-EFG****

The request ID.

ErrorMessage

String

Normal

The error message.

Success

Boolean

Boolean

Indicates whether the request was successful.

ErrorCode

String

0

The error code.

Data

Object

The APIs on which other users are granted the access permissions.

PageNumber

Integer

1

The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.

PageSize

Integer

10

The number of entries per page. Valid values: 1 to 100. Default value: 10.

TotalCount

Integer

100

The total number of entries returned.

ApiAuthorizationList

Array of ApiAuthorization

The data returned.

ApiStatus

Integer

0

The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.

ApiId

Long

10002

The API ID.

ModifiedTime

String

2020-06-23T00:21:01+0800

The time when the API was last modified.

GroupId

String

ab123

The group ID.

ProjectId

Long

10000

The workspace ID.

CreatorId

String

12345

The ID of the Alibaba Cloud account used by the API owner.

CreatedTime

String

2020-06-23T00:21:01+0800

The time when the API was created.

ApiName

String

My API name

The name of the API.

TenantId

Long

10001

The tenant ID.

ApiPath

String

/test/1

The path of the API.

AuthorizationRecords

Array of AuthorizationRecord

The authorization records.

EndTime

String

2020-06-24T00:21:01+0800

The end time of the validity period of the authorization.

CreatorId

String

12345

The ID of the Alibaba Cloud account used by the API owner.

CreatedTime

String

2020-06-23T00:21:01+0800

The time when the access permissions on the API were granted to other users.

ProjectId

Long

10004

The ID of the workspace to which the access permissions on the API are granted.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListDataServiceApiAuthorities
&ProjectId=10000
&PageNumber=1
&PageSize=10
&TenantId=10001
&ApiNameKeyword=My API name
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListDataServiceApiAuthoritiesResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>Normal</ErrorMessage>
    <Success>false</Success>
    <ErrorCode>0</ErrorCode>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <ApiAuthorizationList>
            <ApiStatus>0</ApiStatus>
            <ApiId>10002</ApiId>
            <ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime>
            <GroupId>ab123</GroupId>
            <ProjectId>10000</ProjectId>
            <CreatorId>12345</CreatorId>
            <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>
            <ApiName>My API name</ApiName>
            <TenantId>10001</TenantId>
            <ApiPath>/test/1</ApiPath>
            <AuthorizationRecords>
                <EndTime>2020-06-24T00:21:01+0800</EndTime>
                <CreatorId>12345</CreatorId>
                <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>
                <ProjectId>10004</ProjectId>
            </AuthorizationRecords>
        </ApiAuthorizationList>
    </Data>
</ListDataServiceApiAuthoritiesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "RequestId" : "0000-ABCD-EFG****",
  "ErrorMessage" : "Normal",
  "Success" : false,
  "ErrorCode" : 0,
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 100,
    "ApiAuthorizationList" : {
      "ApiStatus" : 0,
      "ApiId" : 10002,
      "ModifiedTime" : "2020-06-23T00:21:01+0800",
      "GroupId" : "ab123",
      "ProjectId" : 10000,
      "CreatorId" : 12345,
      "CreatedTime" : "2020-06-23T00:21:01+0800",
      "ApiName" : "My API name",
      "TenantId" : 10001,
      "ApiPath" : "/test/1",
      "AuthorizationRecords" : {
        "EndTime" : "2020-06-24T00:21:01+0800",
        "CreatorId" : 12345,
        "CreatedTime" : "2020-06-23T00:21:01+0800",
        "ProjectId" : 10004
      }
    }
  }
}

Error codes

HTTP status code

Error code

Error message

Description

429

Throttling.Api

The request for this resource has exceeded your available limit.

The number of requests for the resource has exceeded the upper limit.

429

Throttling.System

The DataWorks system is busy. Try again later.

The DataWorks system is busy. Try again later.

429

Throttling.User

Your request is too frequent. Try again later.

Excessive requests have been submitted within a short period of time. Try again later.

500

InternalError.System

An internal system error occurred. Try again later.

An internal error occurred. Try again later.

500

InternalError.UserId.Missing

An internal system error occurred. Try again later.

An internal error occurred. Try again later.

For a list of error codes, see Service error codes.