All Products
Search
Document Center

Security Center:DescribeBinarySecurityPolicies

Last Updated:Nov 14, 2024

Queries binary security policies.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
yundun-sas:DescribeBinarySecurityPoliciesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address.

59.82.XXX.XXX
NamestringNo

The name of the policy.

policy-auto-5patxz
StatusstringNo

The status of the policy. Valid values:

  • enabled
  • disabled
enabled
CurrentPageintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

20

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

1EE7B150-D67E-53FD-A52D-3E8E669A****
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

218
Countinteger

The number of entries returned on each page.

20
BinarySecurityPoliciesarray<object>

The information about security policies.

BinarySecurityPolicyobject
Statusstring

The status of the policy. Valid values:

  • enabled
  • disabled
enabled
Policystring

The content of the policy. The value is in the JSON format. A key supports the following values:

  • policyMode: the type of the policy. Default value: requireAttestor.
  • requiredAttestors: the required witnesses.
{\"PolicyMode\":\"requireAttestor\",\"RequiredAttestors\":[\"test-xcs-04-11-hhht\"]}
Namestring

The name of the policy.

logtail
Remarkstring

The description.

test
Clustersarray<object>

The information about clusters.

clusterobject
ClusterIdstring

The ID of the cluster.

c316702acdf5f45e1a9dc7fc52f21****
Namespacesarray

The namespaces.

Namespacestring

The namespace.

[\"insightone_x86\"]

Examples

Sample success responses

JSONformat

{
  "RequestId": "1EE7B150-D67E-53FD-A52D-3E8E669A****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 218,
    "Count": 20
  },
  "BinarySecurityPolicies": [
    {
      "Status": "enabled",
      "Policy": "{\\\"PolicyMode\\\":\\\"requireAttestor\\\",\\\"RequiredAttestors\\\":[\\\"test-xcs-04-11-hhht\\\"]}",
      "Name": "logtail",
      "Remark": "test",
      "Clusters": [
        {
          "ClusterId": "c316702acdf5f45e1a9dc7fc52f21****",
          "Namespaces": [
            "[\\\"insightone_x86\\\"]"
          ]
        }
      ]
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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