All Products
Search
Document Center

Container Service for Kubernetes:DescribePolicyDetails

Last Updated:Feb 29, 2024

You can call the DescribePolicyDetails operation to query information about a policy.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DescribePolicyDetailsRead
  • All Resources
    *
    none
none

Request syntax

GET /policies/{policy_name}

Request parameters

ParameterTypeRequiredDescriptionExample
policy_namestringYes

The name of the policy.

ACKAllowedRepos

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

namestring

The name of the policy.

ACKAllowedRepos
categorystring

The type of the policy.

k8s-general
descriptionstring

The description of the policy.

Requires container images to begin with a repo string from a specified list
actionstring

The action of the policy. Valid values:

  • enforce: blocks deployments that match the policy.
  • inform: generates alerts for deployments that match the policy.
enforce
severitystring

The severity level of the policy.

high
templatestring

The content of the policy.

For more information, see sample requests.
no_configinteger

Indicates whether parameters are required. Valid values:

  • 0: Parameters are required.
  • 1: Parameters are optional.
0
is_deletedinteger

Indicates whether the policy is deleted. Valid values:

  • 0: The policy is not deleted.
  • 1: The policy is deleted.
0

Examples

Sample success responses

JSONformat

{
  "name": "ACKAllowedRepos",
  "category": "k8s-general",
  "description": "Requires container images to begin with a repo string from a specified list",
  "action": "enforce",
  "severity": "high",
  "template": "For more information, see sample requests.",
  "no_config": 0,
  "is_deleted": 0
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history