tencent cloud

All product documents
Tencent Cloud Organization
DocumentationTencent Cloud OrganizationAPI DocumentationResource Sharing APIsDescribeShareUnits
DescribeShareUnits
Download PDF
Last updated: 2025-02-26 11:52:09
DescribeShareUnits
Last updated: 2025-02-26 11:52:09
Download PDF

1. API Description

Domain name for API request: organization.intl.tencentcloudapi.com.

This API is used to obtain a list of shared units.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeShareUnits.
Version Yes String Common Params. The value used for this API: 2021-03-31.
Region No String Common Params. This parameter is not required for this API.
Area Yes String Shared unit region. You can obtain supported shared regions through the API DescribeShareAreas.
Offset Yes Integer Offset. Its value must be an integer multiple of the limit. Default value: 0.
Limit Yes Integer Limit. Value range: 1–50.
SearchKey No String Search keyword. UnitId and Name search is supported.

3. Output Parameters

Parameter Name Type Description
Total Integer Total number.
Items Array of ManagerShareUnit Shared unit list.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Obtaining a List of Shared Units

Input Example

https://organization.intl.tencentcloudapi.com/?Action=DescribeShareUnits
&Area=ap-guangzhou
&Offset=0
&Limit=10
&<Common request parameters>

Output Example

{
    "Response": {
        "Items": [
            {
                "Area": "ap-guangzhou",
                "CreateTime": "2021-03-05 15:29:14",
                "Description": "share unit",
                "Name": "myShareUnit",
                "OwnerUin": 1111111111,
                "ShareMemberNum": 0,
                "ShareResourceNum": 0,
                "Uin": 2222222222,
                "UnitId": "shareUnit-xhre**ra2p"
            }
        ],
        "RequestId": "7e6a64bc-6522-4c33-b3c3-303570691d7b",
        "Total": 1
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation Operation failed.
InternalError An internal error occurred.
InvalidParameter The parameter is incorrect.
OperationDenied Operation denied.
ResourceNotFound The resource does not exist.
ResourceUnavailable Resources are unavailable.
UnsupportedOperation The operation is not supported.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support