All Products
Search
Document Center

Security Center:DescribePropertySoftwareItem

Last Updated:Nov 25, 2024

Queries information about all software assets.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ForceFlushbooleanNo

Specifies whether to forcefully refresh the data that you want to query.

true
NamestringNo

The name of the software that you want to query.

test
CurrentPageintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

10

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

3A85CFCF-05C8-451A-9E41-C0D5E96BA407
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

2
TotalCountinteger

The total number of entries returned.

5037
Countinteger

The number of entries returned on the current page.

2
PropertyItemsarray<object>

An array that consists of the software assets returned.

PropertySoftwareItemobject
Namestring

The name of the software.

aaa_base
Countinteger

The number of servers on which the software is installed.

23

Examples

Sample success responses

JSONformat

{
  "RequestId": "3A85CFCF-05C8-451A-9E41-C0D5E96BA407",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 2,
    "TotalCount": 5037,
    "Count": 2
  },
  "PropertyItems": [
    {
      "Name": "aaa_base",
      "Count": 23
    }
  ]
}

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.