PrevNext
search by keyword

Recent Pages

Documentation
Serverless Cloud Function
    Documentation
    Download PDF

    ListNamespaces

    Last updated: 2021-09-10 17:17:10
    Download PDF

    1. API Description

    Domain name for API request: scf.tencentcloudapi.com.

    This API is used to display a namespace list.

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

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: scf.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: ListNamespaces.
    Version Yes String Common parameter. The value used for this API: 2018-04-16.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    Limit No Integer Return data length. The default value is 20.
    Offset No Integer Data offset. The default value is 0.
    Orderby No String It specifies the sorting order of the results according to a specified field, such as Name and Updatetime.
    Order No String It specifies whether to return the results in ascending or descending order. The value is ASC or DESC.
    SearchKey.N No Array of SearchKey Specifies the range and keyword for search. The value of Key can be Namespace or Description. Multiple AND conditions can be specified.

    3. Output Parameters

    Parameter Name Type Description
    Namespaces Array of Namespace Namespace details
    TotalCount Integer Number of return namespaces
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Displaying a namespace list

    Input Example

    https://scf.tencentcloudapi.com/?Action=ListNamespaces
&SearchKey.0.Key=Namespace
&SearchKey.0.Value=dev
&<Common request parameters>

    Output Example

    {
  "Response": {
    "TotalCount": 1,
    "RequestId": "xx",
    "Namespaces": [
      {
        "ModTime": "2020-09-22 00:00:00",
        "AddTime": "2020-09-22 00:00:00",
        "Type": "xx",
        "Description": "xx",
        "Name": "xx"
      }
    ]
  }
}

    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
    InvalidParameterValue.Filters Filters parameter error.
    InvalidParameterValue.Order Order error.
    InvalidParameterValue.Orderby Orderby error.
    InvalidParameterValue.SearchKey The searchkey is not Keyword, Tag, or Runtime.
    InvalidParameterValue.Stamp The value of Stamp does not meet the specification. Please fix it and try again.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy