DescribeImmutableTagRules

Last updated: 2021-10-14 16:42:20

1. API Description

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

This API is used to list the tag immutability rule.

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 parameter. The value used for this API: DescribeImmutableTagRules.
Version Yes String Common parameter. The value used for this API: 2019-09-24.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
RegistryId Yes String Instance ID

3. Output Parameters

Parameter Name Type Description
Rules Array of ImmutableTagRule Rule list
Note: this field may return null, indicating that no valid value can be obtained.
EmptyNs Array of String Namespace with no rules created
Note: this field may return null, indicating that no valid value can be obtained.
Total Integer Total rules
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Listing a rule

Input Example

POST / HTTP/1.1
Host: tcr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeImmutableTagRules
<Common request parameters>

{
    "RegistryId": "tcr-mfoeec7x"
}

Output Example

{
  "Response": {
    "Rules": [
      {
        "TagDecoration": "matches",
        "RuleId": 19,
        "Disabled": false,
        "RepositoryDecoration": "repoMatches",
        "RepositoryPattern": "**",
        "TagPattern": "**",
        "NsName": "kofj"
      }
    ],
    "EmptyNs": [
      "library"
    ],
    "Total": 3,
    "RequestId": "17eacd5a-b943-4e39-8a7a-3fb7b171c995"
  }
}

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 CAM signature/authentication error
FailedOperation Operation failed
InternalError Internal error. Please check and try again.
InternalError.ErrorTcrUnauthorized No permission for TCR operation.
InternalError.Unknown Unknown error.
InvalidParameter Parameter error. Please check and try again.
ResourceNotFound.TcrResourceNotFound The resource of the TCR instance was not found.