ListK8sSecrets - Enterprise Distributed Application Service

Queries Kubernetes Secrets.

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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
edas:ReadCluster	get	All Resources ``	none	none

Request syntax

GET /pop/v5/k8s/acs/k8s_secret HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The ID of the cluster.	7a953f9a-2946-4c7a-9d82-9939db******
Namespace	string	No	The namespace of the Kubernetes cluster.	default
RegionId	string	No	The ID of the region.	cn-hangzhou
PageNo	integer	No	The number of the page to return. Pages start from Page 0.	0
PageSize	integer	No	The number of entries to return on each page. The value 0 indicates that all entries are returned on one page.	10
Condition	string	No	The filter conditions. Set this parameter to a JSON string in the format of {"field":"Name", "pattern":"configmap-"}.	{\"field\":\"Name\",\"pattern\":\"product\"}
ShowRelatedApps	boolean	No	Specifies whether to return a list of applications that use a Secret.	true

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The HTTP status code that is returned.	200
Message	string	The additional information that is returned.	success
RequestId	string	The ID of the request.	b197-40ab-9155-****
Result	object	The returned query results of Kubernetes Secrets.
Total	integer	The total number of entries that are returned.	6
Secrets	array<object>	The information about Kubernetes Secrets.
Secrets	object
Type	string	The type of the Secret. Valid values: Opaque: user-defined data kubernetes.io/tls: Transport Layer Security (TLS) certificate	Opaque
CreationTime	string	The time when the Secret was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.	2022-05-26T02:57:02Z
ClusterName	string	The name of the cluster.	test-cluster
Namespace	string	The namespace of the Kubernetes cluster.	default
Base64Encoded	boolean	Indicates whether the data is Base64-encoded. Valid values: true: The data is Base64-encoded. false: The data is not Base64-encoded.	false
CertRegionId	string	The region in which the certificate is stored.	cn-hangzhou
CertId	string	The ID of the certificate provided by Alibaba Cloud Certificate Management Service.	123456
Name	string	The name of the Secret. The name must start with a letter, and can contain digits, letters, and hyphens (-). It can be up to 63 characters in length.	my-secret
ClusterId	string	The ID of the cluster in Enterprise Distributed Application Service (EDAS).	4472a6d3-f01d-4087-85a7-3dc52********
RelatedIngressRules	array<object>	Rules in the Ingress that is associated with the Secret.
RelatedIngressRules	object
Name	string	The name of the rule in the Ingress.	testrulename
Namespace	string	The namespaces of the Kubernetes cluster.	default
RelatedApps	array<object>	Aplications that are associated with the Ingress.
RelatedApps	object
AppName	string	The name of the EDAS application.	app-test
AppId	string	The ID of the application.	6dc74432-5a35-4e68-8aaa-3700********
Data	array<object>	The data of the Kubernetes Secret.
Data	object
Key	string	The user-defined key of the Kubernetes Secret.	name
Value	string	The user-defined value of the Kubernetes Secret.	william
RelatedApps	array<object>	Applications that use the Secret.
RelatedApps	object
AppName	string	The name of the application.	my-app
AppId	string	The ID of the application.	b08eeb18-8946-410c-a1ea-dbbc********
CertDetail	object	The details of the Secure Sockets Layer (SSL) certificate.
EndTime	string	The time when the SSL certificate expired.	2022-02-22T02:32:41Z
Status	string	The state of the SSL certificate. Valid values: normal: The SSL certificate is valid. invalid: The SSL certificate is invalid. expired: The SSL certificate has expired. not_yet_valid: The SSL certificate is currently invalid. about_to_expire: The SSL certificate is about to expire.	normal
StartTime	string	The time when the SSL certificate started to take effect.	2022-01-02T22:40:00Z
Issuer	string	The certificate authority (CA) that issued the SSL certificate.	CN=GlobalSign Root CA, OU=Root CA, O=GlobalSign nv-sa, C=BE
DomainNames	array	Domain names that are associated with the SSL certificate.
DomainNames	string	The domain name.	example.com

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "success",
  "RequestId": "b197-40ab-9155-****",
  "Result": {
    "Total": 6,
    "Secrets": [
      {
        "Type": "Opaque",
        "CreationTime": "2022-05-26T02:57:02Z",
        "ClusterName": "test-cluster",
        "Namespace": "default",
        "Base64Encoded": false,
        "CertRegionId": "cn-hangzhou",
        "CertId": 123456,
        "Name": "my-secret",
        "ClusterId": "4472a6d3-f01d-4087-85a7-3dc52********",
        "RelatedIngressRules": [
          {
            "Name": "testrulename",
            "Namespace": "default",
            "RelatedApps": [
              {
                "AppName": "app-test",
                "AppId": "6dc74432-5a35-4e68-8aaa-3700********"
              }
            ]
          }
        ],
        "Data": [
          {
            "Key": "name",
            "Value": "william"
          }
        ],
        "RelatedApps": [
          {
            "AppName": "my-app",
            "AppId": "b08eeb18-8946-410c-a1ea-dbbc********"
          }
        ],
        "CertDetail": {
          "EndTime": "2022-02-22T02:32:41Z",
          "Status": "normal",
          "StartTime": "2022-01-02T22:40:00Z",
          "Issuer": "CN=GlobalSign Root CA, OU=Root CA, O=GlobalSign nv-sa, C=BE",
          "DomainNames": [
            "example.com"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	Edas.errorcode.PermissionDenied.message	You are not authorized to perform the operation.	No permissions

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

Change history

Change time	Summary of changes	Operation
2021-09-14	The Error code has changed. The response structure of the API has changed	View Change Details