All Products
Search
Document Center

Security Center:DescribeAttestors

Last Updated:Nov 14, 2024

Queries a list of witnesses.

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:DescribeAttestorsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address.

222.35.XXX.XXX
NamestringNo

The name of the witness.

attestor-auto-ad5316
CurrentPageintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

20

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

7BC55C8F-226E-5AF5-9A2C-2EC43864****
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

122
Countinteger

The number of entries returned on the current page.

20
Attestorsarray<object>

The witnesses.

Attestorobject

The data returned.

KeyVersionIdstring

The version ID of the Key Management Service (KMS) key.

8d7c9c91-57ce-4cf4-a959-1e700e13****
KeyIdstring

The ID of the KMS key.

2e81355b-f8e7-4090-8082-a8f8124a****
Remarkstring

The description.

attestor
Namestring

The name of the witness.

attestor-123
KeyRegionIdstring

The region ID of the KMS key.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "7BC55C8F-226E-5AF5-9A2C-2EC43864****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 122,
    "Count": 20
  },
  "Attestors": [
    {
      "KeyVersionId": "8d7c9c91-57ce-4cf4-a959-1e700e13****",
      "KeyId": "2e81355b-f8e7-4090-8082-a8f8124a****",
      "Remark": "attestor",
      "Name": "attestor-123",
      "KeyRegionId": "cn-hangzhou"
    }
  ]
}

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.