tencent cloud

Feedback

DescribeAssetImageRegistryRegistryDetail

Last updated: 2024-12-06 15:48:35

    1. API Description

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

    This API is used to view the details of an image repository.

    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: DescribeAssetImageRegistryRegistryDetail.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.
    RegistryId Yes Integer Unique repository ID

    3. Output Parameters

    Parameter Name Type Description
    Name String Repository name
    Username String Username
    Password String Password
    Url String Repository URL
    RegistryType String Repository type, which can be harbor.
    RegistryVersion String Repository version
    Note: This field may return null, indicating that no valid values can be obtained.
    NetType String Network type, which can be public (public network).
    RegistryRegion String Region. Default value: default.
    Note: This field may return null, indicating that no valid values can be obtained.
    SpeedLimit Integer Speed limit
    Note: This field may return null, indicating that no valid values can be obtained.
    Insecure Integer Valid values: 0 (secure mode with certificate verification, which is the default value); 1 (unsecure mode that skips certificate verification).
    Note: This field may return null, indicating that no valid values can be obtained.
    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 正常的获取

    正常的获取

    Input Example

    POST / HTTP/1.1
    Host: tcss.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeAssetImageRegistryRegistryDetail
    <common request parameters>
    
    {
        "RegistryId": 8329
    }
    

    Output Example

    {
        "Response": {
            "Insecure": 1,
            "Name": "jfrog****",
            "NetType": "public",
            "Password": "Aa8888****",
            "RegistryRegion": "ap-beijing",
            "RegistryType": "harbor",
            "RegistryVersion": "v1",
            "RequestId": "ff82bfdb-f923-4b66-8c70-cba784e8be67",
            "SpeedLimit": 1000,
            "Url": "http://good.com.cn",
            "Username": "test-user-name"
        }
    }
    

    Example2 镜像仓库详情

    镜像仓库详情

    Input Example

    POST / HTTP/1.1
    Host: tcss.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeAssetImageRegistryRegistryDetail
    <common request parameters>
    
    {
        "RegistryId": "10"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5187d432-1753-4376-81b6-12e1f7e6ecf5",
            "Name": "jfrog****",
            "Username": "test-user",
            "Password": "test-passwd",
            "Url": "https://127.0.0.1:8080",
            "RegistryType": "harbor",
            "RegistryVersion": "v2",
            "NetType": "public",
            "RegistryRegion": "default",
            "SpeedLimit": 1,
            "Insecure": 0
        }
    }
    

    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
    AuthFailure A CAM signature/authentication error occurred.
    FailedOperation The operation failed.
    FailedOperation.DataValueNotCorrect The response data value is incorrect.
    InternalError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.InvalidFormat The parameter format is incorrect.
    InvalidParameter.MissingParameter The required parameter is missing.
    InvalidParameterValue The parameter value is incorrect.
    ResourceNotFound The resource does not exist.